{"id":16505571,"url":"https://github.com/davidbrochart/jupyterlab-remote-contents","last_synced_at":"2025-10-28T01:30:18.602Z","repository":{"id":191182149,"uuid":"684176934","full_name":"davidbrochart/jupyterlab-remote-contents","owner":"davidbrochart","description":null,"archived":false,"fork":false,"pushed_at":"2023-08-30T10:27:17.000Z","size":134,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-14T16:21:46.953Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/davidbrochart.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-28T16:01:12.000Z","updated_at":"2024-06-11T17:07:01.460Z","dependencies_parsed_at":"2024-06-11T17:21:40.690Z","dependency_job_id":null,"html_url":"https://github.com/davidbrochart/jupyterlab-remote-contents","commit_stats":null,"previous_names":["davidbrochart/jupyterlab-remote-contents"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidbrochart%2Fjupyterlab-remote-contents","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidbrochart%2Fjupyterlab-remote-contents/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidbrochart%2Fjupyterlab-remote-contents/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidbrochart%2Fjupyterlab-remote-contents/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/davidbrochart","download_url":"https://codeload.github.com/davidbrochart/jupyterlab-remote-contents/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238579134,"owners_count":19495501,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-11T15:12:28.956Z","updated_at":"2025-10-28T01:30:18.215Z","avatar_url":"https://github.com/davidbrochart.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jupyterlab-remote-contents\n\n[lite-badge]: https://jupyterlite.rtfd.io/en/latest/_static/badge.svg\n[lite]: https://jupyterlab-remote-contents.readthedocs.io/en/latest/lite/lab\n[docs-badge]: https://readthedocs.org/projects/jupyterlab-remote-contents/badge/?version=latest\n[docs]: https://jupyterlab-remote-contents.readthedocs.io/en/latest/?badge=latest\n\nBrowse remote files using the Jupyter contents API. This is the default for JupyterLab, but not for JupyterLite\nwhich uses the browser's local storage. This extension allows to access remote files served by a Jupyter server.\n\n## Requirements\n\n- JupyterLab \u003e= 4.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install jupyterlab-remote-contents\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyterlab-remote-contents\n```\n\n## Usage\n\nIn JupyterLab, click on the list icon \"Remote Contents (not connected)\" on the left panel, then click on the folder icon \"Connect to Jupyter Server\".\nYou should be prompted to enter the Jupyter server URL. Enter e.g. \"http://127.0.0.1:8000/?token=87b...\" (don't forget the token if you have one). If you hover over the icon on the left panel, you should now see something like \"Remote Contents at http://127.0.0.1:8000/\" (instead of \"not connected\").\n\n## CORS\n\nSince remote contents are fetched from another origin than the client's, you may run into\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) issues.\nThe Jupyter server serving the remote contents API must support the client's origin.\n\nFor instance, if you launch JupyterLab with:\n\n```bash\njupyter lab --ServerApp.ip='127.0.0.1' --ServerApp.port=8888\n```\n\nThen do the following, depending on whether you use\n[jupyter-server](https://github.com/jupyter-server/jupyter_server) or\n[jupyverse](https://github.com/jupyter-server/jupyverse) to serve the contents API.\n\n### jupyter-server\n\n```bash\n# pip install jupyter-server\njupyter server --ServerApp.ip='127.0.0.1' --ServerApp.port=8000 --ServerApp.allow_origin='http://127.0.0.1:8888'\n```\n\n### jupyverse\n\n```bash\n# pip install fps-contents fps-auth fps-frontend\njupyverse --host 127.0.0.1 --port 8000 --allow-origin http://127.0.0.1:8888\n```\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS 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 jupyterlab-remote-contents 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# 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\npip uninstall jupyterlab-remote-contents\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 `jupyterlab-remote-contents` within that folder.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidbrochart%2Fjupyterlab-remote-contents","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavidbrochart%2Fjupyterlab-remote-contents","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidbrochart%2Fjupyterlab-remote-contents/lists"}