nbsstorytime

Python Library to write N4L notes from Jupyter Notebooks

Usage

Installation

Install latest from the GitHub repository:

$ pip install git+https://github.com/chrphb/nbsstorytime.git

or from pypi

$ pip install nbsstorytime

Documentation

Documentation can be found hosted on this GitHub repository’s pages. Additionally you can find package manager specific guidelines on pypi.

To learn more about the N4L semantic format, see Mark Burgess’ SSToryTime

How to use

Just use a Jupyter notebook and edit your cells.

When you want to write some N4L notes, add a new cell of type raw that begins with:

    #| n4l

At the end of your notebook, add a Python code cell:

    import nbsstorytime; nbsstorytime.nbsstorytime_export() 

This cell will export the content of all your N4L cells content into a new file called with the same name as your notebook, but with a .n4l extension”

demonstration

• my notes # you give it a title # and you can leave comments to yourself.

Mostly you just write notes ” (e.g.) This is a simple example that illustrates the line above

Developer Guide

Install nbsstorytime in Development mode

# make sure nbsstorytime package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to nbsstorytime
$ nbdev_prepare