Retour à l'accueil Python pour les historiens

JupyterLab git extension

Documentation concernant JupyterLab git extension:

jupyterlab / jupyterlab-git

Tutoriel JupyterLab git extension

Un tutoriel très intéressant sur Jupyter Lab dont la partie 3 concerne GitHub: Reproducible Data Analysis in Jupyter

/!\ Avant de faire le tutoriel, réfléchissez si vous devez créer un nouveau environnement virtuel, si vous avez déjà d'autres projets en cours. Il est donc préférable de créer un environnement en ligne de commande. Ouvrez un terminal et saisissez : conda create –name <envname> python=<version>. Dans le cadre de ce tutoriel, la version de python pouvant être utilisée est le 3.6 Il n'est pas recommandé, dans le cadre de cet atelier, de créer un environnement avec le logiciel Anaconda, car cela pose problème par la suite.

Une fois que vous avez activé votre environnement dans Ananconda, pensez à installer JupyterLab. Jupyter Notebook sera automatiquement installé avec.

Une fois JupyterLab installé, lancez le, il s'affichera sur votre navigateur.

Les paquets pour conda:

jupyterlab-git (documentation sur GitHub)

jupyterlab-github (Documentation sur Github)

Plugin jupyterlab-github

Sur l'interface JupyterLab, à gauche vous avez une barre de menu. Cliquez sur l'icône Puzzle “Extension Manager” (gestionnaire des plugins). Dans la barre de recherche, cherchez “github”. Le plugin qui nous intéresse est celui-ci :

Cliquez “Install” et validez le popup qui s'affiche. Une fois l'extension installée, JupyterLab vous demandera de “Rebuild”. Cliquez Rebuild dans la barre bleue qui est apparue au dessus du gestionnaire des plugins. Après quelques instants, un popup qui confirme le succès du Rebuild s'affiche, cliquez sur Reload.

Observez maintenant le menu à gauche : si vous voyez une icône avec un chat : l'installation du plugin est un succès. Cliquez dessus. Ce plugin vous demande d'entrer un nom d'utilisateur Github afin d'accéder à ses dépôts.

Dans le cadre de l'atelier Données FAIR (FAIR Data), nous pouvons par exemple utiliser atterebf comme nom d'utilisateur. Une liste de dépôt github s'affiche, sélectionnez atelier_arhn, puis import_csv_xls, et enfin le carnet jupyter import_csv.ipynb (qui est en lecture seule).

Plugin jupyterlab-git

Pour les utilisateurs les plus avancés, maîtrisant le GIT, ce plugin peut vous être utile pour versionner vos travaux. Fermez toutes instances de JupyterLab.

Ouvrez un terminal, activez votre environnement virtuel (conda activate <envname>) et installez le package jupyterlab-git: pip install –upgrade jupyterlab-git

Lancez JupyterLab. Un message vous demandera d'installer les extensions jupyterlab-git et nbdime-jupyter. Acceptez. Patientez un moment le temps que le Rebuild se fasse.

Observez les onglets : l'icône de Git apparaît, allez-y dessus.

A la base, il n'y a aucun dépôt git reconnu. Cliquez Find a repository. Il vous menera en fait à l'onglet Explorateur de dossiers.

Vous avez la aussi une nouvelle icône Git à droite de la petite barre de menus en haut qui vous proposera de Cloner un dépôt (Clone a repository), ou bien allez dans un dossier qui vous intéresse avec l'explorateur de dossiers, positionnez vous dans le dossier concerné, allez sur “Git” dans le menu horizontal en haut, choisissez “Init”, un popup vous demande si vous êtes sûr de transformer le dossier en dossier git : confirmez. Attention, en fonction du volume du dossier, le traitement peut être long, privilégiez un dossier avec peu de fichiers.

Revenez sur l'onglet Git : vous verrez qu'il est possible de gérer les fichers. Les fichiers peuvent être “Untracked” (non suivis), “Changed” (modifiés mais non admis dans le prochain commit) ou “Staged” (admis dans le prochain commit). Plus bas dans la colonne, vous pouvez écrire le message du commit et envoyer le commit sur votre branche actuelle.

Plus haut vous pouvez aussi constater “Current Repository”, “Current Branch” qui vous permettra de gérer les branches.