{"id":21064730,"url":"https://github.com/ideonate/jupyter-containds","last_synced_at":"2025-05-16T02:32:47.540Z","repository":{"id":37407993,"uuid":"276734744","full_name":"ideonate/jupyter-containds","owner":"ideonate","description":"Companion Jupyter extension for ContainDS Dashboards","archived":false,"fork":false,"pushed_at":"2023-03-05T03:45:51.000Z","size":2170,"stargazers_count":8,"open_issues_count":12,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-19T07:56:26.592Z","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/ideonate.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2020-07-02T20:00:22.000Z","updated_at":"2023-06-19T10:34:42.000Z","dependencies_parsed_at":"2024-11-19T17:52:19.697Z","dependency_job_id":"c8f65e9f-5a19-40b0-a57c-fb85f798715f","html_url":"https://github.com/ideonate/jupyter-containds","commit_stats":{"total_commits":66,"total_committers":6,"mean_commits":11.0,"dds":0.5606060606060606,"last_synced_commit":"80d42c077b80c01f9c78a890b0e3fc60aa63cb87"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideonate%2Fjupyter-containds","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideonate%2Fjupyter-containds/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideonate%2Fjupyter-containds/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideonate%2Fjupyter-containds/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ideonate","download_url":"https://codeload.github.com/ideonate/jupyter-containds/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254456180,"owners_count":22074125,"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-11-19T17:51:28.729Z","updated_at":"2025-05-16T02:32:46.464Z","avatar_url":"https://github.com/ideonate.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jupyter-containds\n\n[![Github Actions Status](https://github.com/ideonate/jupyter-containds/workflows/Build/badge.svg)](https://github.com/ideonate/jupyter-containds/workflows/Build)\n\nCompanion Jupyter extension for [ContainDS](https://github.com/ideonate/cdsdashboards)\n\n![JupyterLab ContainDS Extension screenshot](screenshots/launcher.png)\n\nWhen editing a Jupyter notebook, one click creates a new Voila dashboard based on the current file.\n\nFrom the JupyterLab launcher screen, access your own dashboard configuration pages or click straight through to view\ndashboards shared with you.\n\n## Requirements\n\n- JupyterLab \u003e= 2.0\n- ipywidgets \u003e= 7\n\n## Installation\n\nYou can install using `pip` and JupyterLab 3+:\n\n```bash\npip install jupyter-containds\n```\n\nIf you use JupyterLab 2:\n\n```bash\npip install jupyter-containds\njupyter labextension install @jupyter-widgets/jupyterlab-manager @ideonate/jupyter-containds\n```\n\nIf you are using Jupyter Notebook 5.2 or earlier, you may also need to enable\nthe nbextension:\n\n```bash\njupyter nbextension enable --py [--sys-prefix|--user|--system] jupyter_containds\n```\n\n### Uninstall\n\n\n```bash\npip uninstall jupyter-containds\n```\n\nIf you use JupyterLab 2:\n\n```bash\njupyter labextension uninstall @ideonate/jupyter-containds\npip uninstall jupyter-containds\n```\n\n## Development Installation\n\n```bash\n# First install the python package. This will also build the JS packages.\npip install -e \".[test, examples]\"\n```\n\nWhen developing your extensions, you need to manually enable your extensions with the\nnotebook / lab frontend. For lab, this is done by the command:\n\n```\njupyter labextension develop . --overwrite\n```\n\nFor classic notebook, you can run:\n\n```\njupyter nbextension install --sys-prefix --symlink --overwrite --py jupyter_containds\njupyter nbextension enable --sys-prefix --py jupyter_containds\n```\n\nNote that the `--symlink` flag doesn't work on Windows, so you will here have to run\nthe `install` command every time that you rebuild your extension. For certain installations\nyou might also need another flag instead of `--sys-prefix`, but we won't cover the meaning\nof those flags here.\n\n### How to see your changes\n\n#### Typescript:\n\nTo continuously monitor the project for changes and automatically trigger a rebuild, start JupyterLab:\n\n```bash\njupyter lab\n```\n\nAnd in a separate session, begin watching the source directory for changes:\n\n```bash\njlpm run watch\n```\n\nAfter a change wait for the build to finish and then refresh your browser and the changes should take effect.\n\n#### Python:\n\nIf you make a change to the python code then you will need to restart the notebook kernel to have it take effect.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fideonate%2Fjupyter-containds","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fideonate%2Fjupyter-containds","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fideonate%2Fjupyter-containds/lists"}