Skip to main content

ipypy notebook format

Project description

ipypy

Store Jupyter Notebooks in a more repo and coding friendly way.

Have you ever noticed that a Jupuyter Notebook nowadays is a json file? Containing together the metadata of the notebook itself, the list of cells, and for each cell, not only the source (what was written on it), but also the outputs, and metadata for each cell.

This project attemps to propose an alternative for that.

How

You can pick between a SplitCodeManager, which stores each notebook in:

  • my_file.ipynb (the usual notebook file, but with source information extracted)
  • my_file.ipypy (a pure code file that stores only the actual source code)

Or, a SplitOutputManager, which stores each notebook in:

  • my_file.ipynb (the usual notebook file, but without the cells output)
  • my_file.nbout (a json file that stores only the outputs of each cell)

Benefits

  • You can now import your notebook from another file
  • You can now use standard coding tools and practices for manipulating Notebooks code:
    • testing
    • import code defined in there
    • editable naturally by any editor
    • refactoring
    • tracking changes
    • ...
  • The source code of your notebook, can be versioned in a repository, where diffs, and history is readable. Now makes sense. It's code.
  • (Work In Progress) You can choose to simply ignore the metadata files (.ipynb) in the repository, or keep them versioned. It should be up to you.

Warning

We are in beta. Once you open a notebook with this extension enabled, and later save it, your notebook will be saved in a format a bit incompatible.

Installation

$ pip install ipypy

You will also need to configure your jupyter so it uses ipypy, by editing your jupyter config file, or from command line

$ jupyter lab --NotebookApp.contents_manager_class="ipypy.SplitCodeManager"

Project details


Download files

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

Source Distribution

ipypy-0.1.2.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

ipypy-0.1.2-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file ipypy-0.1.2.tar.gz.

File metadata

  • Download URL: ipypy-0.1.2.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.6

File hashes

Hashes for ipypy-0.1.2.tar.gz
Algorithm Hash digest
SHA256 04d7ba948846d3966174a5b6b9be2478a02a985ad355142a4f73850c883c4d56
MD5 e1820ce40761d661ccc6a6a1ab742094
BLAKE2b-256 d0adf655cf5720cdfd284795cb21cafb0f063d9086ed8fea2c3fd027cae4a7b0

See more details on using hashes here.

File details

Details for the file ipypy-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: ipypy-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 9.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.6

File hashes

Hashes for ipypy-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7fc5535bb973ed82a5ec1845e996f9aa3413db324b9605ee7c61687d4d64ffdf
MD5 467f0304ec2d97c200e1f18b8dd7fea3
BLAKE2b-256 584045b7ec7408af7eaab9fe5459ac9b7f25c30f3ae768da9787765a9f485863

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page