{ "info": { "author": "Emanuele Fabbiani", "author_email": "donlelef@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: End Users/Desktop", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: JavaScript", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Utilities" ], "description": "# Jupyter template\n\n[![Lifecycle:\nexperimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)\n![GitHub](https://img.shields.io/github/license/donlelef/jupytemplate)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/jupytemplate)\n![PyPI](https://img.shields.io/pypi/v/jupytemplate)\n![Build Status](https://travis-ci.org/donlelef/jupytemplate.svg?branch=master)\n![GitHub issues](https://img.shields.io/github/issues/donlelef/jupytemplate)\n[![Downloads](https://pepy.tech/badge/jupytemplate)](https://pepy.tech/project/jupytemplate)\n[![Downloads](https://pepy.tech/badge/jupytemplate/month)](https://pepy.tech/project/jupytemplate/month)\n[![Say Thanks\\!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/donlelef)\n\n\nA simple template for jupyter notebooks.\n\nThe extension sets up any new Jupyter Notebook \nwith a conventional and general-purpose\ntemplate to shape Data Science analysis.\n\nThe template includes conventional sections,\nlike *Data Import*, *Processing* and *References*,\nas well as code to perform common operations, like\nimporting and configuring charting libraries. \n\nMoreover, it prompts for a meaningful name whenever\nyou try and save a notebook called 'Untitled'. \n\nBut don't worry, you can disable\nthis one.\n\n\n## Motivation\nJupyter notebooks are awesome tools: they enable fast \nprototyping and ease result sharing. However, due to \ntheir flexibility, they are prone to be abused. \n\nIn order to help Data Scientist keep their notebooks \nclean, a reasonably flexible yet conventional template\nmay help. Moreover, such a template may be also a \nproductivity tool, which speeds up common setup,\nsuch as library import.\n\n## Quick start\nIt is not mandatory, but you can install the full set of Jupyter \nextensions.\n```shell\npip install jupyter_contrib_nbextensions\njupyter contrib nbextension install --user\n```\nFeel free to visit [their repository](https://github.com/ipython-contrib/jupyter_contrib_nbextensions)\nfor more information.\n\nNow you can install the package:\n```shell\npip install jupytemplate\n```\nThen, you have to install the javascript files from \nthe Python package in a conventional jupyter directory:\n```shell\njupyter nbextension install --py jupytemplate --sys-prefix\n```\nFinally, you may want to enable the extension:\n```shell\njupyter nbextension enable jupytemplate/main --sys-prefix\n```\nYou can easily enable, disable or configure the extension\nby using the [nbextension_configurator](https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator)\nserver extension.\n\n\n## Changing the template\nTemplate location can be found by running: \n```python\nimport jupytemplate\nprint(jupytemplate.get_template_path())\n```\nOf course, you can modify the template as you like, do not \nmodify the file name `template.ipynb`. \nAfter editing the template, run:\n```shell\njupyter nbextension install --py jupytemplate --sys-prefix\njupyter nbextension enable jupytemplate/main --sys-prefix\n```\nto make changes effective.\n\n## References\nPlease consider reading the following resources for\na more comprehensive understanding:\n- Will Kohersen, [Set Your Jupyter Notebook up Right with this Extension](https://towardsdatascience.com/set-your-jupyter-notebook-up-right-with-this-extension-24921838a332)\n- Will Kohersen, [How to Write a Jupyter Notebook Extension](https://towardsdatascience.com/how-to-write-a-jupyter-notebook-extension-a63f9578a38c)\n- Will Kohersen, [Setup extension](https://github.com/WillKoehrsen/Data-Analysis/tree/master/setup)", "description_content_type": "text/markdown", "docs_url": null, "download_url": "https://github.com/donlelef/jupytemplate/archive/v0.2.1.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/donlelef/jupytemplate", "keywords": "", "license": "MIT licence", "maintainer": "", "maintainer_email": "", "name": "jupytemplate", "package_url": "https://pypi.org/project/jupytemplate/", "platform": "", "project_url": "https://pypi.org/project/jupytemplate/", "project_urls": { "Download": "https://github.com/donlelef/jupytemplate/archive/v0.2.1.tar.gz", "Homepage": "https://github.com/donlelef/jupytemplate" }, "release_url": "https://pypi.org/project/jupytemplate/0.2.1/", "requires_dist": null, "requires_python": "", "summary": "Jupyter extension to support templates", "version": "0.2.1" }, "last_serial": 5694274, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "19bf5a387b7f7db4c7dc80a1861847a4", "sha256": "434d0404953126b7668bad3e06ae0bc1d5e67dcbe210cfc40a5336b76f850584" }, "downloads": -1, "filename": "jupytemplate-0.1.tar.gz", "has_sig": false, "md5_digest": "19bf5a387b7f7db4c7dc80a1861847a4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 23769, "upload_time": "2019-08-16T16:01:44", "url": "https://files.pythonhosted.org/packages/ab/b6/ba38f44ffd1328ae2e836b11f69388f3132cc2b560336176b3606747eba9/jupytemplate-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "bcca7d844f631414d480eee2e57a4258", "sha256": "5d1ef41165ba58d60ae626a7e4066f021f274092f33dcce4977a2bae4953e895" }, "downloads": -1, "filename": "jupytemplate-0.2.tar.gz", "has_sig": false, "md5_digest": "bcca7d844f631414d480eee2e57a4258", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 23910, "upload_time": "2019-08-18T11:10:20", "url": "https://files.pythonhosted.org/packages/21/94/394c976eb755c9704060b45000b45ae19ee0444c1e16e07fb2fbad7c835f/jupytemplate-0.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "728f18b3bc5d425af20b660593130d63", "sha256": "e84a8f7982e68e75c5a8d106ef5562d38d40ac9f6a5d94acbc1a77cd91aa2cb5" }, "downloads": -1, "filename": "jupytemplate-0.2.1.tar.gz", "has_sig": false, "md5_digest": "728f18b3bc5d425af20b660593130d63", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 23917, "upload_time": "2019-08-18T11:19:23", "url": "https://files.pythonhosted.org/packages/31/77/4fc023d3a5ec571a80e84d145905604cf7f6e8869fb7b78059456b71a383/jupytemplate-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "728f18b3bc5d425af20b660593130d63", "sha256": "e84a8f7982e68e75c5a8d106ef5562d38d40ac9f6a5d94acbc1a77cd91aa2cb5" }, "downloads": -1, "filename": "jupytemplate-0.2.1.tar.gz", "has_sig": false, "md5_digest": "728f18b3bc5d425af20b660593130d63", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 23917, "upload_time": "2019-08-18T11:19:23", "url": "https://files.pythonhosted.org/packages/31/77/4fc023d3a5ec571a80e84d145905604cf7f6e8869fb7b78059456b71a383/jupytemplate-0.2.1.tar.gz" } ] }