Metadata-Version: 1.1
Name: jupytoc
Version: 0.0.2
Summary: A commmand-line interface to add or update TOC to Jupyter Notebooks
Home-page: https://github.com/axelbellec/jupytoc/
Author: axelbellec
Author-email: axel.bellec@outlook.fr
License: MIT
Download-URL: https://github.com/axelbellec/jupytoc/tarball/0.0.1
Description: <div align="center">
          <img src="logo.png" alt="jupytoc_logo"/>
        </div>
        
        <br/>
        
        <div align="center">
        	<a href="https://badge.fury.io/py/jupyter"><img src="https://badge.fury.io/py/jupyter.svg" alt="PyPI version" height="18"></a>
        	<a href="https://requires.io/github/axelbellec/Jupytoc/requirements/?branch=master"><img src="https://requires.io/github/axelbellec/Jupytoc/requirements.svg?branch=master" alt="Requirements Status" /></a>
        	<a href="https://opensource.org/licenses/MIT">
        	<img src="http://img.shields.io/:license-mit-ff69b4.svg?style=flat-square" alt="mit"/>
        	</a>
        </div>
        
        <br/>
        
        <div align="center">
        	<p><b>Jupytoc</b> generates table of contents for jupyter notebook files. Links are compatible with anchors generated by GitHub.</p>
        </div>
        
        <br/>
        <br/>
        
        # `$ jupytoc`
        :pushpin: A commmand-line interface to add or update TOC to Jupyter Notebooks
        
        ## Usage
        
        ### Simplest usage
        
        ```sh
        $ jupytoc <jupyter_notebook>
        ```
        
        ### CLI args/otps
        
        ```sh
        $ jupytoc --help
        Usage: jupytoc [OPTIONS] [NOTEBOOKS]...
        
        Options:
          -R, --recursive         build TOC for all subdirectories recursively
          -l, --maxlevel INTEGER  limit TOC entries to headings only up to the
                                  specified level
          -t, --title TEXT        custom TOC title
          -s, --stdout            print to stdout
          --help                  Show this message and exit.
        ```
        
        ### Adding (or update) TOC to all notebooks in a directory and sub directories
        
        ```sh
        $ jupytoc .
        ```
        
        ### Custom TOC title
        
        Use `--title` option to specify a custom TOC title (Markdown formatted).  
        e.g. : 
        ```sh
        $ jupytoc --title '**Contents**'
        ```
        
        ### Maximum heading level 
        
        Use `--maxlevel` option to limit TOC entries to a certain level.
        By default, Jupyter Notebook headings are limited to 6 levels.
        
        ### Print generated TOC to stdout
        
        Use `--stdout` flag to print to stdout.
        
        ## Installation
        
        ### **1. PyPI**
        
        ```sh
        $ pip install jupytoc
        ```
        
        ### **2. GitHub for the latest development version**
        
        ```sh
        $ pip install git+https://github.com/axelbellec/jupytoc
        ```
        
        Jupytoc has the following dependencies:
        
        - [click](http://click.pocoo.org/6/): a command line library for Python
        
        
        ## Features
        
        ### Done
        
        - [X] Generate TOC a top of file
        - [X] Update an existing TOC in Markdown file
        - [X] Handle multiple files input
        - [X] Limit TOC entries
        - [X] Adding TOC to all files in a directory/sub directories
        - [X] Enable custom TOC title editing
        - [X] Print TOC to stdout
        
        ### Still in development
        
        - [ ] Test suite
        
Keywords: jupytoc cli command line pip jupyter notebook tool
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
