| Name | jupyter-server-fileid JSON |
| Version |
0.9.2
JSON |
| download |
| home_page | None |
| Summary | Jupyter Server extension providing an implementation of the File ID service. |
| upload_time | 2024-04-18 16:34:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | BSD 3-Clause License Copyright (c) 2022, David L. Qiu All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
extension
jupyter
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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)
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyter-server-fileid",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Extension, Jupyter",
"author": null,
"author_email": "\"David L. Qiu\" <david@qiu.dev>",
"download_url": "https://files.pythonhosted.org/packages/ed/6f/90958ab47e12b607dfa78c1d25e5be489d97ba5ddcb1a1e9981bd46a2515/jupyter_server_fileid-0.9.2.tar.gz",
"platform": null,
"description": "# jupyter_server_fileid\n\n[](https://github.com/jupyter-server/jupyter_server_fileid/actions/workflows/build.yml)\n\nA Jupyter Server extension providing an implementation of the File ID service.\n\n## Requirements\n\n- Jupyter Server\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install jupyter_server_fileid\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyter_server_fileid\n```\n\n## Troubleshoot\n\nIf you are seeing the frontend extension, but it is not working, check\nthat the server extension is enabled:\n\n```bash\njupyter server extension list\n```\n\n## Contributing\n\n### Development install\n\n```bash\n# Clone the repo to your local environment\n# Change directory to the jupyter_server_fileid directory\n# Install package in development mode - will automatically enable\n# The server extension.\npip install -e .\n```\n\n\nYou 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,\nwhen running JupyterLab:\n\n```bash\njupyter lab --autoreload\n```\n\nIf your extension does not depend a particular frontend, you can run the\nserver directly:\n\n```bash\njupyter server --autoreload\n```\n\n### Running Tests\n\nInstall dependencies:\n\n```bash\npip install -e \".[test]\"\n```\n\nTo run the python tests, use:\n\n```bash\npytest\n\n# To test a specific file\npytest jupyter_server_fileid/tests/test_handlers.py\n\n# To run a specific test\npytest jupyter_server_fileid/tests/test_handlers.py -k \"test_get\"\n```\n\n### Development uninstall\n\n```bash\npip uninstall jupyter_server_fileid\n```\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2022, David L. Qiu All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Jupyter Server extension providing an implementation of the File ID service.",
"version": "0.9.2",
"project_urls": {
"Home": "https://github.com/jupyter-server/jupyter_server_fileid"
},
"split_keywords": [
"extension",
" jupyter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3ffdbee81a24415f9b10d3a2408b7b64b895d2773b82cd82c8ea5a0f1cbd54e7",
"md5": "0ae9778ba26485428ff147ecc1709318",
"sha256": "76a2fbcea6950968485dcd509c2d6ac417ca11e61ab1ad447a475f0878ca808f"
},
"downloads": -1,
"filename": "jupyter_server_fileid-0.9.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ae9778ba26485428ff147ecc1709318",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 16811,
"upload_time": "2024-04-18T16:34:50",
"upload_time_iso_8601": "2024-04-18T16:34:50.018487Z",
"url": "https://files.pythonhosted.org/packages/3f/fd/bee81a24415f9b10d3a2408b7b64b895d2773b82cd82c8ea5a0f1cbd54e7/jupyter_server_fileid-0.9.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ed6f90958ab47e12b607dfa78c1d25e5be489d97ba5ddcb1a1e9981bd46a2515",
"md5": "db88899380e5ee823ac09a4c586f4c26",
"sha256": "ffb11460ca5f8567644f6120b25613fca8e3f3048b38d14c6e3fe1902f314a9b"
},
"downloads": -1,
"filename": "jupyter_server_fileid-0.9.2.tar.gz",
"has_sig": false,
"md5_digest": "db88899380e5ee823ac09a4c586f4c26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 54737,
"upload_time": "2024-04-18T16:34:52",
"upload_time_iso_8601": "2024-04-18T16:34:52.136371Z",
"url": "https://files.pythonhosted.org/packages/ed/6f/90958ab47e12b607dfa78c1d25e5be489d97ba5ddcb1a1e9981bd46a2515/jupyter_server_fileid-0.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 16:34:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jupyter-server",
"github_project": "jupyter_server_fileid",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyter-server-fileid"
}
