mirror of
https://github.com/YunoHost-Apps/jupyterlab_ynh.git
synced 2024-09-03 19:26:35 +02:00
Kayou
GitHub
commit
9891fe1c13
8 changed files with 134 additions and 18 deletions
22
README.md
22
README.md
|
|
@ -1,15 +1,17 @@
|
|||
# JupyterLab for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/jupyterlab)
|
||||
[](https://dash.yunohost.org/appci/app/jupyterlab)  
|
||||
[](https://install-app.yunohost.org/?app=jupyterlab)
|
||||
|
||||
> *This package allow you to install jupyterlab quickly and simply on a YunoHost server.
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allow 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.*
|
||||
|
||||
## 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.
|
||||
|
||||
**Shipped version:** v2.0.1
|
||||
**Shipped version:** 2.1.0
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
|
@ -25,33 +27,31 @@ How to configure this app: by an admin panel, a plain file with SSH.
|
|||
|
||||
## Documentation
|
||||
|
||||
* Official documentation: [Link to the official documentation of this app](https://jupyterlab.readthedocs.io/en/stable/)
|
||||
* Official documentation: [Link to the official documentation of this app](https://jupyterlab.readthedocs.io/en/stable/)
|
||||
|
||||
## YunoHost specific features
|
||||
|
||||
#### Multi-users support
|
||||
|
||||
LDAP auth supported? **Yes**
|
||||
Can the app be used by multiple users? **Yes**
|
||||
* LDAP auth supported? **Yes**
|
||||
* Can the app be used by multiple users? **Yes**
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/jupyterlab/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/jupyterlab/)
|
||||
* Jessie x86-64b - [](https://ci-stretch.nohost.me/ci/apps/jupyterlab/)
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/jupyterlab_ynh/issues
|
||||
* App website: https://jupyter.org/index.html
|
||||
* YunoHost website: https://yunohost.org/
|
||||
* Report a bug: https://github.com/YunoHost-Apps/jupyterlab_ynh/issues
|
||||
* App website: https://jupyter.org/index.html
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
|
||||
Developers info
|
||||
----------------
|
||||
|
||||
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
||||
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.
|
||||
|
|
|
|||
62
README_fr.md
Normal file
62
README_fr.md
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
# JupyterLab pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/jupyterlab)  
|
||||
[](https://install-app.yunohost.org/?app=jupyterlab)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
|
||||
> *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.*
|
||||
|
||||
## 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:** 2.1.0
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
## Démo
|
||||
|
||||
* [Démo sur Binder](https://mybinder.org/v2/gh/jupyterlab/jupyterlab-demo/master?urlpath=lab/tree/demo)
|
||||
|
||||
## Configuration
|
||||
|
||||
Comment configurer cette application: via le panneau d'administration, un fichier brut en SSH.
|
||||
|
||||
## Documentation
|
||||
|
||||
* Documentation officielle: [Lien vers la documentation officielle de cette application](https://jupyterlab.readthedocs.io/en/stable/)
|
||||
|
||||
## 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-64b - [](https://ci-apps.yunohost.org/ci/apps/jupyterlab/)
|
||||
* ARMv8-A - [](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/index.html
|
||||
* Site web YunoHost: https://yunohost.org/
|
||||
|
||||
---
|
||||
|
||||
Informations pour les développeurs
|
||||
----------------
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/jupyterlab_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
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
|
||||
```
|
||||
|
|
@ -873,4 +873,4 @@ c.NotebookApp.terminals_enabled = bool(__ENABLE_TERMINAL__)
|
|||
## The websocket url of the Kernel or Enterprise Gateway server. If not
|
||||
# provided, this value will correspond to the value of the Gateway url with 'ws'
|
||||
# in place of 'http'. (JUPYTER_GATEWAY_WS_URL env var)
|
||||
#c.GatewayClient.ws_url = None
|
||||
#c.GatewayClient.ws_url = None
|
||||
|
|
|
|||
|
|
@ -91,9 +91,9 @@
|
|||
# e.g. `c.JupyterHub.authenticator_class = 'pam'`
|
||||
#
|
||||
# Currently installed:
|
||||
# - dummy: jupyterhub.auth.DummyAuthenticator
|
||||
# - pam: jupyterhub.auth.PAMAuthenticator
|
||||
# - default: jupyterhub.auth.PAMAuthenticator
|
||||
# - pam: jupyterhub.auth.PAMAuthenticator
|
||||
# - dummy: jupyterhub.auth.DummyAuthenticator
|
||||
c.JupyterHub.authenticator_class = 'ldapauthenticator.LDAPAuthenticator'
|
||||
|
||||
## The base URL of the entire application.
|
||||
|
|
@ -108,7 +108,7 @@ c.JupyterHub.authenticator_class = 'ldapauthenticator.LDAPAuthenticator'
|
|||
## The public facing URL of the whole JupyterHub application.
|
||||
#
|
||||
# This is the address on which the proxy will bind. Sets protocol, ip, base_url
|
||||
c.JupyterHub.bind_url = 'http://:__PORT____PATH__'
|
||||
#c.JupyterHub.bind_url = 'http://:8000'
|
||||
|
||||
## Whether to shutdown the proxy when the Hub shuts down.
|
||||
#
|
||||
|
|
@ -466,8 +466,8 @@ c.ConfigurableHTTPProxy.api_url = 'http://127.0.0.1:__PORT_HTTP_PROXY__'
|
|||
# e.g. `c.JupyterHub.spawner_class = 'localprocess'`
|
||||
#
|
||||
# Currently installed:
|
||||
# - simple: jupyterhub.spawner.SimpleLocalProcessSpawner
|
||||
# - default: jupyterhub.spawner.LocalProcessSpawner
|
||||
# - simple: jupyterhub.spawner.SimpleLocalProcessSpawner
|
||||
# - localprocess: jupyterhub.spawner.LocalProcessSpawner
|
||||
#c.JupyterHub.spawner_class = 'jupyterhub.spawner.LocalProcessSpawner'
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
"name": "JupyterLab",
|
||||
"id": "jupyterlab",
|
||||
"packaging_format": 1,
|
||||
"version": "2.0.1~ynh2",
|
||||
"version": "2.1.0~ynh1",
|
||||
"description": {
|
||||
"en": "An extensible environment for interactive and reproducible computing (notebook, terminal, text editor, file browser, rich outputs, etc.)",
|
||||
"fr": "Un environnement informatique extensible, interactif et reproductible (bloc-notes, terminal, éditeur de texte, explorateur de fichiers, texte enrichi, etc.)"
|
||||
|
|
|
|||
24
pull_request_template.md
Normal file
24
pull_request_template.md
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
## Problem
|
||||
- *Description of why you made this PR*
|
||||
|
||||
## Solution
|
||||
- *And how you fix that*
|
||||
|
||||
## PR Status
|
||||
- [ ] Code finished.
|
||||
- [ ] Tested with Package_check.
|
||||
- [ ] Fix or enhancement tested.
|
||||
- [ ] Upgrade from last version tested.
|
||||
- [ ] Can be reviewed and tested.
|
||||
|
||||
## Validation
|
||||
---
|
||||
*Minor decision*
|
||||
- **Upgrade previous version** :
|
||||
- [ ] **Code review** :
|
||||
- [ ] **Approval (LGTM)** :
|
||||
- [ ] **Approval (LGTM)** :
|
||||
- **CI succeeded** :
|
||||
[](https://ci-apps-hq.yunohost.org/jenkins/job/jupyterlab_ynh%20PR-NUM-/)
|
||||
*Please replace '-NUM-' in this link by the PR number.*
|
||||
When the PR is marked as ready to merge, you have to wait for 3 days before really merging it.
|
||||
|
|
@ -1 +1 @@
|
|||
jupyterlab_version="2.0.1"
|
||||
jupyterlab_version="2.1.0"
|
||||
|
|
|
|||
30
update_config_files.md
Normal file
30
update_config_files.md
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
# Updating configuration files
|
||||
|
||||
Install the new version of the app with:
|
||||
|
||||
```bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/jupyterlab_ynh/tree/testing
|
||||
```
|
||||
|
||||
Navigate to the installation path (`/opt/jupyterlab` by default), and run :
|
||||
|
||||
```bash
|
||||
pipenv shell
|
||||
```
|
||||
|
||||
You are now in the virtual environment of jupyterlab. You can execute these two commands:
|
||||
|
||||
- To generate the `jupyterhub_config.py` file:
|
||||
|
||||
```bash
|
||||
jupyterhub --generate-config
|
||||
```
|
||||
|
||||
- To generate the `jupyter_notebook_config.py` file:
|
||||
|
||||
```bash
|
||||
jupyter notebook --generate-config
|
||||
cp $HOME/.jupyter/jupyter_notebook_config.py ./
|
||||
```
|
||||
|
||||
You can now update the old template files with the new one.
|
||||
Loading…
Add table
Reference in a new issue