{"id":13609003,"url":"https://github.com/jtpio/jupyterlab-topbar","last_synced_at":"2025-04-12T17:33:32.273Z","repository":{"id":57287318,"uuid":"372574371","full_name":"jtpio/jupyterlab-topbar","owner":"jtpio","description":"JupyterLab Top Bar extension","archived":false,"fork":true,"pushed_at":"2024-02-23T12:48:27.000Z","size":2318,"stargazers_count":6,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-07T21:34:09.571Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"jupyterlab-contrib/jupyterlab-topbar","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-05-31T16:53:55.000Z","updated_at":"2024-04-15T11:17:31.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jtpio/jupyterlab-topbar","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtpio%2Fjupyterlab-topbar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtpio%2Fjupyterlab-topbar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtpio%2Fjupyterlab-topbar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtpio%2Fjupyterlab-topbar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jtpio","download_url":"https://codeload.github.com/jtpio/jupyterlab-topbar/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248605475,"owners_count":21132176,"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-08-01T19:01:31.632Z","updated_at":"2025-04-12T17:33:27.264Z","avatar_url":"https://github.com/jtpio.png","language":"TypeScript","funding_links":[],"categories":["JupyterLab扩展","JupyterLab Extensions"],"sub_categories":[],"readme":"# JupyterLab Top Bar Extensions\n\n[![Extension status](https://img.shields.io/badge/status-ready-success 'ready to be used')](https://jupyterlab-contrib.github.io/)\n[![Github Actions Status](https://github.com/jupyterlab-contrib/jupyterlab-topbar/workflows/Build/badge.svg)](https://github.com/jupyterlab-contrib/jupyterlab-topbar/actions/workflows/build.yml)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-topbar/main?urlpath=lab)\n[![PyPI](https://img.shields.io/pypi/v/jupyterlab-topbar.svg)](https://pypi.org/project/jupyterlab-topbar)\n\nMonorepo to experiment with the top bar space in JupyterLab.\n\nSimilar to the [status bar](https://github.com/jupyterlab/jupyterlab/tree/master/packages/statusbar-extension), the top bar can be used to place a few indicators and optimize the overall space.\n\nInspired by Gnome Shell Top Bar indicators.\n\n![a screenshot of the topbar extensions in JupyterLab](https://github.com/jupyterlab-contrib/jupyterlab-topbar/assets/591645/b620d58e-869d-4b8a-9e7c-47143116cc99)\n\n### Extensions\n\n- [jupyterlab-topbar-text](./packages/topbar-text-extension): add and edit custom text\n- [jupyterlab-logout](./packages/logout-extension): add a \"Log Out\" button\n- [jupyterlab-theme-toggle](./packages/theme-toggler-extension): switch between the Light and Dark themes\n\n## Try it online\n\nTry the extensions in your browser with Binder:\n\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-topbar/main?urlpath=lab)\n\n## Installation\n\n### JupyterLab 4.x\n\nUse latest versions of the extensions. **Note** that `jupyterlab-system-monitor`\nextension will be distributed along with `jupyter-resource-usage` package for\nJupyterLab 4.x\n\n```bash\n# topbar text extension\npip install jupyterlab-topbar-text\n\n# logout extension\npip install jupyterlab-logout\n\n# theme toggler extension\npip install jupyterlab-theme-toggler\n```\n\n### JupyterLab 3.0\n\nUse pinned versions as the latest version is incompatible with JupyterLab 3.x\n\n```bash\n# topbar text extension\npip install jupyterlab-topbar-text==0.6.2\n\n# system monitor extension\npip install jupyterlab-system-monitor==0.8.0\n\n# logout extension\npip install jupyterlab-logout==0.5.0\n\n# theme toggler extension. Install it as labextension\njupyter labextension install jupyterlab-topbar-extension jupyterlab-theme-toggle\n```\n\n### JupyterLab 1.x and 2.x\n\n```bash\n# container extension\njupyter labextension install jupyterlab-topbar-extension\n\n# system metrics\njupyter labextension install jupyterlab-system-monitor\npip install jupyter-resource-usage\n\n# custom text in the top bar\njupyter labextension install jupyterlab-topbar-text\n\n# add a logout button\njupyter labextension install jupyterlab-logout\n\n# theme toggling extension\njupyter labextension install jupyterlab-theme-toggle\n```\n\nAll-in-one install:\n\n```bash\njupyter labextension install jupyterlab-topbar-extension \\\n                             jupyterlab-system-monitor \\\n                             jupyterlab-topbar-text \\\n                             jupyterlab-logout \\\n                             jupyterlab-theme-toggle\n```\n\n## Development\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 into the package that we want to develop\ncd packages/\u003cextension_name\u003e\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### Uninstall\n\n```bash\npip uninstall jupyterlab_topbar_text jupyterlab_logout jupyterlab_theme_toggler\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjtpio%2Fjupyterlab-topbar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjtpio%2Fjupyterlab-topbar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjtpio%2Fjupyterlab-topbar/lists"}