{"id":14977412,"url":"https://github.com/lumicks/nbkickoff","last_synced_at":"2025-03-02T04:29:42.668Z","repository":{"id":57445120,"uuid":"137338151","full_name":"lumicks/nbkickoff","owner":"lumicks","description":"Launch an IPython Notebook from a template notebook file","archived":false,"fork":false,"pushed_at":"2020-07-31T14:39:22.000Z","size":11,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-01-12T17:09:52.513Z","etag":null,"topics":["ipython","ipython-notebook","jupyter"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lumicks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-14T09:40:35.000Z","updated_at":"2020-11-15T13:09:20.000Z","dependencies_parsed_at":"2022-09-26T17:30:43.891Z","dependency_job_id":null,"html_url":"https://github.com/lumicks/nbkickoff","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lumicks%2Fnbkickoff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lumicks%2Fnbkickoff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lumicks%2Fnbkickoff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lumicks%2Fnbkickoff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lumicks","download_url":"https://codeload.github.com/lumicks/nbkickoff/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241460036,"owners_count":19966511,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ipython","ipython-notebook","jupyter"],"created_at":"2024-09-24T13:55:36.765Z","updated_at":"2025-03-02T04:29:37.661Z","avatar_url":"https://github.com/lumicks.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flumicks%2Fnbkickoff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flumicks%2Fnbkickoff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flumicks%2Fnbkickoff/lists"}