Metadata-Version: 2.4
Name: nbsstorytime
Version: 0.0.9
Summary: Python Library to write N4L notes from Jupyter Notebooks
Home-page: https://github.com/chrphb/nbsstorytime
Author: Christophe Beauce
Author-email: chris@chrphb.com
License: Apache Software License 2.0
Keywords: nbdev jupyter notebook python
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastcore==1.9.5
Requires-Dist: nbformat==5.10.4
Requires-Dist: ipykernel==6.31.0
Provides-Extra: dev
Requires-Dist: nbdev==2.4.7; extra == "dev"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# nbsstorytime


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

## Usage

### Installation

Install latest from the GitHub
[repository](https://github.com/chrphb/nbsstorytime):

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

or from [pypi](https://pypi.org/project/nbsstorytime/)

``` sh
$ pip install nbsstorytime
```

### Documentation

Documentation can be found hosted on this GitHub
[repository](https://github.com/chrphb/nbsstorytime)’s
[pages](https://chrphb.github.io/nbsstorytime/). Additionally you can
find package manager specific guidelines on
[pypi](https://pypi.org/project/nbsstorytime/).

To learn more about the N4L semantic format, see [Mark Burgess’
SSToryTime](https://github.com/markburgess/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](demo_jupyter_nbsstorytime.mp4)

- 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

``` sh
# 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
```
