| Name | urncjp JSON |
| Version |
0.1.7
JSON |
| download |
| home_page | None |
| Summary | Jupyter extension for urnc |
| upload_time | 2025-03-31 11:42:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | BSD 3-Clause License
Copyright (c) 2025, Michael Huttner
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 |
jupyter
jupyterlab
jupyterlab-extension
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# urncjp
[](https://github.com/spang-lab/urncjp.git/actions/workflows/build.yml)
Jupyter extension for urnc
This extension is composed of a Python package named `urncjp`
for the server extension and a NPM package named `urncjp`
for the frontend extension.
## Requirements
- JupyterLab >= 4.0.0
## Install
To install the extension, execute:
```bash
pip install urncjp
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall urncjp
```
## 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
```
If the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:
```bash
jupyter labextension list
```
## Contributing
### Development install
Note: You will need NodeJS to build the extension package.
The `npm run` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `npm run` below.
```bash
# Clone the repo to your local environment
# Change directory to the urncjp directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable urncjp
# Rebuild extension Typescript source after making changes
npm run build
```
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
npm run watch
# Run JupyterLab in another terminal
jupyter lab
```
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the `npm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
```bash
jupyter lab build --minimize=False
```
### Development uninstall
```bash
# Server extension must be manually disabled in develop mode
jupyter server extension disable urncjp
pip uninstall urncjp
```
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `urncjp` within that folder.
### Packaging the extension
The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).
## Manual release
### Python package
This extension can be distributed as Python packages. All of the Python
packaging instructions are in the `pyproject.toml` file to wrap your extension in a
Python package. Before generating a package, you first need to install some tools:
```bash
pip install build twine hatch
```
Bump the version using `hatch`. By default this will create a tag.
See the docs on [hatch-nodejs-version](https://github.com/agoose77/hatch-nodejs-version#semver) for details.
```bash
hatch version <new-version>
```
Make sure to clean up all the development files before building the package:
```bash
npm run clean:all
```
You could also clean up the local git repository:
```bash
git clean -dfX
```
To create a Python source package (`.tar.gz`) and the binary package (`.whl`) in the `dist/` directory, do:
```bash
python -m build
```
> `python setup.py sdist bdist_wheel` is deprecated and will not work for this package.
Then to upload the package to PyPI, do:
```bash
twine upload dist/*
```
### NPM package
To publish the frontend part of the extension as a NPM package, do:
```bash
npm login
npm publish --access public
```
## Automated releases with the Jupyter Releaser
The extension repository should already be compatible with the Jupyter Releaser. But
the GitHub repository and the package managers need to be properly set up. Please
follow the instructions of the Jupyter Releaser [checklist](https://jupyter-releaser.readthedocs.io/en/latest/how_to_guides/convert_repo_from_repo.html).
Here is a summary of the steps to cut a new release:
- Go to the Actions panel
- Run the "Step 1: Prep Release" workflow
- Check the draft changelog
- Run the "Step 2: Publish Release" workflow
> [!NOTE]
> Check out the [workflow documentation](https://jupyter-releaser.readthedocs.io/en/latest/get_started/making_release_from_repo.html)
> for more information.
## Publishing to `conda-forge`
If the package is not on conda forge yet, check the documentation to learn how to add it: https://conda-forge.org/docs/maintainer/adding_pkgs.html
Otherwise a bot should pick up the new version publish to PyPI, and open a new PR on the feedstock repository automatically.
Raw data
{
"_id": null,
"home_page": null,
"name": "urncjp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": null,
"author_email": "Michael Huttner <urnc@mhuttner.com>",
"download_url": "https://files.pythonhosted.org/packages/d5/36/d955d441aa1b0306a51f0dc1140d8e83f1743a577ed5629b12ac50f56b82/urncjp-0.1.7.tar.gz",
"platform": null,
"description": "# urncjp\n\n[](https://github.com/spang-lab/urncjp.git/actions/workflows/build.yml)\n\nJupyter extension for urnc\n\nThis extension is composed of a Python package named `urncjp`\nfor the server extension and a NPM package named `urncjp`\nfor the frontend extension.\n\n## Requirements\n\n- JupyterLab >= 4.0.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install urncjp\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall urncjp\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\nIf the server extension is installed and enabled, but you are not seeing\nthe frontend extension, check the frontend extension is installed:\n\n```bash\njupyter labextension list\n```\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\n\nThe `npm run` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `npm run` below.\n\n```bash\n# Clone the repo to your local environment\n# Change directory to the urncjp directory\n# Install package in development mode\npip install -e \".\"\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Server extension must be manually installed in develop mode\njupyter server extension enable urncjp\n# Rebuild extension Typescript source after making changes\nnpm run build\n```\n\nYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\nnpm run watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).\n\nBy default, the `npm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:\n\n```bash\njupyter lab build --minimize=False\n```\n\n### Development uninstall\n\n```bash\n# Server extension must be manually disabled in develop mode\njupyter server extension disable urncjp\npip uninstall urncjp\n```\n\nIn development mode, you will also need to remove the symlink created by `jupyter labextension develop`\ncommand. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`\nfolder is located. Then you can remove the symlink named `urncjp` within that folder.\n\n### Packaging the extension\n\nThe extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).\n\n## Manual release\n\n### Python package\n\nThis extension can be distributed as Python packages. All of the Python\npackaging instructions are in the `pyproject.toml` file to wrap your extension in a\nPython package. Before generating a package, you first need to install some tools:\n\n```bash\npip install build twine hatch\n```\n\nBump the version using `hatch`. By default this will create a tag.\nSee the docs on [hatch-nodejs-version](https://github.com/agoose77/hatch-nodejs-version#semver) for details.\n\n```bash\nhatch version <new-version>\n```\n\nMake sure to clean up all the development files before building the package:\n\n```bash\nnpm run clean:all\n```\n\nYou could also clean up the local git repository:\n\n```bash\ngit clean -dfX\n```\n\nTo create a Python source package (`.tar.gz`) and the binary package (`.whl`) in the `dist/` directory, do:\n\n```bash\npython -m build\n```\n\n> `python setup.py sdist bdist_wheel` is deprecated and will not work for this package.\n\nThen to upload the package to PyPI, do:\n\n```bash\ntwine upload dist/*\n```\n\n### NPM package\n\nTo publish the frontend part of the extension as a NPM package, do:\n\n```bash\nnpm login\nnpm publish --access public\n```\n\n## Automated releases with the Jupyter Releaser\n\nThe extension repository should already be compatible with the Jupyter Releaser. But\nthe GitHub repository and the package managers need to be properly set up. Please\nfollow the instructions of the Jupyter Releaser [checklist](https://jupyter-releaser.readthedocs.io/en/latest/how_to_guides/convert_repo_from_repo.html).\n\nHere is a summary of the steps to cut a new release:\n\n- Go to the Actions panel\n- Run the \"Step 1: Prep Release\" workflow\n- Check the draft changelog\n- Run the \"Step 2: Publish Release\" workflow\n\n> [!NOTE]\n> Check out the [workflow documentation](https://jupyter-releaser.readthedocs.io/en/latest/get_started/making_release_from_repo.html)\n> for more information.\n\n## Publishing to `conda-forge`\n\nIf the package is not on conda forge yet, check the documentation to learn how to add it: https://conda-forge.org/docs/maintainer/adding_pkgs.html\n\nOtherwise a bot should pick up the new version publish to PyPI, and open a new PR on the feedstock repository automatically.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) 2025, Michael Huttner\n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n 1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n 3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Jupyter extension for urnc",
"version": "0.1.7",
"project_urls": {
"Bug Tracker": "https://github.com/spang-lab/urncjp.git/issues",
"Homepage": "https://github.com/spang-lab/urncjp.git",
"Repository": "https://github.com/spang-lab/urncjp.git.git"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "763fd2c645389a90351fa9482edc0f7ebb56023b41bc7341f4237d71608ee0c1",
"md5": "e318594d130b65ece277259894b6e096",
"sha256": "748059e1d1d624b561bcd183cb37e6ae2a0a31e77a2d1c69ad3fe074febceae9"
},
"downloads": -1,
"filename": "urncjp-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e318594d130b65ece277259894b6e096",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 21563,
"upload_time": "2025-03-31T11:42:05",
"upload_time_iso_8601": "2025-03-31T11:42:05.805351Z",
"url": "https://files.pythonhosted.org/packages/76/3f/d2c645389a90351fa9482edc0f7ebb56023b41bc7341f4237d71608ee0c1/urncjp-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d536d955d441aa1b0306a51f0dc1140d8e83f1743a577ed5629b12ac50f56b82",
"md5": "8589336e0828a79a1185973955edfda9",
"sha256": "b828156529842bc9c57405898694a1888b180f14a09d1cc49a4e1b797cb32678"
},
"downloads": -1,
"filename": "urncjp-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "8589336e0828a79a1185973955edfda9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 74659,
"upload_time": "2025-03-31T11:42:07",
"upload_time_iso_8601": "2025-03-31T11:42:07.366132Z",
"url": "https://files.pythonhosted.org/packages/d5/36/d955d441aa1b0306a51f0dc1140d8e83f1743a577ed5629b12ac50f56b82/urncjp-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-31 11:42:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "spang-lab",
"github_project": "urncjp",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "urncjp"
}
