Skip to main content

Literate package development with Jupyter

Project description

Literary logo with an orange cursive uppercase L inside black square brackets

Literary

pypi-badge binder-badge wiki-badge gitter-badge nbviewer

TL;DR

Literary is a Python tool to make Jupyter (IPython) notebooks behave like pure-Python packages. This allows pure-Python packages to be generated from notebooks, and notebooks to be imported at runtime. Literary now bootstraps itself; it is developed with Literary 🤯.

This package is an exploration of the literate programming idea pioneered by Donald Knuth and implemented in the nbdev package. Although nbdev looks to be a very mature and comprehensive tool, it resembles a significant departure from conventional package development. Literary is an exploration of what a smaller nbdev might look like.

Philosophy 📖

  1. Low mental overhead
    Realistically, most Python programmers that wish to write packages need to have some familiarity with the Python package development model, including the conventional structure of a package. For this reason, I feel that it is important to design literary such that these skills translate directly to designing libraries with notebooks
  2. Minimal downstream impact
    Users of literary packages should not realise that they are consuming notebook-generated code at runtime. This means that a pure-Python package needs to be generated from the notebooks, and it must use the conventional import model. For this reason, literary should only exist as a development dependency of the package.

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

literary-3.0.1.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

literary-3.0.1-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

Details for the file literary-3.0.1.tar.gz.

File metadata

  • Download URL: literary-3.0.1.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.4

File hashes

Hashes for literary-3.0.1.tar.gz
Algorithm Hash digest
SHA256 7d23b9650d1e0dea0130f9086c0a9ad2298843cb43461aae9da1b6ed96b55a16
MD5 88dc94b9c083451a821aa728b1025994
BLAKE2b-256 83747914af4fdd6c72024d7dab3e95251ae202717dd46ce2e7e52f500345bfec

See more details on using hashes here.

File details

Details for the file literary-3.0.1-py3-none-any.whl.

File metadata

  • Download URL: literary-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 20.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.4

File hashes

Hashes for literary-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 60b52105a9b4c9fa7b3293b741ec8ec86aa49bed5013088895ade7af5460679f
MD5 36eba6577ca067311fab7b328fefcc13
BLAKE2b-256 b019c7b49fdc6eb3d8fa7d0983f7c33612f0b15ab6e2412ee97af8caafb74f45

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