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 >=2,<2.1.0a0, 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.3.0a0.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

jupyter_starters-0.3.0a0-py3-none-any.whl (21.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyter_starters-0.3.0a0.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0.post20200209 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for jupyter_starters-0.3.0a0.tar.gz
Algorithm Hash digest
SHA256 fabaedcd17475fcbd8cc6faa973ea901e7dfb0d55c063696b88721f7ce9e7de7
MD5 62d5ace327e7867ee85b5378c7a77327
BLAKE2b-256 d78a1edce4ad59e3e9aa7960e9e98018af08e240b1e70dc253d886bc394b413a

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: jupyter_starters-0.3.0a0-py3-none-any.whl
  • Upload date:
  • Size: 21.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0.post20200209 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for jupyter_starters-0.3.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 6654b687bf45bf43e258e13d2665f54f38521debdda68f73785d036b61885d82
MD5 e05b561a3d9b3097f00553622916dfef
BLAKE2b-256 6c836c79e4af6b95b60f21d777522d0b60f366c36690a9584e1a8037a7d1aac9

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