mirror of
https://github.com/YunoHost-Apps/jupyterlab_ynh.git
synced 2024-09-03 19:26:35 +02:00
Auto-update README
This commit is contained in:
parent
3f80d66304
commit
15e98b7327
2 changed files with 41 additions and 75 deletions
59
README.md
59
README.md
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||||
|
It shall NOT be edited by hand.
|
||||||
|
-->
|
||||||
|
|
||||||
# JupyterLab for YunoHost
|
# JupyterLab for YunoHost
|
||||||
|
|
||||||
[![Integration level](https://dash.yunohost.org/integration/jupyterlab.svg)](https://dash.yunohost.org/appci/app/jupyterlab) ![](https://ci-apps.yunohost.org/ci/badges/jupyterlab.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jupyterlab.maintain.svg)
|
[![Integration level](https://dash.yunohost.org/integration/jupyterlab.svg)](https://dash.yunohost.org/appci/app/jupyterlab) ![](https://ci-apps.yunohost.org/ci/badges/jupyterlab.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jupyterlab.maintain.svg)
|
||||||
|
@ -5,55 +10,33 @@
|
||||||
|
|
||||||
*[Lire ce readme en français.](./README_fr.md)*
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
> *This package allow you to install JupyterLab quickly and simply on a YunoHost server.
|
> *This package allows you to install JupyterLab quickly and simply on a YunoHost server.
|
||||||
If you don't have YunoHost, please see [here](https://yunohost.org/install) to know how to install and enjoy it.*
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
**Shipped version:** 3.0.16
|
|
||||||
|
**Shipped version:** 3.0.16~ynh2
|
||||||
|
|
||||||
|
**Demo:** https://mybinder.org/v2/gh/jupyterlab/jupyterlab-demo/master?urlpath=lab/tree/demo
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
![](https://raw.githubusercontent.com/jupyterlab/jupyterlab/3e3a2c9e295703ff6d441589423e284cc6d5c245/docs/source/images/jupyterlab.png)
|
![](./doc/screenshots/jupyterlab.png)
|
||||||
|
|
||||||
## Demo
|
## Documentation and resources
|
||||||
|
|
||||||
* [Try it on Binder](https://mybinder.org/v2/gh/jupyterlab/jupyterlab-demo/master?urlpath=lab/tree/demo)
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
How to configure this app: by an admin panel, a plain file with SSH.
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
* Official documentation: https://jupyterlab.readthedocs.io/en/stable/
|
|
||||||
* YunoHost documentation: https://yunohost.org/en/app_jupyterlab
|
|
||||||
|
|
||||||
## YunoHost specific features
|
|
||||||
|
|
||||||
#### Multi-users support
|
|
||||||
|
|
||||||
* LDAP auth supported? **Yes**
|
|
||||||
* Can the app be used by multiple users? **Yes**
|
|
||||||
|
|
||||||
#### Supported architectures
|
|
||||||
|
|
||||||
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/jupyterlab.svg)](https://ci-apps.yunohost.org/ci/apps/jupyterlab/)
|
|
||||||
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/jupyterlab.svg)](https://ci-apps-arm.yunohost.org/ci/apps/jupyterlab/)
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
|
* Official app website: https://jupyterlab.readthedocs.io/en/stable/
|
||||||
|
* Official admin documentation: https://jupyterlab.readthedocs.io/en/stable/
|
||||||
|
* Upstream app code repository: https://github.com/jupyterhub/jupyterhub
|
||||||
|
* YunoHost documentation for this app: https://yunohost.org/app_jupyterlab
|
||||||
* Report a bug: https://github.com/YunoHost-Apps/jupyterlab_ynh/issues
|
* Report a bug: https://github.com/YunoHost-Apps/jupyterlab_ynh/issues
|
||||||
* App website: https://jupyter.org
|
|
||||||
* Upstream app repository: https://github.com/jupyterhub/jupyterhub
|
|
||||||
* YunoHost website: https://yunohost.org/
|
|
||||||
|
|
||||||
---
|
## Developer info
|
||||||
|
|
||||||
## Developers info
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/jupyterlab_ynh/tree/testing).
|
||||||
|
|
||||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/jupyterlab_ynh/tree/testing).
|
|
||||||
|
|
||||||
To try the testing branch, please proceed like that.
|
To try the testing branch, please proceed like that.
|
||||||
```
|
```
|
||||||
|
@ -61,3 +44,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/jupyterlab_ynh/tree/t
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade jupyterlab -u https://github.com/YunoHost-Apps/jupyterlab_ynh/tree/testing --debug
|
sudo yunohost app upgrade jupyterlab -u https://github.com/YunoHost-Apps/jupyterlab_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
55
README_fr.md
55
README_fr.md
|
@ -1,55 +1,34 @@
|
||||||
# JupyterLab pour YunoHost
|
# JupyterLab pour YunoHost
|
||||||
|
|
||||||
[![Integration level](https://dash.yunohost.org/integration/jupyterlab.svg)](https://dash.yunohost.org/appci/app/jupyterlab) ![](https://ci-apps.yunohost.org/ci/badges/jupyterlab.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jupyterlab.maintain.svg)
|
[![Niveau d'intégration](https://dash.yunohost.org/integration/jupyterlab.svg)](https://dash.yunohost.org/appci/app/jupyterlab) ![](https://ci-apps.yunohost.org/ci/badges/jupyterlab.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jupyterlab.maintain.svg)
|
||||||
[![Installer JupyterLab avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jupyterlab)
|
[![Installer JupyterLab avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jupyterlab)
|
||||||
|
|
||||||
*[Read this readme in english.](./README.md)*
|
*[Read this readme in english.](./README.md)*
|
||||||
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
> *Ce package vous permet d’installer JupyterLab rapidement et simplement sur un serveur YunoHost.
|
> *Ce package vous permet d'installer JupyterLab rapidement et simplement sur un serveur YunoHost.
|
||||||
Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/install) pour savoir comment l’installer et en profiter.*
|
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||||
|
|
||||||
## Vue d’ensemble
|
## Vue d'ensemble
|
||||||
JupyterLab est une interface utilisateur de nouvelle génération pour le projet Jupyter offrant tous les modules de Jupyter Notebook (interpréteur Python, terminal, éditeur de texte, navigateur de fichiers, etc.) dans une interface utilisateur flexible et puissante. JupyterLab remplacera à terme Jupyter Notebook.
|
|
||||||
|
|
||||||
**Version incluse :** 3.0.16
|
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.
|
||||||
|
|
||||||
## Captures d’écran
|
|
||||||
|
|
||||||
![](https://raw.githubusercontent.com/jupyterlab/jupyterlab/3e3a2c9e295703ff6d441589423e284cc6d5c245/docs/source/images/jupyterlab.png)
|
**Version incluse :** 3.0.16~ynh2
|
||||||
|
|
||||||
## Démo
|
**Démo :** https://mybinder.org/v2/gh/jupyterlab/jupyterlab-demo/master?urlpath=lab/tree/demo
|
||||||
|
|
||||||
* [Démo sur Binder](https://mybinder.org/v2/gh/jupyterlab/jupyterlab-demo/master?urlpath=lab/tree/demo)
|
## Captures d'écran
|
||||||
|
|
||||||
## Configuration
|
![](./doc/screenshots/jupyterlab.png)
|
||||||
|
|
||||||
Comment configurer cette application : via le panneau d'administration, un fichier brut en SSH.
|
## Documentations et ressources
|
||||||
|
|
||||||
## Documentation
|
* Site officiel de l'app : https://jupyterlab.readthedocs.io/en/stable/
|
||||||
|
* Documentation officielle de l'admin : https://jupyterlab.readthedocs.io/en/stable/
|
||||||
* Documentation officielle : https://jupyterlab.readthedocs.io/en/stable/
|
* Dépôt de code officiel de l'app : https://github.com/jupyterhub/jupyterhub
|
||||||
* Documentation YunoHost : https://yunohost.org/fr/app_jupyterlab
|
* Documentation YunoHost pour cette app : https://yunohost.org/app_jupyterlab
|
||||||
|
* Signaler un bug : https://github.com/YunoHost-Apps/jupyterlab_ynh/issues
|
||||||
## Caractéristiques spécifiques YunoHost
|
|
||||||
|
|
||||||
#### Support multi-utilisateurs
|
|
||||||
|
|
||||||
* L’authentification LDAP est-elle prise en charge ? **Oui**
|
|
||||||
* L’application peut-elle être utilisée par plusieurs utilisateurs ? **Oui**
|
|
||||||
|
|
||||||
#### Architectures supportées
|
|
||||||
|
|
||||||
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/jupyterlab.svg)](https://ci-apps.yunohost.org/ci/apps/jupyterlab/)
|
|
||||||
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/jupyterlab.svg)](https://ci-apps-arm.yunohost.org/ci/apps/jupyterlab/)
|
|
||||||
|
|
||||||
## Liens
|
|
||||||
|
|
||||||
* Signaler un bug : https://github.com/YunoHost-Apps/jupyterlab_ynh/issues
|
|
||||||
* Site de l’application : https://jupyter.org
|
|
||||||
* Dépôt de l’application principale : https://github.com/jupyterhub/jupyterhub
|
|
||||||
* Site web YunoHost : https://yunohost.org/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Informations pour les développeurs
|
## Informations pour les développeurs
|
||||||
|
|
||||||
|
@ -61,3 +40,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/jupyterlab_ynh/tree/t
|
||||||
ou
|
ou
|
||||||
sudo yunohost app upgrade jupyterlab -u https://github.com/YunoHost-Apps/jupyterlab_ynh/tree/testing --debug
|
sudo yunohost app upgrade jupyterlab -u https://github.com/YunoHost-Apps/jupyterlab_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
Loading…
Reference in a new issue