Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Scientific reports with embedded python computations with reST, LaTeX or markdown

Project Description

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.

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, 3.5 and 3.6 compatibility

  • 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.

  • 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.
  • 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 scripts. Similar to R markdown.

  • Run from command line or interpreter.

Install

From PyPi:

pip install --upgrade Pweave

with conda:

conda install -c conda-forge 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.

Release History

Release History

This version
History Node

0.30.1

History Node

0.30

History Node

0.30rc2

History Node

0.30rc1

History Node

0.25

History Node

0.24

History Node

0.23.2

History Node

0.23.1

History Node

0.23

History Node

0.22.3

History Node

0.22.2

History Node

0.22.1

History Node

0.22

History Node

0.21.2

History Node

0.21.1

History Node

0.21

History Node

0.20.1

History Node

0.20

History Node

0.13

History Node

0.12

History Node

0.11

History Node

0.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
Pweave-0.30.1-py2.py3-none-any.whl (125.1 kB) Copy SHA256 Checksum SHA256 3.6 Wheel Aug 28, 2017
Pweave-0.30.1.tar.gz (2.2 MB) Copy SHA256 Checksum SHA256 Source Aug 28, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting