Skip to main content

Jupyter Server extension providing an implementation of the File ID service.

Project description

jupyter_server_fileid

Github Actions Status

A Jupyter Server extension providing an implementation of the File ID service.

Requirements

  • Jupyter Server

Install

To install the extension, execute:

pip install jupyter_server_fileid

Uninstall

To remove the extension, execute:

pip uninstall jupyter_server_fileid

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

Contributing

Development install

# Clone the repo to your local environment
# Change directory to the jupyter_server_fileid directory
# Install package in development mode - will automatically enable
# The server extension.
pip install -e .

You can watch the source directory and run your Jupyter Server-based application at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension. For example, when running JupyterLab:

jupyter lab --autoreload

If your extension does not depend a particular frontend, you can run the server directly:

jupyter server --autoreload

Running Tests

Install dependencies:

pip install -e ".[test]"

To run the python tests, use:

pytest

# To test a specific file
pytest jupyter_server_fileid/tests/test_handlers.py

# To run a specific test
pytest jupyter_server_fileid/tests/test_handlers.py -k "test_get"

Development uninstall

pip uninstall jupyter_server_fileid

Packaging the extension

See RELEASE

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_server_fileid-0.9.3.tar.gz (55.0 kB view details)

Uploaded Source

Built Distribution

jupyter_server_fileid-0.9.3-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_server_fileid-0.9.3.tar.gz.

File metadata

  • Download URL: jupyter_server_fileid-0.9.3.tar.gz
  • Upload date:
  • Size: 55.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for jupyter_server_fileid-0.9.3.tar.gz
Algorithm Hash digest
SHA256 521608bb87f606a8637fcbdce2f3d24a8b3cc89d2eef61751cb40e468d4e54be
MD5 70623eaccec738c299cfdc355e9fcb89
BLAKE2b-256 0deb7c2c09454bbf66b3727ba8c431d16159d642c0eb1aa179412a4f7af721cf

See more details on using hashes here.

Provenance

File details

Details for the file jupyter_server_fileid-0.9.3-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_server_fileid-0.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f73c01c19f90005d3fff93607b91b4955ba4e1dccdde9bfe8026646f94053791
MD5 bd6357ec7bd3d95d9ca1746eec689bec
BLAKE2b-256 54d65e5bca083664b1dd368e261107cbe2d350e3bdc62bdba8720fdbb9b9db39

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