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
  • 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.1.0a1.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

jupyter_starters-0.1.0a1-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_starters-0.1.0a1.tar.gz.

File metadata

  • Download URL: jupyter_starters-0.1.0a1.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2.post20191201 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.3

File hashes

Hashes for jupyter_starters-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 49a0fa71aab33ae365d8e449494d99b88e175679482f5baaf8ea0816b2bfab84
MD5 2f898f7cc21fce75af1b72c84f227d0c
BLAKE2b-256 f934377b2015c79c1f5b54e62f552f488f66cf8aa54ba6994f9635430bcd3e19

See more details on using hashes here.

Provenance

File details

Details for the file jupyter_starters-0.1.0a1-py3-none-any.whl.

File metadata

  • Download URL: jupyter_starters-0.1.0a1-py3-none-any.whl
  • Upload date:
  • Size: 13.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2.post20191201 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.3

File hashes

Hashes for jupyter_starters-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 2fd3afde78df2319613aa9f61b05a29d0622141baa220ce5ad39b9ff1432328f
MD5 e13250890e83a5b805eb72c02f10a112
BLAKE2b-256 eba5bfb7a85defff40e25fe78f2f188d960ac930356e617b496423a75a38ac47

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