The coolest way to transform Jupyter Notebooks.
Project description
=============
NotebookToAll
=============
.. image:: https://img.shields.io/pypi/v/notebooktoall.svg
:target: https://pypi.python.org/pypi/notebooktoall
.. image:: https://img.shields.io/travis/notebooktoall/notebooktoall.svg
:target: https://travis-ci.org/notebooktoall/notebooktoall
.. image:: https://readthedocs.org/projects/notebooktoall/badge/?version=latest
:target: https://notebooktoall.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://pyup.io/repos/github/notebooktoall/notebooktoall/shield.svg
:target: https://pyup.io/repos/github/notebooktoall/notebooktoall/
:alt: Updates
# NotebookToAll
The coolest way to turn a Jupyter Notebook into sharable files.
Turn your Jupyter Notebook into a .py executable file and an .html file with a one-line command. You can create both or either file type at the same time! Under the hood, this package uses Jupyter nbconvert.
nbconvert is great for command line transformations, but it takes a bit of work to use in a program. NotebookToAll to the rescue.
# Quick Start
## Install
Install from PyPI.
`pip install notebooktoall`
## Use
Make sure your notebook doesn't have magic commands in it if you want to create an executable .py script.
```
from notebooktoall.transform import transform_notebooks
transform_notebooks(ipynb_file="my_jupyter_notebook.ipynb", export_list=["html", "py"])
```
Run your code and your .html and .py files should appear in your current working directory.
You can pass a Jupyter notebook url to transform_notebooks().
## License
* Free software: GNU General Public License v3
## Docs
* Documentation: https://notebooktoall.readthedocs.io.
## Credits:
The Cookiecutter_ `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
0.0.1 (2019-02-11)
------------------
* First release on PyPI.
0.1.0 (2019-02-11)
_________________
* Add Code of Conduct
* Improve docs
* Fix badges
* Cover multiple python versions
* Add code coverage
0.1.1 (2019-02-11)
_________________
* Bump version
0.1.2 (2019-02-11)
_________________
* Add missing dependency
* Update ReadTheDocs usage
NotebookToAll
=============
.. image:: https://img.shields.io/pypi/v/notebooktoall.svg
:target: https://pypi.python.org/pypi/notebooktoall
.. image:: https://img.shields.io/travis/notebooktoall/notebooktoall.svg
:target: https://travis-ci.org/notebooktoall/notebooktoall
.. image:: https://readthedocs.org/projects/notebooktoall/badge/?version=latest
:target: https://notebooktoall.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://pyup.io/repos/github/notebooktoall/notebooktoall/shield.svg
:target: https://pyup.io/repos/github/notebooktoall/notebooktoall/
:alt: Updates
# NotebookToAll
The coolest way to turn a Jupyter Notebook into sharable files.
Turn your Jupyter Notebook into a .py executable file and an .html file with a one-line command. You can create both or either file type at the same time! Under the hood, this package uses Jupyter nbconvert.
nbconvert is great for command line transformations, but it takes a bit of work to use in a program. NotebookToAll to the rescue.
# Quick Start
## Install
Install from PyPI.
`pip install notebooktoall`
## Use
Make sure your notebook doesn't have magic commands in it if you want to create an executable .py script.
```
from notebooktoall.transform import transform_notebooks
transform_notebooks(ipynb_file="my_jupyter_notebook.ipynb", export_list=["html", "py"])
```
Run your code and your .html and .py files should appear in your current working directory.
You can pass a Jupyter notebook url to transform_notebooks().
## License
* Free software: GNU General Public License v3
## Docs
* Documentation: https://notebooktoall.readthedocs.io.
## Credits:
The Cookiecutter_ `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
0.0.1 (2019-02-11)
------------------
* First release on PyPI.
0.1.0 (2019-02-11)
_________________
* Add Code of Conduct
* Improve docs
* Fix badges
* Cover multiple python versions
* Add code coverage
0.1.1 (2019-02-11)
_________________
* Bump version
0.1.2 (2019-02-11)
_________________
* Add missing dependency
* Update ReadTheDocs usage
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for notebooktoall-0.1.2.macosx-10.7-x86_64.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea2e7b8e155be6d0cb0ada28ea9aab875607bec8d8eb5ccc913234231bfb2882 |
|
MD5 | 4e8d075b832f8c0072bea5a34c06afa8 |
|
BLAKE2b-256 | ada69f2de2a765d5316790ff6bcb9eee60c2759e964fcd3d248b8d944044e690 |