Skip to main content

Parametrized starter files and folders for Jupyter

Project description

jupyterlab-starters

Parameterized file and directory starters for JupyterLab.

releases deps ci demo docs
pypi-badge npm-badge license-badge python-badge jupyterlab-badge ci-badge binder-badge docs-badge roadmap-badge changelog-badge

screenshot

What's a starter?

A starter is a...

  • single file
  • directory
  • python function
  • cookiecutter
  • notebook

... that creates a...

  • single file
  • directory of files (or more directories)

... that shows up where you want it in JupyterLab at the click of a button

Installing

You'll need jupyterlab >=1,<2, python >=3.6, and nodejs >=8

pip install --pre jupyter_starters
jupyter labextension install @deathbeds/jupyterlab-starters

Configuring

Like the Jupyter Notebook server, JupyterHub and other Jupyter interactive computing tools, jupyter-starters can be configured via Python or JSON files in well-known locations. You can find out where to put them on your system with:

jupyter --paths

They will be merged from bottom to top, and the directory where you launch your notebook server wins, making it easy to check in to version control.

The very simplest starter, copy, will copy a file or folder to the location it is launched from in the JupyterLab Launcher.

{
  "StarterManager": {
    "extra_starters": {
      "whitepaper-single": {
        "type": "copy",
        "label": "Whitepaper Notebook",
        "description": "A reusable notebook for proposing research",
        "src": "examples/whitepaper-single.ipynb"
      }
    }
  }
}

more docs TBD: for now, see examples in the demo configuration.

Alternatives

Don't like what you see here? Try these other approaches:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter_starters-0.2.2a0.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

jupyter_starters-0.2.2a0-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_starters-0.2.2a0.tar.gz.

File metadata

  • Download URL: jupyter_starters-0.2.2a0.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0.post20200102 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.6

File hashes

Hashes for jupyter_starters-0.2.2a0.tar.gz
Algorithm Hash digest
SHA256 8773e03f8e05532197aa16f4a634bb3d1f8fe858658a7f20bf64879fd78e367f
MD5 154ad719af72072930700e45a7f8b80f
BLAKE2b-256 427c93a2da8e53e562014a6c11acfadeb0807f98d67fc7b248d035f8d929bbc8

See more details on using hashes here.

Provenance

File details

Details for the file jupyter_starters-0.2.2a0-py3-none-any.whl.

File metadata

  • Download URL: jupyter_starters-0.2.2a0-py3-none-any.whl
  • Upload date:
  • Size: 21.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0.post20200102 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.6

File hashes

Hashes for jupyter_starters-0.2.2a0-py3-none-any.whl
Algorithm Hash digest
SHA256 d6d0823f0812fc352ad3f67fc4cf4901b5e9e9c85d0e30a83a9096457a4a9b72
MD5 f03a2a59f6899c14999ac66c13f383ec
BLAKE2b-256 f96fa1d20698e5a25b0efb3a11e56449182f29e50c511d5099ddd7875ae6a80f

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page