https://github.com/jupyter-server/jupyter_server_fileid
An extension that maintains file IDs for documents in a running Jupyter Server
https://github.com/jupyter-server/jupyter_server_fileid
jupyter jupyter-server jupyter-server-extension
Last synced: 4 months ago
JSON representation
An extension that maintains file IDs for documents in a running Jupyter Server
- Host: GitHub
- URL: https://github.com/jupyter-server/jupyter_server_fileid
- Owner: jupyter-server
- License: bsd-3-clause
- Created: 2022-09-01T17:53:03.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T05:08:44.000Z (about 1 year ago)
- Last Synced: 2024-04-13T15:36:57.056Z (about 1 year ago)
- Topics: jupyter, jupyter-server, jupyter-server-extension
- Language: Python
- Homepage: https://jupyter-server-fileid.readthedocs.io/
- Size: 118 KB
- Stars: 3
- Watchers: 10
- Forks: 10
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# jupyter_server_fileid
[](https://github.com/jupyter-server/jupyter_server_fileid/actions/workflows/build.yml)
A Jupyter Server extension providing an implementation of the File ID service.
## Requirements
- Jupyter Server
## Install
To install the extension, execute:
```bash
pip install jupyter_server_fileid
```
## Uninstall
To remove the extension, execute:
```bash
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:
```bash
jupyter server extension list
```
## Contributing
### Development install
```bash
# 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:
```bash
jupyter lab --autoreload
```
If your extension does not depend a particular frontend, you can run the
server directly:
```bash
jupyter server --autoreload
```
### Running Tests
Install dependencies:
```bash
pip install -e ".[test]"
```
To run the python tests, use:
```bash
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
```bash
pip uninstall jupyter_server_fileid
```
### Packaging the extension
See [RELEASE](RELEASE.md)