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.2

$ 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)
```

## 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.2.tar.gz (3.9 kB view details)

Uploaded Source

Built Distributions

toci-0.0.2-py3.9.egg (5.6 kB view details)

Uploaded Source

toci-0.0.2-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: toci-0.0.2.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

File hashes

Hashes for toci-0.0.2.tar.gz
Algorithm Hash digest
SHA256 f62a7a5f8f51e8275062291a9b0fed5a8e0e5a25f78928e70b87f243577ad9e7
MD5 5c9fb32232c73f33ca77f679e804b910
BLAKE2b-256 16980309c7e47d7b903cb7722768a20c68d7c8af0372f547380c3888b8fd6c5b

See more details on using hashes here.

File details

Details for the file toci-0.0.2-py3.9.egg.

File metadata

  • Download URL: toci-0.0.2-py3.9.egg
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

File hashes

Hashes for toci-0.0.2-py3.9.egg
Algorithm Hash digest
SHA256 9b9da3038dcb9919e7f678955f0cc2595d2afa6b07eea6a514efc8e30a9cb328
MD5 f685bec4e1810eba808f85df5ffd18e3
BLAKE2b-256 cdf5b1137d7a0fd005e42e1909bbae57e9f9f7300388ee6237c23f0bfad89605

See more details on using hashes here.

File details

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

File metadata

  • Download URL: toci-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

File hashes

Hashes for toci-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6b43122fdf3b4f1b2518ef9077753033ecedbc3bbbe8a08b96fe8edf2fecfef2
MD5 91e5335f926eca2b4aa097bb83f47af5
BLAKE2b-256 da732e8b4417c994a99ec274555fcedfae3c33041f70cda829f1a40843a1d2c0

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