Seminar JupyterLab – Erweiterungen entwickeln und integrieren

Inhaltsverzeichnis

Beschreibung

Eigene Erweiterungen können wiederkehrende Arbeitsschritte direkt in JupyterLab zugänglich machen. Das Seminar vermittelt die dafür benötigte Plugin-Architektur und einen überschaubaren Entwicklungsablauf. Ausgangspunkt ist eine vorbereitete Entwicklungsumgebung mit kompatiblen Werkzeugversionen. Eine kleine Erweiterung ergänzt einen Befehl, eine bedienbare Oberfläche und konfigurierbare Einstellungen, statt zahlreiche unverbundene Funktionen anzureißen.

Die Umsetzung berücksichtigt den Lebenszyklus der Oberfläche, die Behandlung asynchroner Fehler und die Trennung zwischen Browser und Server. Abschließend wird die Erweiterung als vorgebautes Paket installiert und in einer sauberen Umgebung geprüft. Ein serverseitiger Endpunkt wird als kontrollierte Integration behandelt, sofern er für das Beispiel benötigt wird. Komplexe Dokumenteditoren und die Entwicklung eigener Kernel sind keine Bestandteile dieses Grundlagenkurses für Erweiterungsentwickler.

Lernziele

• Die Aufgaben von Erweiterungen, Plugins, Tokens und bereitgestellten Diensten erklären.
• Eigene Befehle und Oberflächenelemente in JupyterLab integrieren.
• Einstellungen, Fehlerzustände und Ressourcenfreigabe nachvollziehbar implementieren.
• Eine Erweiterung paketieren, in einer frischen Umgebung installieren und gezielt testen.

Seminarinhalte

1. Entwicklungsumgebung und Architektur
2. Befehle und Oberflächenintegration
3. Dokumente und Anwendungskontext
4. Einstellungen und robuste Bedienung
5. Serverintegration und Berechtigungen
6. Paketierung und Kompatibilität
7. Tests und Fehlersuche
8. Eigenständige Erweiterungsaufgabe

Entwicklungsumgebung und Architektur

• Kompatible Versionen von JupyterLab, Node.js und Python-Werkzeugen festlegen.
• Ein Erweiterungsprojekt aus einer passenden Projektstruktur aufsetzen.
• Plugin-Aktivierung, Abhängigkeiten und bereitgestellte Dienste nachvollziehen.

Befehle und Oberflächenintegration

• Einen Befehl registrieren und über Menü oder Befehlspalette zugänglich machen.
• Ein einfaches Bedienfeld mit den passenden JupyterLab- und Lumino-Bausteinen erstellen.
• Aktivierungsbedingungen und nachvollziehbare Beschriftungen definieren.

Dokumente und Anwendungskontext

• Auf das aktive Notebook oder ausgewählte Dokument gezielt zugreifen.
• Ereignisse und Zustandsänderungen kontrolliert verarbeiten.
• Abonnements und Oberflächenobjekte beim Schließen wieder freigeben.

Einstellungen und robuste Bedienung

• Konfiguration mit einem passenden Einstellungsschema bereitstellen.
• Asynchrone Vorgänge, leere Zustände und Fehlerfälle verständlich behandeln.
• Die Erweiterung ohne unnötige Eingriffe in globale Anwendungseinstellungen gestalten.

Serverintegration und Berechtigungen

• Browsercode und serverseitige Aufgaben klar trennen.
• Eine vorbereitete authentifizierte Schnittstelle ansprechen und Fehlerrückgaben auswerten.
• Eingaben serverseitig prüfen und die Grenzen von Frontend-Prüfungen verstehen.

Paketierung und Kompatibilität

• Vorgebaute Erweiterungen und quellbasierte Entwicklungsabläufe unterscheiden.
• Ein installierbares Paket erzeugen und Versionsabhängigkeiten festlegen.
• Installation und Deinstallation in einer sauberen Umgebung prüfen.

Tests und Fehlersuche

• Gezielte Funktions- und Oberflächentests für den Beispielumfang formulieren.
• Browserkonsole und Serverprotokolle zur Fehlerabgrenzung nutzen.
• Eine Änderung kontrolliert testen und die Paketversion nachvollziehbar erhöhen.

Eigenständige Erweiterungsaufgabe

• Eine vorgegebene Fachfunktion als kleine Erweiterung umsetzen.
• Fehlerfälle, Einstellungen und Installation anhand einer Prüfliste kontrollieren.
• Das Paket mit einer technischen Kurzbeschreibung für die interne Weitergabe vorbereiten.

Praktische Übungen

1. Ein Erweiterungsprojekt starten und einen eigenen Befehl in der Befehlspalette bereitstellen.
2. Ein Bedienfeld ergänzen, den aktiven Notebook-Kontext verwenden und Einstellungen auswerten.
3. Einen asynchronen Fehlerfall und das Schließen der Oberfläche kontrolliert behandeln.
4. Das Paket bauen, in einer frischen JupyterLab-Umgebung installieren und die Kernfunktion testen.