Giter Club home page Giter Club logo

prosecode's Introduction

Prose Code

Literate programming in Python from markdown to LaTeX

The prosecode library is being developed as a way to generate really neat LaTeX from markdown files. It will support both tangling and weaving code. That is, it can run the code from the markdown files and it can also extract the code into separate .py files.

It is assumed that the markdown file uses github style fenced code blocks with extra data as is used in the Markdown-Preview-Enhanced plugin for Atom and VSCode.

Installation (coming soon)

pip install prosecode

Tangling

The following will extract the python code from myfile.md and store it in files.

$ prosecode tangle myfile.md

There is an optional --srcdir parameter that tells where to put the tangled source code.

$ prosecode tangle myfile.md --srcdir src/

Weaving

The following will execute the code in myfile.md, place the output inline, and then convert it to LaTeX.

$ prosecode weave mdfile.md --execute=True --outfile someotherfile.tex

The --outfile parameter is optional. If omitted, it will simply replace .md with .tex.

There is also an optional parameter --execute that tells whether or not to execute the code chunks. The default value is false.

prosecode's People

Contributors

donsheehy avatar

Stargazers

Eli W. Hunter avatar John Marsden avatar GAURAV avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.