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

JupyterLab package for YunoHost

closember jupyterlab yunohost yunohost-apps

Find a file

Éric Gaspar 59f447e0e1 Merge pull request #124 from YunoHost-Apps/testing Testing		2022-12-27 14:01:40 +01:00
.github	[autopatch] Update issue and PR templates	2021-05-13 17:48:16 +02:00
conf	Apply last example_ynh	2022-03-11 00:23:07 +01:00
doc	Update DISCLAIMER.md	2022-12-27 12:09:15 +01:00
scripts	3.5.2	2022-12-27 12:07:45 +01:00
check_process	Update check_process	2022-05-12 20:54:30 +02:00
LICENSE	Create LICENSE	2018-12-30 23:40:40 +01:00
manifest.json	3.5.2	2022-12-27 12:07:45 +01:00
README.md	Auto-update README	2022-12-27 11:09:24 +00:00
README_fr.md	Auto-update README	2022-12-27 11:09:24 +00:00
update_config_files.md	Adding update_config_files.md	2020-04-10 19:25:39 +02:00

README.md

JupyterLab for YunoHost

Lire ce readme en français.

This package allows you to install JupyterLab quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install 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: 3.5.2~ynh1

Demo: https://mybinder.org/v2/gh/jupyterlab/jupyterlab-demo/master?urlpath=lab/tree/demo

Screenshots

Disclaimers / important information

Updating configuration files

Install the new version of the app with:

sudo yunohost app install https://github.com/YunoHost-Apps/jupyterlab_ynh/tree/testing

Navigate to the installation path (/opt/jupyterlab by default), and run :

pipenv shell

You are now in the virtual environment of jupyterlab. You can execute these two commands:

To generate the jupyterhub_config.py file:

jupyterhub --generate-config

To generate the jupyter_notebook_config.py file:

jupyter notebook --generate-config
cp $HOME/.jupyter/jupyter_notebook_config.py ./

You can now update the old template files with the new one.

Documentation and resources

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 documentation for this app: https://yunohost.org/app_jupyterlab
Report a bug: https://github.com/YunoHost-Apps/jupyterlab_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

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

More info regarding app packaging: https://yunohost.org/packaging_apps