-
-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
211 additions
and
146 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,210 @@ | ||
| # Home Assistant Community Add-on: JupyterLab Lite | ||
|
|
||
| JupyterLab is an open-source web application that allows you to create and share | ||
| documents that contain live code, equations, visualizations and narrative text. | ||
| Uses include: data cleaning and transformation, numerical simulation, | ||
| statistical modeling, data visualization, machine learning, and much more. | ||
|
|
||
| This add-on runs JupyterLab, which is the next-generation user interface for | ||
| Project Jupyter. It is an extensible environment for interactive and | ||
| reproducible computing, based on the Jupyter Notebook and Architecture. | ||
|
|
||
| ## Installation | ||
|
|
||
| The installation of this add-on is pretty straightforward and not different in | ||
| comparison to installing any other Home Assistant add-on. | ||
|
|
||
| 1. Search for the "JupyterLab Lite" add-on in the Supervisor add-on store | ||
| and install it. | ||
| 1. Start the "JupyterLab Lite" add-on | ||
| 1. Check the logs of the "JupyterLab Lite" add-on to see if everything went well. | ||
|
|
||
| ## Configuration | ||
|
|
||
| **Note**: _Remember to restart the add-on when the configuration is changed._ | ||
|
|
||
| Example add-on configuration: | ||
|
|
||
| ```yaml | ||
| log_level: info | ||
| github_access_token: abcdef1234567890abcdef0123456789abcdef01 | ||
| ssl: true | ||
| certfile: fullchain.pem | ||
| keyfile: privkey.pem | ||
| system_packages: | ||
| - ffmpeg | ||
| init_commands: | ||
| - pip install virtualenv | ||
| - pip install yamllint | ||
| ``` | ||
| **Note**: _This is just an example, don't copy and past it! Create your own!_ | ||
| ### Option: `log_level` | ||
|
|
||
| The `log_level` option controls the level of log output by the addon and can | ||
| be changed to be more or less verbose, which might be useful when you are | ||
| dealing with an unknown issue. Possible values are: | ||
|
|
||
| - `trace`: Show every detail, like all called internal functions. | ||
| - `debug`: Shows detailed debug information. | ||
| - `info`: Normal (usually) interesting events. | ||
| - `warning`: Exceptional occurrences that are not errors. | ||
| - `error`: Runtime errors that do not require immediate action. | ||
| - `fatal`: Something went terribly wrong. Add-on becomes unusable. | ||
|
|
||
| Please note that each level automatically includes log messages from a | ||
| more severe level, e.g., `debug` also shows `info` messages. By default, | ||
| the `log_level` is set to `info`, which is the recommended setting unless | ||
| you are troubleshooting. | ||
|
|
||
| ### Option: `github_access_token` | ||
|
|
||
| Sets an GitHub access token. When making unauthenticated requests to GitHub | ||
| (as we must do to get repository data), GitHub imposes fairly strict rate-limits | ||
| on how many requests we can make. As such, you are likely to hit that limit | ||
| within a few minutes of work. | ||
|
|
||
| There is a chapter in this document with instruction on obtaining such a token. | ||
|
|
||
| **Note**: _This option support secrets, e.g., `!secret github_token`._ | ||
|
|
||
| ### Option: `ssl` | ||
|
|
||
| Enables/Disables SSL (HTTPS) on the JupyterLab Set it `true` to enable it, | ||
| `false` otherwise. | ||
|
|
||
| ### Option: `certfile` | ||
|
|
||
| The certificate file to use for SSL. | ||
|
|
||
| **Note**: _The file MUST be stored in `/ssl/`, which is the default_ | ||
|
|
||
| ### Option: `keyfile` | ||
|
|
||
| The private key file to use for SSL. | ||
|
|
||
| **Note**: _The file MUST be stored in `/ssl/`, which is the default_ | ||
|
|
||
| ### Option: `system_packages` | ||
|
|
||
| Allows you to specify additional [Alpine packages][alpine-packages] to be | ||
| installed to your JupyterLab setup (e.g., `g++`. `make`, `ffmpeg`). | ||
|
|
||
| **Note**: _Adding many packages will result in a longer start-up time | ||
| for the add-on._ | ||
|
|
||
| #### Option: `init_commands` | ||
|
|
||
| Customize your environment even more with the `init_commands` option. | ||
| Add one or more shell commands to the list, and they will be executed every | ||
| single time this add-on starts. | ||
|
|
||
| ## Embedding into Home Assistant | ||
|
|
||
| It is possible to embed JupyterLab directly into Home Assistant, allowing | ||
| you to access the JupyterLab through the Home Assistant frontend. | ||
|
|
||
| Home Assistant provides the `panel_iframe` integration, for these purposes. | ||
|
|
||
| Example configuration: | ||
|
|
||
| ```yaml | ||
| panel_iframe: | ||
| jupyterlab: | ||
| title: JupyterLab | ||
| icon: mdi:flask | ||
| url: https://addres.to.your.home.assistant:7777 | ||
| ``` | ||
|
|
||
| ## Getting a GitHub access token | ||
|
|
||
| You can get an access token by following these steps: | ||
|
|
||
| 1. [Verify][github-verify] your email address with GitHub. | ||
| 1. Go to your account settings on GitHub and select "Developer Settings" | ||
| from the left panel. | ||
| 1. On the left, select "Personal access tokens" | ||
| 1. Click the "Generate new token" button, and enter your password. | ||
| 1. Give the token a description, and check the "**repo**" scope box. | ||
| 1. Click "Generate token" | ||
| 1. You should be given a string which will be your access token. | ||
|
|
||
| Remember that this token is effectively a password for your GitHub account. | ||
| *Do not* share it online or check the token into version control, | ||
| as people can use it to access all of your data on GitHub. | ||
|
|
||
| ## Changelog & Releases | ||
|
|
||
| This repository keeps a change log using [GitHub's releases][releases] | ||
| functionality. The format of the log is based on | ||
| [Keep a Changelog][keepchangelog]. | ||
|
|
||
| Releases are based on [Semantic Versioning][semver], and use the format | ||
| of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented | ||
| based on the following: | ||
|
|
||
| - ``MAJOR``: Incompatible or major changes. | ||
| - ``MINOR``: Backwards-compatible new features and enhancements. | ||
| - ``PATCH``: Backwards-compatible bugfixes and package updates. | ||
|
|
||
| ## Support | ||
|
|
||
| Got questions? | ||
|
|
||
| You have several options to get them answered: | ||
|
|
||
| - The [Home Assistant Community Add-ons Discord chat server][discord] for add-on | ||
| support and feature requests. | ||
| - The [Home Assistant Discord chat server][discord-ha] for general Home | ||
| Assistant discussions and questions. | ||
| - The Home Assistant [Community Forum][forum]. | ||
| - Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] | ||
|
|
||
| You could also [open an issue here][issue] GitHub. | ||
|
|
||
| ## Authors & contributors | ||
|
|
||
| The original setup of this repository is by [Franck Nijhof][frenck]. | ||
|
|
||
| For a full list of all authors and contributors, | ||
| check [the contributor's page][contributors]. | ||
|
|
||
| ## License | ||
|
|
||
| MIT License | ||
|
|
||
| Copyright (c) 2018-2020 Franck Nijhof | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
|
|
||
| [alpine-packages]: https://pkgs.alpinelinux.org/packages | ||
| [contributors]: https://github.com/hassio-addons/addon-jupyterlab-lite/graphs/contributors | ||
| [discord-ha]: https://discord.gg/c5DvZ4e | ||
| [discord]: https://discord.me/hassioaddons | ||
| [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg | ||
| [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-jupyterlab-lite/87337?u=frenck | ||
| [frenck]: https://github.com/frenck | ||
| [github-verify]: https://help.github.com/articles/verifying-your-email-address | ||
| [issue]: https://github.com/hassio-addons/addon-jupyterlab-lite/issues | ||
| [keepchangelog]: http://keepachangelog.com/en/1.0.0/ | ||
| [python-packages]: https://pypi.org/ | ||
| [reddit]: https://reddit.com/r/homeassistant | ||
| [releases]: https://github.com/hassio-addons/addon-jupyterlab-lite/releases | ||
| [semver]: http://semver.org/spec/v2.0.0.htm |
1e82c86There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where should the content of jupyterlab/DOCS.md be discoverable? There is no link to it from README.md and it doesn't appear in the add-on's documentation tab under supervisor.
1e82c86There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of commenting on commits (which aren't trackable in any way), please raise an issue or open a PR to fix it.
Thanks 👍