{ "info": { "author": "Lumicks B.V.", "author_email": "devteam@lumicks.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Framework :: Jupyter", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3 :: Only", "Topic :: Scientific/Engineering" ], "description": "# nbkickoff\n\nLaunch an IPython Notebook from a template notebook file.\n\n\n## Requirements\n\nTested with:\n\n* Jupyter Notebook 5.5 (or higher)\n* Python 3.6\n\nShould also work with other Python 3.x versions.\n\n\n## Installation\n\nFor general use, you can install `nbkickoff` using _pip_:\n\n pip install nbkickoff\n\nTo upgrade to the latest version:\n\n pip install -U nbkickoff\n\nFor local development:\n\n git clone https://github.com/lumicks/nbkickoff.git\n cd nbkickoff\n pip install -e .\n\n\n## Usage\n\nInvoke using either the full:\n\n python -m nbkickoff TEMPLATEFILE TARGETFILE [VAR=VALUE [VAR2=VALUE ...]]\n\nOr, if the corresponding entry point script is on the `PATH`, the shorter version:\n\n nbkickoff TEMPLATEFILE TARGETFILE [VAR=VALUE [VAR2=VALUE ...]]\n\nHere, `TEMPLATEFILE` is an IPython Notebook file that functions as a template. This file is copied to `TARGETFILE` (which must not exist yet), after which all variables in the notebook's cells are substituted with their corresponding values.\n\nSo, if your template notebook contains a cell with the text:\n\n my_python_var = '{{ foo }}'\n\nand you invoke `nbkickoff` using:\n\n nbkickoff template.ipynb my_notebook.ipynb foo=bar\n\nThen your shiny new notebook will have a cell containing:\n\n my_python_var = 'bar'\n\nIf a suitable Jupyter server process is already running, `nbkickoff` opens the new notebook in the existing server. Otherwise, a new Jupyter server process is started. This behavior is based on that of the [_nbopen_ tool](https://github.com/takluyver/nbopen/), with the notable change that `nbkickoff` always returns immediately; any newly spawned Jupyter server process is detached.\n\n\n\n", "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/lumicks/nbkickoff", "keywords": "", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "nbkickoff", "package_url": "https://pypi.org/project/nbkickoff/", "platform": "", "project_url": "https://pypi.org/project/nbkickoff/", "project_urls": { "Homepage": "https://github.com/lumicks/nbkickoff" }, "release_url": "https://pypi.org/project/nbkickoff/0.1.0/", "requires_dist": [ "notebook (>=5.5.0)", "nbformat (>=4.4)" ], "requires_python": ">=3", "summary": "Launch an IPython Notebook from a template notebook file", "version": "0.1.0" }, "last_serial": 3964553, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "530653058d4616a7b2acb5acd050079e", "sha256": "f350894de9ba1895a4c10caed01fb4b358ced01e4559306805b9074d1f26f33b" }, "downloads": -1, "filename": "nbkickoff-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "530653058d4616a7b2acb5acd050079e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 9068, "upload_time": "2018-06-15T12:16:55", "url": "https://files.pythonhosted.org/packages/b2/6a/46a7121bd7f73fcf83863e4949f6dc8628f531a0e9dffd446b87efaa92fd/nbkickoff-0.1.0-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "530653058d4616a7b2acb5acd050079e", "sha256": "f350894de9ba1895a4c10caed01fb4b358ced01e4559306805b9074d1f26f33b" }, "downloads": -1, "filename": "nbkickoff-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "530653058d4616a7b2acb5acd050079e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 9068, "upload_time": "2018-06-15T12:16:55", "url": "https://files.pythonhosted.org/packages/b2/6a/46a7121bd7f73fcf83863e4949f6dc8628f531a0e9dffd446b87efaa92fd/nbkickoff-0.1.0-py3-none-any.whl" } ] }