https://github.com/agoose77/literary

Literate Python package development with Jupyter
https://github.com/agoose77/literary

jupyter literate-programming nbconvert notebooks python

Last synced: 14 days ago
JSON representation

Literate Python package development with Jupyter

• Host: GitHub
• URL: https://github.com/agoose77/literary
• Owner: agoose77
• License: bsd-3-clause
• Created: 2020-10-30T12:19:08.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-13T14:03:21.000Z (almost 2 years ago)
• Last Synced: 2024-08-01T16:46:45.002Z (3 months ago)
• Topics: jupyter, literate-programming, nbconvert, notebooks, python
• Language: Jupyter Notebook
• Homepage:
• Size: 1.19 MB
• Stars: 11
• Watchers: 5
• Forks: 1
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Literary logo with an orange cursive uppercase L inside black square brackets](https://raw.githubusercontent.com/agoose77/literary/master/assets/logo.png)

# Literary 

[![pypi-badge][]][pypi] [![binder-badge][]][binder] [![wiki-badge][]][wiki] [![gitter-badge][]][gitter] [![nbviewer](https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg)](https://nbviewer.jupyter.org/github/agoose77/literary/tree/master/src/) 

[gitter-badge]: https://badges.gitter.im/literary-nb/literary.svg

[gitter]: https://gitter.im/literary-nb/literary?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

[binder-badge]: https://mybinder.org/badge_logo.svg

[binder]:

  https://mybinder.org/v2/gh/agoose77/literary/HEAD?urlpath=lab%2Ftree%2Fexamples

[pypi-badge]: https://img.shields.io/pypi/v/literary

[pypi]: https://pypi.org/project/literary

[wiki-badge]: https://img.shields.io/static/v1?label=wiki&message=read&color=green&logo=github

[wiki]: https://github.com/agoose77/literary/wiki

## 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](https://en.wikipedia.org/wiki/Bootstrapping); it is developed with Literary 🤯.

This package is an exploration of the [literate programming](http://www.literateprogramming.com) idea [pioneered by

 Donald

Knuth](https://www-cs-faculty.stanford.edu/~knuth/lp.html) and implemented in the

 [`nbdev` package](https://github.com/fastai/nbdev). 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.