{ "info": { "author": "jckantor", "author_email": "Kantor.1@nd.edu", "bugtrack_url": null, "classifiers": [], "description": "[//]: # (DO NOT EDIT. README.md is generated by nbpages. Make changes to templates/README.md.jinja.)\n\n# nbpages\n\nnbpages is a command line tool for managing a collection of Jupyter notebooks published on\n[Github Pages](https://pages.github.com/). This project was inspired by the tools included with the\n[Python Data Science Handbook](https://github.com/jakevdp/PythonDataScienceHandbook) by\n[Jake Vanderplas](https://github.com/jakevdp).\n\n## Installation\n\n pip install nbpages\n\nTo upgrade a previously installed version to the latest version\n\n pip install nbpages --upgrade\n\n## Setting up the notebook repository\n\nThe first step in publishing a collection of notebooks on Github Pages is to\n[create a repository on Github.com](https://help.github.com/en/articles/creating-a-new-repository).\nGithub Pages are enabled under the settings tab for the repository. Scroll down to the Github Pages heading and select\n`master branch` for the source. This is also a good time to select a theme for the published collection.\n\n`nbpages` requires a local copy of the repository that can be created by cloning the remote repository.\nThen from the command line, navigate to the top level directory of the local repository and issue the command\n\n nbpages --setup\n\nDirectories named `notebooks` and `templates` will be created if they do not already exist. A configuration file\n`config` will be created inside the directory using data read from the `.git`. Jinja templates `README.md.jinja` and\n`notebook_header.jinja` willed created if they don't already exist. These templates can be edited as required\nusing data fields defined in `config`.\n\n## Notebook organization\n\nNotebooks are maintained within the `notebooks` directory. Thare are organized into a chapter/section heirarchy\nusing a filename prefix. Filenames have an `nn.mm-` prefix where`nn` refers to the chapter number or, if a letter, to\nan Appendix. The digits `mm` refers to the section number. Section `00` is reserved to hold the chapter title and\nany introductory material. The notebooks must also have the usual `.ipynb` suffix.\n\n## Normal usage\n\nFollowing setup, the normal use of `nbpages` is to execute the command line\n\n nbpages\n\nfrom the top level directory of the notebook repository. Normally this command would be between completing edits or\nadditions to the notebooks and prior to a github commit. The command will\n\n* add or amend headers and navigation bars in all notebooks,\n* write a table of contents file\n* write a keyword index\n* write README.md using the template file\n\n## Utilities\n\nTo help achieve a consistent style over a collection of notebooks, use the command\n\n nbpages --lint\n\nto locate some forms of notebook 'lint'. A current list of additional features can be found\n\n nbpages --help\n\n[//]: # (The following template code is used to insert a list of notebook links.)\n\n\n### [Table of Contents](http://nbviewer.jupyter.org/github/jckantor/nbpages/blob/master/notebooks/toc.ipynb?flush=true)\n\n### [Keyword Index](http://nbviewer.jupyter.org/github/jckantor/nbpages/blob/master/notebooks/index.ipynb?flush=true)\n\n\n### [Chapter 1.0 Style Guide](http://nbviewer.jupyter.org/github/jckantor/nbpages/blob/master/notebooks/01.00-Style-Guide.ipynb)\n\n\n### [Chapter 2.0 Examples](http://nbviewer.jupyter.org/github/jckantor/nbpages/blob/master/notebooks/02.00-Examples.ipynb)", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jckantor/nbpages", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "nbpages", "package_url": "https://pypi.org/project/nbpages/", "platform": "", "project_url": "https://pypi.org/project/nbpages/", "project_urls": { "Homepage": "https://github.com/jckantor/nbpages" }, "release_url": "https://pypi.org/project/nbpages/0.0.1.dev10/", "requires_dist": null, "requires_python": "", "summary": "Tools to maintain a respository of Jupyter notebooks", "version": "0.0.1.dev10" }, "last_serial": 5462511, "releases": { "0.0.1.dev0": [ { "comment_text": "", "digests": { "md5": "1cd75d2bd702b82e32c0b9359c1a91d0", "sha256": "41c09beefdac4512ed3890c4fb821678bd2a557adfe28a0cf773318abc6b7d2a" }, "downloads": -1, "filename": "nbpages-0.0.1.dev0.tar.gz", "has_sig": false, "md5_digest": "1cd75d2bd702b82e32c0b9359c1a91d0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5616, "upload_time": "2019-06-12T16:28:04", "url": "https://files.pythonhosted.org/packages/5c/0e/6130b5339f501c45946c2efe4fd5aff30a4c33417c5d2fa600e78dddceda/nbpages-0.0.1.dev0.tar.gz" } ], "0.0.1.dev1": [ { "comment_text": "", "digests": { "md5": "42a4f211db97bf2d13f69066fc5cd4c7", "sha256": "f7f111fe07f2d418541c794be66b2d43cf4c4d1b73128fddbd9c2ba47904ccc7" }, "downloads": -1, "filename": "nbpages-0.0.1.dev1.tar.gz", "has_sig": false, "md5_digest": "42a4f211db97bf2d13f69066fc5cd4c7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5541, "upload_time": "2019-06-12T18:52:26", "url": "https://files.pythonhosted.org/packages/7d/f0/5a166198f6e44cf970661d6262153db8deaffe5358bf531b493dfe309d87/nbpages-0.0.1.dev1.tar.gz" } ], "0.0.1.dev10": [ { "comment_text": "", "digests": { "md5": "b1ae2495e3808d2641e5e04bf731bfab", "sha256": "68998ec7a62e27d60ea952d13bc6538f81929df696d33ab539708ab78b25dd28" }, "downloads": -1, "filename": "nbpages-0.0.1.dev10.tar.gz", "has_sig": false, "md5_digest": "b1ae2495e3808d2641e5e04bf731bfab", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7628, "upload_time": "2019-06-28T16:36:05", "url": "https://files.pythonhosted.org/packages/98/8c/64d48e02de597697159d2ac2d94765004d6a6e2f102fc840429b9d81f2aa/nbpages-0.0.1.dev10.tar.gz" } ], "0.0.1.dev2": [ { "comment_text": "", "digests": { "md5": "6c52f3a4f9758c87b24895def442e5bd", "sha256": "b979c064a10760279559fb6948edacf2086880ae2e797488ae821e2108a46470" }, "downloads": -1, "filename": "nbpages-0.0.1.dev2.tar.gz", "has_sig": false, "md5_digest": "6c52f3a4f9758c87b24895def442e5bd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5816, "upload_time": "2019-06-12T19:12:44", "url": "https://files.pythonhosted.org/packages/f6/82/062d98bd74e9ea1de0f432d54ea541739ad2ae4ab2df55d47cd64bc73b1a/nbpages-0.0.1.dev2.tar.gz" } ], "0.0.1.dev3": [ { "comment_text": "", "digests": { "md5": "f55c5ca4f691be9168d87b16293b7e0d", "sha256": "bc9f2738d94b5d492ee7ca8c88b0f2d0ff0729ffbdfc0151bd5e5e4ca1ae928d" }, "downloads": -1, "filename": "nbpages-0.0.1.dev3.tar.gz", "has_sig": false, "md5_digest": "f55c5ca4f691be9168d87b16293b7e0d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6107, "upload_time": "2019-06-12T23:13:42", "url": "https://files.pythonhosted.org/packages/c3/3e/2ba8a38cc7c49f153c7a826aad6685626d3ada511dc7f4f9dd758ddd7221/nbpages-0.0.1.dev3.tar.gz" } ], "0.0.1.dev4": [ { "comment_text": "", "digests": { "md5": "a25c036e47d06677c72fb90a4a5d7018", "sha256": "8928f72398e29ce3f8649a4fd7b7a0406aa51007125ae0b84cd32af5952eb34f" }, "downloads": -1, "filename": "nbpages-0.0.1.dev4.tar.gz", "has_sig": false, "md5_digest": "a25c036e47d06677c72fb90a4a5d7018", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6316, "upload_time": "2019-06-13T11:40:25", "url": "https://files.pythonhosted.org/packages/16/e5/1360d9f0cb58e5557aafac2f8f5168b42f4ce7f2a24cba803c33c5779310/nbpages-0.0.1.dev4.tar.gz" } ], "0.0.1.dev5": [ { "comment_text": "", "digests": { "md5": "5c3c558d773c35517c1421e47043194a", "sha256": "c3160a8c2f17e7c90f1a6568c10e43582be3a3c669669b95d4b4da426c3f0aec" }, "downloads": -1, "filename": "nbpages-0.0.1.dev5-py3.7.egg", "has_sig": false, "md5_digest": "5c3c558d773c35517c1421e47043194a", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 16813, "upload_time": "2019-06-13T14:21:04", "url": "https://files.pythonhosted.org/packages/98/e2/437d074b5e4a5e4194a63386871555fe35779dffd0754164d223cabc4fd5/nbpages-0.0.1.dev5-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "da8209e8c164cfb20114a08a1b6e7cd3", "sha256": "b86ac4a18125923107ff4f04d6094114d89ce4a797d9ef781a9deb7370f70b69" }, "downloads": -1, "filename": "nbpages-0.0.1.dev5.tar.gz", "has_sig": false, "md5_digest": "da8209e8c164cfb20114a08a1b6e7cd3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6588, "upload_time": "2019-06-13T14:21:05", "url": "https://files.pythonhosted.org/packages/d7/25/75ac38d8c2076011d199ba068eb5fcfa0b8f6dc1d982a2ae8df55dc26138/nbpages-0.0.1.dev5.tar.gz" } ], "0.0.1.dev6": [ { "comment_text": "", "digests": { "md5": "a25c7e2aca487671ef4202198cbc7c13", "sha256": "3dfb0f0d9320f30cd70b390c6f0a83f0b910715862ae6df70fd6f4e92c05c6ae" }, "downloads": -1, "filename": "nbpages-0.0.1.dev6.tar.gz", "has_sig": false, "md5_digest": "a25c7e2aca487671ef4202198cbc7c13", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7076, "upload_time": "2019-06-26T20:19:49", "url": "https://files.pythonhosted.org/packages/a7/5b/6df3855fb86a0909b67ab8ab6925004fb12340c3c01f574c9bcfdc681d17/nbpages-0.0.1.dev6.tar.gz" } ], "0.0.1.dev7": [ { "comment_text": "", "digests": { "md5": "436cbe885a48b08b5441efcc3664258e", "sha256": "da9d968dcb4322219d40ddb61fb7bb9f5eaa63ada3890f87e373d1ace9029aab" }, "downloads": -1, "filename": "nbpages-0.0.1.dev7.tar.gz", "has_sig": false, "md5_digest": "436cbe885a48b08b5441efcc3664258e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7593, "upload_time": "2019-06-28T14:25:02", "url": "https://files.pythonhosted.org/packages/48/60/c04a3925f16bd9950001970328f8e56808ef4ab0c84ed4487bdd79662fea/nbpages-0.0.1.dev7.tar.gz" } ], "0.0.1.dev8": [ { "comment_text": "", "digests": { "md5": "7bfa9a010b6b9a01c3523f4bedac2d06", "sha256": "21bb7bb3d341780a6f002bddb2b62316aeb1856853bd8741a8aecc9a61d9b4b3" }, "downloads": -1, "filename": "nbpages-0.0.1.dev8.tar.gz", "has_sig": false, "md5_digest": "7bfa9a010b6b9a01c3523f4bedac2d06", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7614, "upload_time": "2019-06-28T14:52:57", "url": "https://files.pythonhosted.org/packages/8d/ae/eba91557d211604a23a1e42569d487658f9bed8fb0f8a76c8b2e516fb08a/nbpages-0.0.1.dev8.tar.gz" } ], "0.0.1.dev9": [ { "comment_text": "", "digests": { "md5": "bc3ac2d76e30f172d3fee7a0f30c32f2", "sha256": "65bc422c648d90151dcbb6f8eefbd9cf4ea53605887e4a4d306317e70cb7e986" }, "downloads": -1, "filename": "nbpages-0.0.1.dev9.tar.gz", "has_sig": false, "md5_digest": "bc3ac2d76e30f172d3fee7a0f30c32f2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7623, "upload_time": "2019-06-28T16:29:36", "url": "https://files.pythonhosted.org/packages/b3/5c/ef0580154578eef55362857fadbe94545a4864fd14571325ffba21b4971d/nbpages-0.0.1.dev9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b1ae2495e3808d2641e5e04bf731bfab", "sha256": "68998ec7a62e27d60ea952d13bc6538f81929df696d33ab539708ab78b25dd28" }, "downloads": -1, "filename": "nbpages-0.0.1.dev10.tar.gz", "has_sig": false, "md5_digest": "b1ae2495e3808d2641e5e04bf731bfab", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7628, "upload_time": "2019-06-28T16:36:05", "url": "https://files.pythonhosted.org/packages/98/8c/64d48e02de597697159d2ac2d94765004d6a6e2f102fc840429b9d81f2aa/nbpages-0.0.1.dev10.tar.gz" } ] }