| Name | fileglancer JSON |
| Version |
0.5.1
JSON |
| download |
| home_page | None |
| Summary | Browse, share, and publish files on the Janelia file system |
| upload_time | 2025-07-28 22:37:26 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | BSD 3-Clause License
Copyright (c) 2025, allison-truhlar
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.
|
# Fileglancer frontend extension
[](https://github.com/JaneliaSciComp/fileglancer/actions/workflows/build.yml)
[](https://mybinder.org/v2/gh/JaneliaSciComp/fileglancer/main?urlpath=lab)
React-based frontend extension for the Fileglancer app.
## Development install
Clone the repo to your local environment and change directory to the new repo folder.
```bash
git clone git@github.com:JaneliaSciComp/fileglancer.git
cd fileglancer
```
Copy the .env example and edit the environmental variable values for your setup:
```bash
cp .env.example .env
```
If this is your first time installing the extension in dev mode, install package in development mode.
```bash
pixi run dev-install
```
You can build the frontend extension in watch mode - it will automatically rebuild when there are file changes to the frontend:
```bash
pixi run dev-watch
```
In new terminal, run JupyterLab in autoreload mode - it will automatically rebuild when there are file changes to the backend:
```bash
pixi run dev-launch
```
Saved changes in your directory should now be automatically 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).
If everything has worked so far, you should see the Fileglancer widget on the Launcher pane:
### Troubleshooting the extension
If you run into any build issues, the first thing to try is to clear the build directories and start from scratch:
```bash
./clean.sh
```
If you're still having issues, try manually deleting the symlink at `.pixi/envs/share/jupyter/labextensions/fileglancer` inside the fileglancer repo directory. Then, reinstall the extension using `pixi run dev-install`, and follow the steps above from there.
## Configuration
By default, no [Fileglancer Central](https://github.com/JaneliaSciComp/fileglancer-central) server will be used.
You can configure the URL of a Fileglancer Central server with traitlets, in several ways:
### Command line
```bash
pixi run dev-launch --Fileglancer.central_url=http://0.0.0.0:7878
```
### Config file
You can create a file at `~/.jupyter/jupyter_server_config.py` (or in any of the paths reported by `pixi run jupyter --paths`) and add your configuration there, e.g.:
```python
c.Fileglancer.central_url='http://0.0.0.0:7878'
```
## Development Uninstall
```bash
pixi run pip-uninstall
```
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 `fileglancer` within that folder.
## Testing
### Backend tests
To run backend tests using pytest:
```bash
pixi run test-backend
```
### Frontend unit tests
This extension is using [Vitest](https://vitest.dev/) for JavaScript code testing.
To execute the unit tests:
```bash
pixi run test-frontend
```
### 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 are provided within the [ui-tests](./ui-tests/README.md) README.
To execute the UI integration test, run:
```bash
pixi run ui-test
```
You can also run these in headed or debug mode using:
```bash
pixi run ui-test -- --headed --debug
```
or to run only a specific test:
```bash
pixi run ui-test -- --headed tests/fgzones.spec.ts
```
You can also use the name of the test:
```bash
pixi run ui-test -- -g "the test description"
```
## Packaging and Releases
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "fileglancer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": null,
"author_email": "Allison Truhlar <truhlara@janelia.hhmi.org>, Jody Clements <clementsj@janelia.hhmi.org>, Cristian Goina <goinac@janelia.hhmi.org>, Konrad Rokicki <rokickik@janelia.hhmi.org>",
"download_url": "https://files.pythonhosted.org/packages/db/89/5262e7cc21d431d9ac6d3a768eae1e4b5e9629af59f0cceca49f36029051/fileglancer-0.5.1.tar.gz",
"platform": null,
"description": "# Fileglancer frontend extension\n\n[](https://github.com/JaneliaSciComp/fileglancer/actions/workflows/build.yml)\n[](https://mybinder.org/v2/gh/JaneliaSciComp/fileglancer/main?urlpath=lab)\n\nReact-based frontend extension for the Fileglancer app.\n\n## Development install\n\nClone the repo to your local environment and change directory to the new repo folder.\n\n```bash\ngit clone git@github.com:JaneliaSciComp/fileglancer.git\ncd fileglancer\n```\n\nCopy the .env example and edit the environmental variable values for your setup:\n\n```bash\ncp .env.example .env\n```\n\nIf this is your first time installing the extension in dev mode, install package in development mode.\n\n```bash\npixi run dev-install\n```\n\nYou can build the frontend extension in watch mode - it will automatically rebuild when there are file changes to the frontend:\n\n```bash\npixi run dev-watch\n```\n\nIn new terminal, run JupyterLab in autoreload mode - it will automatically rebuild when there are file changes to the backend:\n\n```bash\npixi run dev-launch\n```\n\nSaved changes in your directory should now be automatically 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\nIf everything has worked so far, you should see the Fileglancer widget on the Launcher pane:\n\n\n\n### Troubleshooting the extension\n\nIf you run into any build issues, the first thing to try is to clear the build directories and start from scratch:\n\n```bash\n./clean.sh\n```\n\nIf you're still having issues, try manually deleting the symlink at `.pixi/envs/share/jupyter/labextensions/fileglancer` inside the fileglancer repo directory. Then, reinstall the extension using `pixi run dev-install`, and follow the steps above from there.\n\n## Configuration\n\nBy default, no [Fileglancer Central](https://github.com/JaneliaSciComp/fileglancer-central) server will be used.\nYou can configure the URL of a Fileglancer Central server with traitlets, in several ways:\n\n### Command line\n\n```bash\npixi run dev-launch --Fileglancer.central_url=http://0.0.0.0:7878\n```\n\n### Config file\n\nYou can create a file at `~/.jupyter/jupyter_server_config.py` (or in any of the paths reported by `pixi run jupyter --paths`) and add your configuration there, e.g.:\n\n```python\nc.Fileglancer.central_url='http://0.0.0.0:7878'\n```\n\n## Development Uninstall\n\n```bash\npixi run pip-uninstall\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 `fileglancer` within that folder.\n\n## Testing\n\n### Backend tests\n\nTo run backend tests using pytest:\n\n```bash\npixi run test-backend\n```\n\n### Frontend unit tests\n\nThis extension is using [Vitest](https://vitest.dev/) for JavaScript code testing.\n\nTo execute the unit tests:\n\n```bash\npixi run test-frontend\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.\nMore information are provided within the [ui-tests](./ui-tests/README.md) README.\n\nTo execute the UI integration test, run:\n\n```bash\npixi run ui-test\n```\n\nYou can also run these in headed or debug mode using:\n\n```bash\npixi run ui-test -- --headed --debug\n```\n\nor to run only a specific test:\n\n```bash\npixi run ui-test -- --headed tests/fgzones.spec.ts\n```\n\nYou can also use the name of the test:\n\n```bash\npixi run ui-test -- -g \"the test description\"\n```\n\n## Packaging and Releases\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) 2025, allison-truhlar\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": "Browse, share, and publish files on the Janelia file system",
"version": "0.5.1",
"project_urls": {
"Bug Tracker": "https://github.com/JaneliaSciComp/fileglancer/issues",
"Homepage": "https://github.com/JaneliaSciComp/fileglancer",
"Repository": "https://github.com/JaneliaSciComp/fileglancer.git"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "37303958e0ef45404e461b5316d92011b31052df8863fadeb259af724881b1d4",
"md5": "e57fe46302ca2b0930076758cd769c1a",
"sha256": "9b1e43821cb4cc80c4300d964cc87ed94398bf330ab23c52648064aab749bb77"
},
"downloads": -1,
"filename": "fileglancer-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e57fe46302ca2b0930076758cd769c1a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3767460,
"upload_time": "2025-07-28T22:37:25",
"upload_time_iso_8601": "2025-07-28T22:37:25.126031Z",
"url": "https://files.pythonhosted.org/packages/37/30/3958e0ef45404e461b5316d92011b31052df8863fadeb259af724881b1d4/fileglancer-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "db895262e7cc21d431d9ac6d3a768eae1e4b5e9629af59f0cceca49f36029051",
"md5": "fd270226b23541ec7775750b37fdf4c3",
"sha256": "a86999d3cfbe0419051c8ba12996b87db064a3d19cc723e355f3e3246b302261"
},
"downloads": -1,
"filename": "fileglancer-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "fd270226b23541ec7775750b37fdf4c3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4326190,
"upload_time": "2025-07-28T22:37:26",
"upload_time_iso_8601": "2025-07-28T22:37:26.828803Z",
"url": "https://files.pythonhosted.org/packages/db/89/5262e7cc21d431d9ac6d3a768eae1e4b5e9629af59f0cceca49f36029051/fileglancer-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-28 22:37:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JaneliaSciComp",
"github_project": "fileglancer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fileglancer"
}
