nbsstorytime 0.0.5

Python Library to write N4L notes from Jupyter Notebooks

nbsstorytime

Developer Guide

If you are new to using nbdev here are some useful pointers to get you started.

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

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.

How to use

Example of a cell with N4L code - use a cell of type raw which starts by the line:

    #| n4l

    - 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

• 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

! pwd

! ls *.n4l