jasongrout / pweave

Pweave is a scientific report generator and a literate programming tool for Python. It can capture the results and plots from data analysis and works well with numpy, scipy and matplotlib.

Note about Pweave 0.3

The master branch contains the code for the upcoming 0.3 version, which breaks compatibility with latest release and runs only using Python 3. The code has quite good test coverage and should be usable for anyone who wants to try it out.

Notable new features:

• Code is run using jupyter_client giving the possibility to run code using any installed kernel (including python2) via --kernel argument. Some chunk options only work for Python.
• Support for IPython magics and rich output.
• Many small fixes to output and syntax highlighting including rendering tracebacks correctly.
• Output directly to Jupyter notebooks with chunk options preserved as metadata -> ability to use custom nbconvert templates in addition to builtin formatters.

About Pweave

Pweave is a scientific report generator and a literate programming tool for Python. Pweave can capture the results and plots from data analysis and works well with NumPy, SciPy and matplotlib. It is able to run python code from source document and include the results and capture matplotlib plots in the output.

It can produce reST, Sphinx, Latex, HTML and markdown (pandoc and leanpub) output from several input formats.

• Noweb uses noweb syntax for separating code from documentation.
• Markdown. Run code from markdown code blocks.
• Script. Python script with special markup in comments.

Pweave is good for creating reports, tutorials, presentations etc. with embedded python code It can also be used to make websites together with e.g. Sphinx or rest2web.

Features:

• Python 3.4 and 3.5 compatibility
• Execute python code in the chunks and capture input and output to a report.
• Use hidden code chunks, i.e. code is executed, but not printed in the output file.
• Capture matplotlib graphics.
• Evaluate inline code in documentation chunks marked using <% %> and <%= %>.
• Cache all code and results from previous runs for fast report generation when you are only working with documentation. Inline code will be hidden in documentation mode.
• Supports reST, LaTeX, HTML or markdown for document chunks
• Publish reports from Python scipts. Similar to R markdown.
• Run from command line or interpreter.

Install

From PyPi:

pip install --upgrade Pweave

with conda:

conda install -c mpastell pweave

or download the source and run:

python setup.py install

Pweave documentation can be found from the website http://mpastell.com/pweave

Release Notes

See CHANGELOG.txt for changes in each release.

License information

See the file "LICENSE" for information on the history of this software, terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES.