Skip to main content

Generate report-like documents from Jupyter notebooks

Project description

# Reportify

## Installation

Assuming you have pip installed, you can run

`bash pip install reportify --user `

Omit –user if you are running in a Python virtual environment, but otherwise keep it: don’t use sudo, it’s dangerous because it modifies the Python environment that your operating system may rely on.

If you aren’t running in a Python virtual environment, you may need to add ~/.local/bin to your PATH environment variable. This can be done by editing your shell initialization script, usually ~/.bashrc. (The tilde character ‘~’ will expand to the path to your home directory). Add the following line to the end of that file:

`bash export PATH=~/.local/bin:$PATH `

Now check that the reportify script is available by trying reportify –help. If you see usage information, everything went fine. If you get something like ‘command not found’, then everything went not fine.

## Usage

To see arguments, run reportify –help.

Inside the repository’s examples directory is an example notebook, example.ipynb, on which you can try reportify:

`bash reportify example.ipynb `

this should output a file, example.html, in the current directory.

Project details


Download files

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

Files for reportify, version 1.3.0
Filename, size File type Python version Upload date Hashes
Filename, size reportify-1.3.0-py2.py3-none-any.whl (9.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size reportify-1.3.0.tar.gz (7.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page