Skip to main content

Parametrized starter files and folders for Jupyter

Project description

jupyterlab-starters

Parameterized file and directory starters for JupyterLab.

badge-binder badge-ci pypi-badge npm-badge roadmap-badge changelog-badge python-badge jupyterlab-badge license-badge

screenshot

What's a starter?

  • A single file
  • A directory
  • A python function
  • A cookiecutter
    • requires pip install cookiecutter or conda install -c conda-forge cookiecutter
  • A notebook
  • A shell script

... that shows up in your 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 jupyter_notebook_config.json

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.0a0.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

jupyter_starters-0.2.0a0-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyter_starters-0.2.0a0.tar.gz
  • Upload date:
  • Size: 15.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2.post20191201 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.6

File hashes

Hashes for jupyter_starters-0.2.0a0.tar.gz
Algorithm Hash digest
SHA256 977367ae297849d6f35c6e728959d59606285db865d39f530ca1296222e92016
MD5 48f7de25270c83d24f5a645a4628f025
BLAKE2b-256 09ed0c5cefe2608fa9443268f54a1be0736ac7cb402ce4948b5896cf41b68e17

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: jupyter_starters-0.2.0a0-py3-none-any.whl
  • Upload date:
  • Size: 17.9 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/42.0.2.post20191201 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.6

File hashes

Hashes for jupyter_starters-0.2.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 4599368fd1ec7f5a53f395ad6a1a839eeebe1311b5a3728cf72aeb4f76a2de25
MD5 37ba0bf7f92844e9a16ea95f798b47e9
BLAKE2b-256 4420e963927b9ff2a715c393b4cf355beee316c8793c17c6816c6be76aa78388

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