# Toci
Toci is a markdown tool to generate an outline from a given Jupyter notebook. It traverses the markdown cells of a given `ipynb` file to form a toc for you.
## How it works
```
$ pip install toci==0.0.3
$ toci --help
usage: toci [-h] [--version] --notebook NOTEBOOK
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
--notebook NOTEBOOK, -n NOTEBOOK
an ipynb notebook file
```
Create a table of content from a given ipynb file as follows:
```
$ toci -n notebook.ipynb
# Table of Content
- [Intro](#intro)
- [Heading 2](#heading-2)
- [Heading 3](#heading-3)
- [Another Heading 2](#another-heading-2)
- [Another Heading 2 2](#another-heading-2-2)
- [Another Heading 3](#another-heading-3)
- [Another Heading 4](#another-heading-4)
- [😽 Cat Section](#-cat-section)
- [is another section ready?](#is-another-section-ready)
```
## LICENSE
MIT
Metadata
Release files for toci 0.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| toci-0.0.3.tar.gz | 3.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| toci-0.0.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.9 kB
Release files / toci-0.0.3.tar.gz
| Download URL | toci-0.0.3.tar.gz |
|---|---|
| Size | 3.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5f2982d5c98c8292d31b96b63350196d1a91434601f0807cc73a2303c259ee5e
|
|
BLAKE2b-256 checksum How to use checksums |
dfdcf9cb8208f45ad995fd8ad89c20e216022d2c76e9cabf185aef2d87fed7b9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.8
|
Release files / toci-0.0.3-py3-none-any.whl
| Download URL | toci-0.0.3-py3-none-any.whl |
|---|---|
| Size | 4.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0252d8df0c6f7f95008d5b3a000473894b22a2b1ed26e2f309049b56593a23f9
|
|
BLAKE2b-256 checksum How to use checksums |
390e3fd67d8838434eee35057baa5aacdf13b87273ff2ab5b07d3b90157e7885
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.8
|