{"id":39437394,"url":"https://github.com/jtpio/jupyterlite-server-contents","last_synced_at":"2026-01-20T16:30:46.848Z","repository":{"id":331129939,"uuid":"1125443609","full_name":"jtpio/jupyterlite-server-contents","owner":"jtpio","description":"Access Jupyter Server contents from JupyterLite","archived":false,"fork":false,"pushed_at":"2025-12-30T19:16:44.000Z","size":419,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-18T14:23:15.275Z","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/jtpio.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-12-30T18:28:48.000Z","updated_at":"2026-01-04T06:51:12.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jtpio/jupyterlite-server-contents","commit_stats":null,"previous_names":["jtpio/jupyterlite-server-contents"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/jtpio/jupyterlite-server-contents","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtpio%2Fjupyterlite-server-contents","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtpio%2Fjupyterlite-server-contents/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtpio%2Fjupyterlite-server-contents/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtpio%2Fjupyterlite-server-contents/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jtpio","download_url":"https://codeload.github.com/jtpio/jupyterlite-server-contents/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtpio%2Fjupyterlite-server-contents/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28607172,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T16:10:39.856Z","status":"ssl_error","status_checked_at":"2026-01-20T16:10:39.493Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2026-01-18T04:15:04.240Z","updated_at":"2026-01-20T16:30:46.826Z","avatar_url":"https://github.com/jtpio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jupyterlite-server-contents\n\n[![Github Actions Status](https://github.com/jtpio/jupyterlite-server-contents/workflows/Build/badge.svg)](https://github.com/jtpio/jupyterlite-server-contents/actions/workflows/build.yml)\n\nThis extension replaces JupyterLite's default in-browser storage with a remote Jupyter server's contents API, allowing JupyterLite to read and write files on a real Jupyter server.\n\n![a screenshot of the extension](./screenshot.png)\n\n## Requirements\n\n- JupyterLab \u003e= 4.0.0\n\n## Configuration\n\nThis extension reads configuration from JupyterLite's PageConfig. Set the following options to connect to a remote Jupyter server:\n\n- `serverContentsBaseUrl`: The base URL of the remote Jupyter server (e.g., `http://localhost:8888/`)\n- `serverContentsToken`: The authentication token for the remote server\n\n### Example Configuration\n\nIn your JupyterLite deployment, add the configuration to `jupyter-lite.json`:\n\n```json\n{\n  \"jupyter-config-data\": {\n    \"serverContentsBaseUrl\": \"http://localhost:8888/\",\n    \"serverContentsToken\": \"my-token\",\n    \"disabledExtensions\": [\"@jupyterlite/services-extension:default-drive\"]\n  }\n}\n```\n\n## Running Locally\n\n### 1. Install development dependencies\n\n```bash\npip install -e \".[dev]\"\n```\n\n### 2. Start a Jupyter server\n\nIn a separate terminal, start a Jupyter server that will serve the contents:\n\n```bash\njupyter server --ServerApp.token=my-token --ServerApp.allow_origin='*'\n```\n\nNote: The `--ServerApp.allow_origin='*'` flag is required to allow cross-origin requests from JupyterLite.\n\n### 3. Build JupyterLite\n\nA `jupyter-lite.json` configuration file is included in this repo. Then build and serve JupyterLite:\n\n```bash\njupyter lite build\njupyter lite serve\n```\n\n### 4. Access JupyterLite\n\nOpen your browser to the URL shown by `jupyter lite serve` (typically `http://localhost:8000`). The default file browser will show files from the remote Jupyter server.\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install jupyterlite_server_contents\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyterlite_server_contents\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 jupyterlite_server_contents directory\n\n# Set up a virtual environment and install package in development mode\npython -m venv .venv\nsource .venv/bin/activate\npip install --editable \".\"\n\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n\n# Rebuild extension Typescript source after making changes\n# IMPORTANT: Unlike the steps above which are performed only once, do this step\n# every time you make a change.\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 jupyterlite_server_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 `jupyterlite-server-contents` within that folder.\n\n## AI Coding Assistant Support\n\nThis project includes an `AGENTS.md` file with coding standards and best practices for JupyterLab extension development. The file follows the [AGENTS.md standard](https://agents.md) for cross-tool compatibility.\n\n### Compatible AI Tools\n\n`AGENTS.md` works with AI coding assistants that support the standard, including Cursor, GitHub Copilot, Windsurf, Aider, and others. For a current list of compatible tools, see [the AGENTS.md standard](https://agents.md).\nThis project also includes symlinks for tool-specific compatibility:\n\n- `CLAUDE.md` → `AGENTS.md` (for Claude Code)\n\nOther conventions you might encounter:\n\n- `.cursorrules` - Cursor's YAML/JSON format (Cursor also supports AGENTS.md natively)\n- `CONVENTIONS.md` / `CONTRIBUTING.md` - For CodeConventions.ai and GitHub bots\n- Project-specific rules in JetBrains AI Assistant settings\n\nAll tool-specific files should be symlinks to `AGENTS.md` as the single source of truth.\n\n### What's Included\n\nThe `AGENTS.md` file provides guidance on:\n\n- Code quality rules and file-scoped validation commands\n- Naming conventions for packages, plugins, and files\n- Coding standards (TypeScript)\n- Development workflow and debugging\n- Common pitfalls and how to avoid them\n\n### Customization\n\nYou can edit `AGENTS.md` to add project-specific conventions or adjust guidelines to match your team's practices. The file uses plain Markdown with Do/Don't patterns and references to actual project files.\n\n**Note**: `AGENTS.md` is living documentation. Update it when you change conventions, add dependencies, or discover new patterns. Include `AGENTS.md` updates in commits that modify workflows or coding standards.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjtpio%2Fjupyterlite-server-contents","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjtpio%2Fjupyterlite-server-contents","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjtpio%2Fjupyterlite-server-contents/lists"}