{ "info": { "author": "axelbellec", "author_email": "axel.bellec@outlook.fr", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5" ], "description": "
\n \"jupytoc_logo\"/\n
\n\n
\n\n
\n\t\"PyPI\n\t\"Requirements\n\t\n\t\"mit\"/\n\t\n \n \"Build\n \n Coverage Status\n
\n\n
\n\n
\n\t

Jupytoc generates table of contents for jupyter notebook files. Links are compatible with anchors generated by GitHub.

\n
\n\n
\n
\n\n# `$ jupytoc`\n:pushpin: A commmand-line interface to add/update/delete TOC to Jupyter Notebooks\n\n## Usage\n\n### Simplest usage\n\n```sh\n$ jupytoc \n```\n\nTo add toc for all files in a directory, just launch:\n```sh\n$ jupytoc .\n```\n\n### CLI args/otps\n\n```sh\n$ jupytoc --help\nUsage: jupytoc [OPTIONS] [NOTEBOOKS]...\n\nOptions:\n -R, --recursive build TOC for all subdirectories recursively\n -l, --maxlevel INTEGER limit TOC entries to headings only up to the\n specified level\n -t, --title TEXT custom TOC title\n -s, --stdout print to stdout\n -d, --delete remove TOC from notebook file\n --help Show this message and exit.\n```\n\n### Adding (or update) TOC to all notebooks in a directory and sub directories\n\n```sh\n$ jupytoc .\n```\n\n### Custom TOC title\n\nUse `--title` option to specify a custom TOC title (Markdown formatted). \ne.g. : \n```sh\n$ jupytoc --title '**Contents**'\n```\n\n### Maximum heading level \n\nUse `--maxlevel` option to limit TOC entries to a certain level.\nBy default, Jupyter Notebook headings are limited to 6 levels.\n\n```sh\n$ jupytoc --maxlevel 2\n```\n\n### Print generated TOC to stdout\n\nUse `--stdout` flag to print to stdout.\n\n```sh\n$ jupytoc --stdout\n```\n\n### Deleting TOC \n\nUse `--delete` option to delete a TOC.\n\n```sh\n$ jupytoc --delete \n```\n\n## Installation\n\n### **1. PyPI**\n\n```sh\n$ pip install jupytoc\n```\n\n### **2. GitHub for the latest development version**\n\n```sh\n$ pip install git+https://github.com/axelbellec/jupytoc\n```\n\nJupytoc has the following dependencies:\n\n- [click](http://click.pocoo.org/6/): a command line library for Python\n- [emoji](https://github.com/carpedm20/emoji/): emoji terminal output for Python\n\n## Features\n\n### Done\n\n- [X] generate TOC a top of file\n- [X] add/update an existing TOC in Markdown file\n- [X] add/update TOC for all files in the current directory\n- [X] handle multiple files input\n- [X] limit TOC entries\n- [X] add/udpate TOC to all files in a directory/sub directories\n- [X] enable custom TOC title editing\n- [X] print TOC to stdout\n- [X] delete TOC option\n\n### Still in development\n\n- [ ] Test suite\n\n\n## FAQ\n\n\n__1. Why do my link anchors generated with `jupytoc` not work when the notebook is read on Github?__\n\nGitHub rending concerning `.ipynb` notebooks do not let us to navigate through links. \n ", "description_content_type": null, "docs_url": null, "download_url": "https://github.com/axelbellec/Jupytoc/archive/0.1.4.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/axelbellec/jupytoc/", "keywords": "jupytoc cli command line pip jupyter notebook tool", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "jupytoc", "package_url": "https://pypi.org/project/jupytoc/", "platform": "any", "project_url": "https://pypi.org/project/jupytoc/", "project_urls": { "Download": "https://github.com/axelbellec/Jupytoc/archive/0.1.4.tar.gz", "Homepage": "https://github.com/axelbellec/jupytoc/" }, "release_url": "https://pypi.org/project/jupytoc/0.1.4/", "requires_dist": null, "requires_python": "", "summary": "A commmand-line interface to add or update TOC to Jupyter Notebooks", "version": "0.1.4" }, "last_serial": 2485155, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "e9eaac94645ab89f6a4ab70fab98d2a2", "sha256": "d0309c00b0a71b17fead6c9eb8faae9d09f17306e1d824b066f36e5d323d77f3" }, "downloads": -1, "filename": "jupytoc-0.0.1.tar.gz", "has_sig": false, "md5_digest": "e9eaac94645ab89f6a4ab70fab98d2a2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2315, "upload_time": "2016-11-22T22:07:16", "url": "https://files.pythonhosted.org/packages/9e/b7/47cfd9846e517389fb1a9db655fd77ef21b1232744c27837298cbc22c0ca/jupytoc-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "4b51067c2dbf77b189d1331a29906df6", "sha256": "b1d9c32af72e68e60f9277c74bb1d75aac16946913dd880acc98fb3d1ca49356" }, "downloads": -1, "filename": "jupytoc-0.0.2.tar.gz", "has_sig": false, "md5_digest": "4b51067c2dbf77b189d1331a29906df6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4371, "upload_time": "2016-11-23T21:29:07", "url": "https://files.pythonhosted.org/packages/47/06/86d6d3fae36459f0fff2cc08be23a837e7ec0f91d0ef7c28033b68913542/jupytoc-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "18dd22f421af7f0166a6a58b646b35f5", "sha256": "d82348bdf5751f785e4f5b68aacf9abb8efdd6c0dc1a923c770eac870ca57566" }, "downloads": -1, "filename": "jupytoc-0.0.3.tar.gz", "has_sig": false, "md5_digest": "18dd22f421af7f0166a6a58b646b35f5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4826, "upload_time": "2016-11-24T18:26:16", "url": "https://files.pythonhosted.org/packages/91/f9/057fe19168be64d80b21f83c4a981704065420a19e5ecc24438db023a449/jupytoc-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "65bdecab7eb28c1daa93c56f1ebe17e3", "sha256": "dd6e0ce11fa87bbd1cfcacdf3dc4543e3a755ee9594746879e4db343c8b9463c" }, "downloads": -1, "filename": "jupytoc-0.0.4.tar.gz", "has_sig": false, "md5_digest": "65bdecab7eb28c1daa93c56f1ebe17e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4824, "upload_time": "2016-11-24T18:31:03", "url": "https://files.pythonhosted.org/packages/b5/27/294bec3f6a347998125b17c6c2224e38f263fe4ad258a586c4d32d28a771/jupytoc-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "817aafc17e42ff671d40902d17855c8f", "sha256": "628cbbe2b7395a38482a3b684a2de794487048030e31d3dd30155bfbbd950944" }, "downloads": -1, "filename": "jupytoc-0.0.5.tar.gz", "has_sig": false, "md5_digest": "817aafc17e42ff671d40902d17855c8f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4824, "upload_time": "2016-11-24T18:33:25", "url": "https://files.pythonhosted.org/packages/f8/38/9165d1e3ef0cdb5d7e0e4509b925a4973e22bb3a9258eb1567a17f0cb336/jupytoc-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "d8350f6c6531f0b82c9bb0b37ba0ed22", "sha256": "f1abedfaa36d61f305688e19c322a8b1e43f2c3d8488ac9fb91af3edf7968369" }, "downloads": -1, "filename": "jupytoc-0.0.6.tar.gz", "has_sig": false, "md5_digest": "d8350f6c6531f0b82c9bb0b37ba0ed22", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4830, "upload_time": "2016-11-24T18:37:53", "url": "https://files.pythonhosted.org/packages/be/7d/b6f39d00ee66888588ecb865a74e706137ddfa08e1b75e9a7384fe4d8c73/jupytoc-0.0.6.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "6c1857567559f59cfef6f04d37502234", "sha256": "4f1ceee3220da3c806e302449466aa1b841442348906017ebd378752f6974c60" }, "downloads": -1, "filename": "jupytoc-0.1.0.tar.gz", "has_sig": false, "md5_digest": "6c1857567559f59cfef6f04d37502234", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4844, "upload_time": "2016-11-24T18:44:28", "url": "https://files.pythonhosted.org/packages/9c/61/c59ca1b43b94e25a7f41012a6726151fc34c6e473ed7011b092080891070/jupytoc-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "9c4c806125d51a92328431c3b5995944", "sha256": "05e074aa051a14ba40758656f320ed414c91379354d96ed524ea47033bedadd8" }, "downloads": -1, "filename": "jupytoc-0.1.1.tar.gz", "has_sig": false, "md5_digest": "9c4c806125d51a92328431c3b5995944", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4817, "upload_time": "2016-11-24T18:54:38", "url": "https://files.pythonhosted.org/packages/7f/11/0a7518b7231522172917af8c9da43bc30606baeeb4d6def10c74b18d2cdb/jupytoc-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "9360059052730530ca04aa5742703a1d", "sha256": "f6953eb69844fd0e8336e18a04f7d405493487f2fb70da95be200c7e11fbd2f8" }, "downloads": -1, "filename": "jupytoc-0.1.2.tar.gz", "has_sig": false, "md5_digest": "9360059052730530ca04aa5742703a1d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4812, "upload_time": "2016-11-24T18:56:53", "url": "https://files.pythonhosted.org/packages/8e/f4/c7e33019be581506e78fe345b5abb81beb47ac23d9f6d92e5380cb285657/jupytoc-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "e455fce63a60c73e9bd80f009538143e", "sha256": "78fb5826578cba15ecf5e37ff95b808024830b491755de780be8b1581d1deb64" }, "downloads": -1, "filename": "jupytoc-0.1.3.tar.gz", "has_sig": false, "md5_digest": "e455fce63a60c73e9bd80f009538143e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4816, "upload_time": "2016-11-24T18:59:54", "url": "https://files.pythonhosted.org/packages/93/7c/62be4c07bc2f18711cf2171891421a0e58b1cd4a62c888eb5a336fcc9a97/jupytoc-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "8601605c99253b1012fe54cf48f1285c", "sha256": "c1c1b3385f643c840fb3836a4b152dea7d2864164d850d6b684460c93c9f12f5" }, "downloads": -1, "filename": "jupytoc-0.1.4.tar.gz", "has_sig": false, "md5_digest": "8601605c99253b1012fe54cf48f1285c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5687, "upload_time": "2016-11-27T18:03:55", "url": "https://files.pythonhosted.org/packages/40/cc/376f8cae3eeca65f4e8aa0d270176eaa3a760c608876d29cccbf71d6103b/jupytoc-0.1.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8601605c99253b1012fe54cf48f1285c", "sha256": "c1c1b3385f643c840fb3836a4b152dea7d2864164d850d6b684460c93c9f12f5" }, "downloads": -1, "filename": "jupytoc-0.1.4.tar.gz", "has_sig": false, "md5_digest": "8601605c99253b1012fe54cf48f1285c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5687, "upload_time": "2016-11-27T18:03:55", "url": "https://files.pythonhosted.org/packages/40/cc/376f8cae3eeca65f4e8aa0d270176eaa3a760c608876d29cccbf71d6103b/jupytoc-0.1.4.tar.gz" } ] }