# odh-jupyter-trash-cleanup (Python package: odh_jupyter_trash_cleanup)
<!-- CI badge goes here when workflow is available -->
<!-- Binder badge disabled until configured for this repo -->
A JupyterLab extension that lets users empty the Trash from the JupyterLab UI.
This extension is composed of a Python package named `odh_jupyter_trash_cleanup`
for the server extension and an npm package named `odh-jupyter-trash-cleanup`
for the frontend extension.
## How does it work?
When you click the Trash button or use the "Empty Trash" command, all items under the Trash directory are permanently deleted. The Trash location follows the [XDG Base Directory spec](https://specifications.freedesktop.org/basedir-spec/latest/): `$XDG_DATA_HOME/Trash` when `XDG_DATA_HOME` is set; otherwise `~/.local/share/Trash`.
> Warning: Emptying the Trash is irreversible. Items cannot be recovered after this action.
## Requirements
- JupyterLab >= 4.0.0
- Jupyter Server >= 2.0
- Python >= 3.8
## Install
To install the extension, execute:
```bash
pip install odh_jupyter_trash_cleanup
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall odh_jupyter_trash_cleanup
```
## Troubleshoot
If you see 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, verify that the frontend extension is installed:
```bash
jupyter labextension list
```
## Contributing
### Development install
Note: You will need Node.js to build the extension package.
The `jlpm` 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 `jlpm` below.
```bash
# Clone the repo to your local environment
# Change directory to the odh-jupyter-trash-cleanup directory
cd odh-jupyter-trash-cleanup
# Install package in development mode
pip install -e ".[test]"
# 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 odh_jupyter_trash_cleanup
# Rebuild extension Typescript source after making changes
jlpm 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
jlpm 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 `jlpm 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 odh_jupyter_trash_cleanup
pip uninstall odh_jupyter_trash_cleanup
```
In development mode, you will also need to remove the symlink created by the `jupyter labextension develop`
command. To find its location, run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `odh-jupyter-trash-cleanup` within that folder.
### Testing the extension
#### Server tests
This extension is using [Pytest](https://docs.pytest.org/) for Python code testing.
Install test dependencies (needed only once):
```sh
pip install -e ".[test]"
# Each time you install the Python package, you need to restore the front-end extension link
jupyter labextension develop . --overwrite
```
To execute them, run:
```sh
pytest -vv -r ap --cov odh_jupyter_trash_cleanup
```
#### Frontend tests
This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
To execute them, execute:
```sh
jlpm
jlpm test
```
#### Integration tests
This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user-level tests).
More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
More information is provided within the [ui-tests](./ui-tests/README.md) README.
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "odh-jupyter-trash-cleanup",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": "odh",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/76/e9/0c59b5cb4ee54edb49166afbfe33a8964f01821cabd32efd63d0fb5648f2/odh_jupyter_trash_cleanup-0.1.0.tar.gz",
"platform": null,
"description": "# odh-jupyter-trash-cleanup (Python package: odh_jupyter_trash_cleanup)\n\n<!-- CI badge goes here when workflow is available -->\n<!-- Binder badge disabled until configured for this repo -->\n\nA JupyterLab extension that lets users empty the Trash from the JupyterLab UI.\n\nThis extension is composed of a Python package named `odh_jupyter_trash_cleanup`\nfor the server extension and an npm package named `odh-jupyter-trash-cleanup`\nfor the frontend extension.\n\n## How does it work?\n\nWhen you click the Trash button or use the \"Empty Trash\" command, all items under the Trash directory are permanently deleted. The Trash location follows the [XDG Base Directory spec](https://specifications.freedesktop.org/basedir-spec/latest/): `$XDG_DATA_HOME/Trash` when `XDG_DATA_HOME` is set; otherwise `~/.local/share/Trash`.\n\n> Warning: Emptying the Trash is irreversible. Items cannot be recovered after this action.\n\n## Requirements\n\n- JupyterLab >= 4.0.0\n- Jupyter Server >= 2.0\n- Python >= 3.8\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install odh_jupyter_trash_cleanup\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall odh_jupyter_trash_cleanup\n```\n\n## Troubleshoot\n\nIf you see 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, verify that the frontend extension is installed:\n\n```bash\njupyter labextension list\n```\n\n## Contributing\n\n### Development install\n\nNote: You will need Node.js to build the extension package.\n\nThe `jlpm` 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 `jlpm` below.\n\n```bash\n# Clone the repo to your local environment\n# Change directory to the odh-jupyter-trash-cleanup directory\ncd odh-jupyter-trash-cleanup\n# Install package in development mode\npip install -e \".[test]\"\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 odh_jupyter_trash_cleanup\n# Rebuild extension Typescript source after making changes\njlpm 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\njlpm 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 `jlpm 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 odh_jupyter_trash_cleanup\npip uninstall odh_jupyter_trash_cleanup\n```\n\nIn development mode, you will also need to remove the symlink created by the `jupyter labextension develop`\ncommand. To find its location, run `jupyter labextension list` to figure out where the `labextensions`\nfolder is located. Then you can remove the symlink named `odh-jupyter-trash-cleanup` within that folder.\n\n### Testing the extension\n\n#### Server tests\n\nThis extension is using [Pytest](https://docs.pytest.org/) for Python code testing.\n\nInstall test dependencies (needed only once):\n\n```sh\npip install -e \".[test]\"\n# Each time you install the Python package, you need to restore the front-end extension link\njupyter labextension develop . --overwrite\n```\n\nTo execute them, run:\n\n```sh\npytest -vv -r ap --cov odh_jupyter_trash_cleanup\n```\n\n#### Frontend tests\n\nThis extension is using [Jest](https://jestjs.io/) for JavaScript code testing.\n\nTo execute them, execute:\n\n```sh\njlpm\njlpm test\n```\n\n#### Integration tests\n\nThis extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user-level tests).\nMore precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.\n\nMore information is provided within the [ui-tests](./ui-tests/README.md) README.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/opendatahub-io/odh-ide-extensions/issues",
"Homepage": "https://github.com/opendatahub-io/odh-ide-extensions/tree/main/odh-jupyter-trash-cleanup",
"Repository": "https://github.com/opendatahub-io/odh-ide-extensions.git"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9ac0dc3c91367e6405b7a2a8ed0f5ad1e7f524ba171c9ee353e02c0e0e4280ab",
"md5": "762fe9b318ad4108d18882efcc60b0d2",
"sha256": "586baa432bee32027b42350cec2d1f6d283fe77c22bb3e852a816230ecdfb441"
},
"downloads": -1,
"filename": "odh_jupyter_trash_cleanup-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "762fe9b318ad4108d18882efcc60b0d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 49009,
"upload_time": "2025-09-02T19:28:00",
"upload_time_iso_8601": "2025-09-02T19:28:00.501819Z",
"url": "https://files.pythonhosted.org/packages/9a/c0/dc3c91367e6405b7a2a8ed0f5ad1e7f524ba171c9ee353e02c0e0e4280ab/odh_jupyter_trash_cleanup-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "76e90c59b5cb4ee54edb49166afbfe33a8964f01821cabd32efd63d0fb5648f2",
"md5": "26b97bbe00745d00e8fe2e94f6eb86df",
"sha256": "ded78615bd084ba0649979f1b518c9c48f4c859b0f8bc119ca04517031e4378d"
},
"downloads": -1,
"filename": "odh_jupyter_trash_cleanup-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "26b97bbe00745d00e8fe2e94f6eb86df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 43287,
"upload_time": "2025-09-02T19:28:01",
"upload_time_iso_8601": "2025-09-02T19:28:01.910063Z",
"url": "https://files.pythonhosted.org/packages/76/e9/0c59b5cb4ee54edb49166afbfe33a8964f01821cabd32efd63d0fb5648f2/odh_jupyter_trash_cleanup-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-02 19:28:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "opendatahub-io",
"github_project": "odh-ide-extensions",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "odh-jupyter-trash-cleanup"
}
JSON
