{"id":15288057,"url":"https://github.com/elyra-ai/streamlit-extension","last_synced_at":"2025-04-13T06:34:19.577Z","repository":{"id":37513008,"uuid":"499640292","full_name":"elyra-ai/streamlit-extension","owner":"elyra-ai","description":"A JupyterLab extension to open a streamlit app within JupyterLab.","archived":false,"fork":false,"pushed_at":"2023-06-20T04:47:18.000Z","size":972,"stargazers_count":5,"open_issues_count":7,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-23T09:58:00.800Z","etag":null,"topics":["jupyterlab","jupyterlab-extension","streamlit"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elyra-ai.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":"2022-06-03T20:17:54.000Z","updated_at":"2023-11-18T22:52:43.000Z","dependencies_parsed_at":"2024-09-30T15:44:02.410Z","dependency_job_id":"aac068a9-75d6-4a23-936b-b7a16222359b","html_url":"https://github.com/elyra-ai/streamlit-extension","commit_stats":{"total_commits":15,"total_committers":2,"mean_commits":7.5,"dds":"0.19999999999999996","last_synced_commit":"d02a5a8fdfc68e7810ee28fb220bf75bdbee06d9"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elyra-ai%2Fstreamlit-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elyra-ai%2Fstreamlit-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elyra-ai%2Fstreamlit-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elyra-ai%2Fstreamlit-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elyra-ai","download_url":"https://codeload.github.com/elyra-ai/streamlit-extension/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248674691,"owners_count":21143760,"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":["jupyterlab","jupyterlab-extension","streamlit"],"created_at":"2024-09-30T15:43:59.484Z","updated_at":"2025-04-13T06:34:19.542Z","avatar_url":"https://github.com/elyra-ai.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\n{% comment %}\nCopyright 2017-2023 Elyra Authors\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n{% endcomment %}\n--\u003e\n\n# Streamlit JupyterLab Extension\n\n[![Github Actions Status](https://github.com/elyra-ai/streamlit-extension/workflows/Build/badge.svg)](https://github.com/elyra-ai/streamlit-extension/actions/workflows/build.yml)\n\nAn extension to open a streamlit app within JupyterLab.\n\n## Requirements\n\n- JupyterLab \u003e= 3.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install elyra-streamlit-extension\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall elyra-streamlit-extension\n```\n\n## Troubleshoot\n\nIf you are seeing the frontend extension, but it is not working, check\nthat the server extension is enabled:\n\n```bash\njupyter server extension list\n```\n\nIf the server extension is installed and enabled, but you are not seeing\nthe frontend extension, check the frontend extension is installed:\n\n```bash\njupyter labextension list\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 streamlit_extension 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# Server extension must be manually installed in develop mode\njupyter server extension enable streamlit_extension\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\n# Server extension must be manually disabled in develop mode\njupyter server extension disable streamlit_extension\npip uninstall elyra-streamlit-extension\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 `@elyra/streamlit-extension` 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%2Felyra-ai%2Fstreamlit-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felyra-ai%2Fstreamlit-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felyra-ai%2Fstreamlit-extension/lists"}