1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/jupyterlab_ynh.git synced 2024-09-03 19:26:35 +02:00
jupyterlab_ynh/README.md

51 lines
2.2 KiB
Markdown
Raw Normal View History

2022-03-11 00:23:43 +01:00
<!--
2024-03-31 03:43:10 +02:00
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
2022-03-11 00:23:43 +01:00
It shall NOT be edited by hand.
-->
2018-12-30 23:54:42 +01:00
# JupyterLab for YunoHost
2023-02-10 22:05:48 +01:00
[![Integration level](https://dash.yunohost.org/integration/jupyterlab.svg)](https://dash.yunohost.org/appci/app/jupyterlab) ![Working status](https://ci-apps.yunohost.org/ci/badges/jupyterlab.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/jupyterlab.maintain.svg)
2023-02-20 19:36:14 +01:00
2020-12-20 11:33:16 +01:00
[![Install JupyterLab with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jupyterlab)
2018-12-30 23:54:42 +01:00
2024-03-31 03:43:10 +02:00
*[Read this README is other languages.](./ALL_README.md)*
2020-03-27 14:55:03 +01:00
2024-03-31 03:43:10 +02:00
> *This package allows you to install JupyterLab quickly and simply on a YunoHost server.*
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
2018-12-30 23:54:42 +01:00
## Overview
2022-03-11 00:23:43 +01:00
JupyterLab is the next-generation user interface for Project Jupyter offering all the familiar building blocks of the classic Jupyter Notebook (notebook, terminal, text editor, file browser, rich outputs, etc.) in a flexible and powerful user interface. JupyterLab will eventually replace the classic Jupyter Notebook.
2018-12-30 23:54:42 +01:00
2024-03-31 03:43:10 +02:00
**Shipped version:** 4.1.4~ynh1
2022-08-23 07:02:32 +02:00
2024-03-31 03:43:10 +02:00
**Demo:** <https://mybinder.org/v2/gh/jupyterlab/jupyterlab-demo/master?urlpath=lab/tree/demo>
2018-12-30 23:54:42 +01:00
2022-03-11 00:23:43 +01:00
## Screenshots
2018-12-30 23:54:42 +01:00
2022-08-07 21:09:34 +02:00
![Screenshot of JupyterLab](./doc/screenshots/jupyterlab.png)
2018-12-30 23:54:42 +01:00
2022-03-11 00:23:43 +01:00
## Documentation and resources
2018-12-30 23:54:42 +01:00
2024-03-31 03:43:10 +02:00
- Official app website: <https://jupyter.org>
- Official admin documentation: <https://jupyterlab.readthedocs.io/en/stable/>
- Upstream app code repository: <https://github.com/jupyterhub/jupyterhub>
- YunoHost Store: <https://apps.yunohost.org/app/jupyterlab>
- Report a bug: <https://github.com/YunoHost-Apps/jupyterlab_ynh/issues>
2018-12-30 23:54:42 +01:00
2022-03-11 00:23:43 +01:00
## Developer info
2018-12-30 23:54:42 +01:00
2024-03-31 03:43:10 +02:00
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/jupyterlab_ynh/tree/testing).
2018-12-30 23:54:42 +01:00
2024-03-31 03:43:10 +02:00
To try the `testing` branch, please proceed like that:
2022-08-07 21:09:34 +02:00
2024-03-31 03:43:10 +02:00
```bash
2018-12-30 23:54:42 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/jupyterlab_ynh/tree/testing --debug
or
sudo yunohost app upgrade jupyterlab -u https://github.com/YunoHost-Apps/jupyterlab_ynh/tree/testing --debug
```
2022-03-11 00:23:43 +01:00
2022-08-07 21:09:34 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>