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.1.tar.gz (54.3 kB view hashes)

Uploaded Source

Built Distribution

jupyter_server_fileid-0.9.1-py3-none-any.whl (16.7 kB view hashes)

Uploaded Python 3

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