{"id":16282465,"url":"https://github.com/jtpio/jupyterlite-labextension-example","last_synced_at":"2025-08-24T14:35:47.635Z","repository":{"id":48870779,"uuid":"383890710","full_name":"jtpio/jupyterlite-labextension-example","owner":"jtpio","description":"Example JupyterLab Extension workflow with JupyterLite","archived":false,"fork":false,"pushed_at":"2021-07-08T07:46:57.000Z","size":94,"stargazers_count":4,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-28T22:35:15.376Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-07T18:26:01.000Z","updated_at":"2022-12-09T09:20:14.000Z","dependencies_parsed_at":"2022-09-06T21:40:32.617Z","dependency_job_id":null,"html_url":"https://github.com/jtpio/jupyterlite-labextension-example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtpio%2Fjupyterlite-labextension-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtpio%2Fjupyterlite-labextension-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtpio%2Fjupyterlite-labextension-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtpio%2Fjupyterlite-labextension-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jtpio","download_url":"https://codeload.github.com/jtpio/jupyterlite-labextension-example/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244039202,"owners_count":20387835,"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-10T19:10:45.212Z","updated_at":"2025-03-20T02:30:30.095Z","avatar_url":"https://github.com/jtpio.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JupyterLite Lab Extension Example\n\n![Github Actions Status](https://github.com/jtpio/jupyterlite-labextension-example/workflows/Build/badge.svg)\n\nThis repository demonstrates how to develop a JupyterLab extension with [JupyterLite](https://github.com/jupyterlite/jupyterlite):\n\n- add instructions to use the extension with JupyterLite\n- enable deploy previews on PR using JupyterLite deployed on [Netlify](https://www.netlify.com/)\n\n![image](https://user-images.githubusercontent.com/591645/124813239-eebcb400-df64-11eb-915b-775b792b489c.png)\n\n![image](https://user-images.githubusercontent.com/591645/124816061-59bbba00-df68-11eb-90ef-702df797aa9e.png)\n\n## Requirements\n\n* JupyterLab \u003e= 3.0\n* JupyterLite \u003e= 0.1.0a3\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_labextension_example 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 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\njlpm 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 `jlpm 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### Testing with JupyterLite\n\nTo test with JupyterLite, follow the steps above just like for a normal JupyterLab extension.\n\nMake sure you have JupyterLite installed:\n\n```bash\npip install jupyterlite\n```\n\n```bash\n# build the JupyterLite site\njupyter lite build\n\n# start a JupyterLite static server\njupyter lite serve\n```\n\nIn a web browser, open http://localhost:8000/lab/index.html to access JupyterLite.\n\n### Development uninstall\n\n```bash\npip uninstall jupyterlite_labextension_example\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-labextension-example` within that folder.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjtpio%2Fjupyterlite-labextension-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjtpio%2Fjupyterlite-labextension-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjtpio%2Fjupyterlite-labextension-example/lists"}