Update python module notebook

programmierspass/Develop_and_publish_modul.ipynb

@@ -137,7 +137,7 @@
    "id": "0cbf8602",
    "metadata": {},
    "source": [
-    "### Struktur\n",
+    "### Beispiel für ein minimales Projekt\n",
     "\n",
     "```\n",
     "pypi-example/\n",
@@ -155,7 +155,7 @@
    "id": "8b3f6ddf",
    "metadata": {},
    "source": [
-    "### pyproject.toml\n",
+    "### pyproject.toml - Konfiguration von Metadaten\n",
     "\n",
     "```toml\n",
     "[build-system]\n",
@@ -174,14 +174,16 @@
     "\n",
     "classifiers = [\n",
     "    \"Programming Language :: Python :: 3\",\n",
-    "    \"License :: OSI Approved :: MIT License\",\n",
+    "    \"License :: OSI Approved :: Apache Software License\",\n",
     "    \"Operating System :: OS Independent\",\n",
     "]\n",
     "\n",
     "[project.urls]\n",
     "\"Homepage\" = \"https://...\"\n",
     "\"Bug Tracker\" = \"https://...\"\n",
-    "```"
+    "```\n",
+    "\n",
+    "- Weitere Informationen zu den einzelnen Angaben: https://packaging.python.org/en/latest/specifications/declaring-project-metadata/#declaring-project-metadata"
    ]
   },
   {
@@ -240,17 +242,7 @@
    "source": [
     "### Package für den Upload erzeugen\n",
     "\n",
-    "- Für die Erzeugung der zum Upload benötigten Dateien, muss zuerst in den Projektordner navigiert werden, und dort die folgende Befehle ausgeführt werden:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0251a377",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!pip install --upgrade build"
+    "- Für die Erzeugung der zum Upload benötigten Dateien, muss zuerst in den Projektordner navigiert werden, und dort die folgende Befehle ausgeführt werden."
    ]
   },
   {
@@ -258,17 +250,11 @@
    "id": "68e05d16",
    "metadata": {},
    "source": [
-    "- Jetzt sollten alle benötigten Pakete installiert sein."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "92583304",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!python -m build"
+    "- Zuerst müssen für den Build benötigten Pakete installiert werden.\n",
+    "\n",
+    "```\n",
+    "pip install --upgrade build\n",
+    "```"
    ]
   },
   {
@@ -276,7 +262,11 @@
    "id": "3cf7b4cd",
    "metadata": {},
    "source": [
-    "- Dieser Befehl erstellt anhand der `pyproject.toml` alle benötigten Dateien und legt diese in den Ordner `dist` im Projektordner."
+    "- Dann kann anhand der `pyproject.toml` das Package erstellt werden. Dieses wird in den Ordner `dist` im Projektordner gespeichert.\n",
+    "\n",
+    "```\n",
+    "python -m build\n",
+    "```"
    ]
   },
   {
@@ -287,12 +277,12 @@
     "- Wenn die Befehle korrekt ausgeführt werden konnten, dann sollte die letzte Zeile so lauten:\n",
     "\n",
     "```\n",
-    "Successfully built Pypiex-0.0.1.tar.gz and Pypiex-0.0.1-py3-none-any.whl\n",
+    "Successfully built xyz-version.tar.gz and xyz-version-py3-none-any.whl\n",
     "```\n",
     "\n",
-    "- Außerdem sollten zwei Dateien im Ordner `dist` erzeugt worden sein.\n",
-    "- Die Datei mit der Endung `.whl` ist eine Wheel-Datei.\n",
-    "- Die Datei mit der Endung `.tar.gz` TODO"
+    "- Außerdem sollten zwei Dateien im Ordner `dist` erzeugt worden sein. Es gibt verschiedene Arten von Packages.\n",
+    "- Die Datei mit der Endung `.tar.gz` ist eine Source Distribution.\n",
+    "- Die Datei mit der Endung `.whl` (Wheel-Datei) ist eine Built Distribution. Dieses Format ist neuer und hat verschiedene Vorteile. Die Details sind an dieser Stelle nicht relevant. "
    ]
   },
   {
@@ -300,9 +290,13 @@
    "id": "a87cd03e",
    "metadata": {},
    "source": [
-    "### Package auf Testserver hochladen\n",
+    "### Package auf den Testserver hochladen\n",
     "\n",
-    "- Um Pakete hochladen zu können muss zuerst ein Account erstellt werden. Der PyPI Testserver ist unabhängig von der Produktionsumgebung und es werden jeweils eigene Accounts benötigt."
+    "- Um Pakete hochladen zu können muss zuerst ein Account erstellt werden. \n",
+    "\n",
+    "<div class=\"alert alert-info\">\n",
+    "<b>Hinweis</b> Der PyPI Testserver ist unabhängig von der Produktionsumgebung und es werden jeweils eigene Accounts benötigt.\n",
+    "</div>   "
    ]
   },
   {
@@ -310,17 +304,11 @@
    "id": "1444d33a",
    "metadata": {},
    "source": [
-    "- Jetzt muss ein `API token` generiert werden. Dies kann man unter folgendem Link: https://test.pypi.org/manage/account/#api-tokens. In den Kontoeinstellungen im Bereich `API-Token`. Der Geltungsbereich kann auf `Gesamtes Konto` gestellt werden. Das erstellte Token muss direkt gesichert werden, da es danach nicht mehr einsehbar ist."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "e2a24a2c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!pip install --upgrade twine"
+    "- Jetzt muss ein `API token` generiert werden. Dies geschieht in den Kontoeinstellungen im Bereich `API-Token`. Folgender Link führt automatisch dort hin: https://test.pypi.org/manage/account/#api-tokens. Auf `API-Token hinzufügen` klicken. Dort einen sinnvollen Namen vergeben und den Geltungsbereich auf `Gesamtes Konto` stellen.\n",
+    "\n",
+    "<div class=\"alert alert-info\">\n",
+    "<b>Hinweis</b> Ein erstelltes Token muss direkt gesichert werden, da es danach nicht mehr einsehbar ist.\n",
+    "</div>"
    ]
   },
   {
@@ -328,17 +316,11 @@
    "id": "abf06326",
    "metadata": {},
    "source": [
-    "- Diese Zeile lädt und installiert die benötigten Packages."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "545fac45",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "python -m twine upload --repository testpypi dist/*"
+    "- Jetzt die für den Upload benötigten Packages laden und installieren:\n",
+    "\n",
+    "```\n",
+    "pip install --upgrade twine\n",
+    "```"
    ]
   },
   {
@@ -346,7 +328,12 @@
    "id": "325e2694",
    "metadata": {},
    "source": [
-    "- Diese Zeile führt den Upload aus. Hierbei wird nach dem Username und Passwort gefragt. Für den Username muss `__token__` verwendet werden und für Passwort das gerade erstelle Token inklusive des `pypi` Prefix.\n",
+    "- Und dann den Upload ausführen. Hierbei wird nach dem Username und Passwort gefragt. Für den Username muss `__token__` verwendet werden und für Passwort das gerade erstelle Token inklusive des `pypi` Prefix.\n",
+    "\n",
+    "\n",
+    "```\n",
+    "python -m twine upload --repository testpypi dist/*\n",
+    "```\n",
     "\n",
     "<div class=\"alert alert-info\">\n",
     "<b>Hinweis</b> Soll eine neue Version für ein Paket hochgeladen werden, dann muss vor der Erzeugung des Pakets immer zuerst die Versionsnummer in der `pyproject.toml` angepasst werden. Eine Version kann immer nur ein Mal hochgeladen werden. \n",
@@ -384,10 +371,21 @@
     "example.say_hello(\"Frederik\")"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "2a17f85c",
+   "metadata": {},
+   "source": [
+    "## Literatur\n",
+    "\n",
+    "- https://packaging.python.org/en/latest/tutorials/packaging-projects/\n",
+    "- https://setuptools.pypa.io/en/latest/userguide/index.html"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "558819c3",
+   "id": "ee4663eb",
    "metadata": {},
    "outputs": [],
    "source": []