Skip to main content

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 >=3,<4, python >=3.7, and nodejs >=12

pip install --pre jupyter_starters

Check your installation:

jupyter serverextension list
jupyter labextension list

If you don't see jupyterlab_starters run:

jupyter serverextension enable --sys-prefix 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:

Metadata

Release files for jupyter-starters 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jupyter-starters 1.1.0
File Size Uploaded Provenance
jupyter_starters-1.1.0.tar.gz 204.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for jupyter-starters 1.1.0
File Interpreter ABI Platform
jupyter_starters-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 612.8 kB

Release files / jupyter_starters-1.1.0.tar.gz

Download URL jupyter_starters-1.1.0.tar.gz
Size 204.6 kB
Tags Source
SHA-256 checksum
How to use checksums
a99b7ab2cfbabf554837322c52d6810f88b667f6fde8b6a6e124c6779dea1a7c
BLAKE2b-256 checksum
How to use checksums
ec29872f9b5d066d343ee33e6248863cf0c20f5b5dc7ef3a2a9f8fe7fe93affb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/0.0.0 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

Release files / jupyter_starters-1.1.0-py3-none-any.whl

Download URL jupyter_starters-1.1.0-py3-none-any.whl
Size 408.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
99a87575ed8098efe0d5fcd9cf4419972d43f440aa7ac25b600c2b96f5f0c2e8
BLAKE2b-256 checksum
How to use checksums
ca543f1fc07f60d63c81a6e102bbda67aeced208416c11d2e6e6d188f584d589
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/0.0.0 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

Security for jupyter-starters 1.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page