Skip to main content

markdown tool to create table of content from jupyter notebooks

Project description

# 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




Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

toci-0.0.3.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

toci-0.0.3-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file toci-0.0.3.tar.gz.

File metadata

  • Download URL: toci-0.0.3.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for toci-0.0.3.tar.gz
Algorithm Hash digest
SHA256 5f2982d5c98c8292d31b96b63350196d1a91434601f0807cc73a2303c259ee5e
MD5 c0c5b2e3ed7dc76bd50bf32981d7f982
BLAKE2b-256 dfdcf9cb8208f45ad995fd8ad89c20e216022d2c76e9cabf185aef2d87fed7b9

See more details on using hashes here.

File details

Details for the file toci-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: toci-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 4.2 kB
  • Tags: Python 3
  • Uploaded using 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

File hashes

Hashes for toci-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0252d8df0c6f7f95008d5b3a000473894b22a2b1ed26e2f309049b56593a23f9
MD5 e521e7e564ea1d2975fd2c5c81dc7704
BLAKE2b-256 390e3fd67d8838434eee35057baa5aacdf13b87273ff2ab5b07d3b90157e7885

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page