Skip to content

Commit

Permalink
📝 Move logging to Python basics
Browse files Browse the repository at this point in the history
  • Loading branch information
veit committed Dec 7, 2024
1 parent c960c6a commit 753d8c9
Showing 15 changed files with 25 additions and 1,011 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -43,6 +43,7 @@ Added
Removed
~~~~~~~

* 📝 Move logging to Python basics
* ✏️ Remove link to Objectivity/DB
* 📝 Move SOLID principles to Python Basics

8 changes: 4 additions & 4 deletions docs/intro.rst
Original file line number Diff line number Diff line change
@@ -58,10 +58,10 @@ Ab Kapitel 2 folgt das Tutorial dem Prototyp eines Forschungsprojekts:
<productive/dvc/index>`. Der Quellcode sollte in :doc:`Programmbibliotheken
verpackt werden <productive/packaging>` mit :doc:`Dokumentation
<productive/documenting>`, :doc:`Lizenz(en) <productive/licensing>`,
:doc:`Rests <productive/testing>` und :doc:`Logging
<productive/logging/index>`. Schließlich enthält das Kapitel Ratschläge zur
:doc:`Verbesserung der Codequalität <productive/qa/index>` und des
:doc:`sicheren Betriebs <productive/security>`.
:doc:`Rests <productive/testing>` und :doc:`python-basics:logging/index`.
Schließlich enthält das Kapitel Ratschläge zur :doc:`Verbesserung der
Codequalität <productive/qa/index>` und des :doc:`sicheren Betriebs
<productive/security>`.
#. :doc:`web/index` kann entweder Dashboards aus Jupyter-Notebooks generieren
oder eine umfassendere Anwendungslogik erfordern, wie in
:doc:`pyviz:bokeh/embedding-export/flask`, demonstriert, oder Daten über
6 changes: 3 additions & 3 deletions docs/productive/envs/uv/docker.rst
Original file line number Diff line number Diff line change
@@ -6,8 +6,8 @@ uns schneller neue Builds bereitzustellen. Dabei beginnen wir mit den Layern,
die sich am wenigsten ändern, damit wir die Artefakte so lange wie möglich
zwischenspeichern können. Dies ist auch der Grund, weswegen wir die
Installationen der Abhängigkeiten aus :file:`uv.lock` und Installation unserer
:doc:`Anwendung <python-basics:apps>` strikt getrennthalten – wahrscheinlich
ändert sich unser Code schneller als der der Abhängigkeiten.
:doc:`Anwendung <python-basics:packs/apps>` strikt getrennthalten –
wahrscheinlich ändert sich unser Code schneller als der der Abhängigkeiten.

.. seealso::
* `Order your layers
@@ -197,7 +197,7 @@ Installationen der Abhängigkeiten aus :file:`uv.lock` und Installation unserer

Zeilen 29–30:
Wenn eure Anwendung kein :doc:`Python-Paket
<python-basics:libs/distribution>` ist, das mit ``uv sync`` installiert
<python-basics:packs/distribution>` ist, das mit ``uv sync`` installiert
wurde, müsst ihr eure Anwendung hier in den Container kopieren.

Zeile 32:
2 changes: 1 addition & 1 deletion docs/productive/envs/uv/index.rst
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@

Sowohl die :ref:`Installation von uv <python-basics:uv>` wie auch das Erstellen
der Dateistrukturen für :ref:`Bibliotheken
<python-basics:uv-package-structure>` oder :doc:`python-basics:apps` sind
<python-basics:uv-package-structure>` oder :doc:`python-basics:packs/apps` sind
bereits in unserem :doc:`python-basics:index`-Tutorial beschrieben.

.. _inline-script-metadata:
2 changes: 1 addition & 1 deletion docs/productive/git/advanced/gitlab/ci-cd.rst
Original file line number Diff line number Diff line change
@@ -69,7 +69,7 @@ Jobs
.. seealso::
* `GitLab Docs: Jobs
<https://docs.gitlab.com/ee/ci/jobs/index.html>`_
* :doc:`python-basics:libs/cibuildwheel`
* :doc:`python-basics:packs/cibuildwheel`
* :ref:`pre-commit Hooks <pre-commit-in-gitlab-ci>`
* :ref:`Lizenzieren <reuse-in-gitlab-ci>`

7 changes: 4 additions & 3 deletions docs/productive/index.rst
Original file line number Diff line number Diff line change
@@ -26,8 +26,9 @@ Es gibt diverse Werkzeuge, die Euch beim Erstellen von gemeinsam nutzbaren
Produkten unterstützen. Dies können Werkzeuge einerseits für die Versionierung
des :doc:`Quellcodes <git/index>` und der :doc:`Trainingsdaten <dvc/index>`
sowie für die Reproduzierbarkeit der :doc:`Ausführungsumgebungen <envs/index>`,
andererseits für das :doc:`testing`, :doc:`logging/index`, :doc:`Dokumentieren
<documenting>` und :doc:`Erstellen von Paketen <python-basics:libs/index>` sein.
andererseits für das :doc:`testing`, :doc:`python-basics:logging/index`,
:doc:`Dokumentieren <documenting>` und :doc:`Erstellen von Paketen
<python-basics:libs/index>` sein.

.. seealso::

@@ -56,6 +57,6 @@ andererseits für das :doc:`testing`, :doc:`logging/index`, :doc:`Dokumentieren
licensing
cite/index
testing
logging/index
logging
qa/index
security
4 changes: 2 additions & 2 deletions docs/productive/licensing.rst
Original file line number Diff line number Diff line change
@@ -504,8 +504,8 @@ Python-Paket-Metadaten

Mit :pep:`658` wird die :file:`METADATA`-Datei aus Distributionen in der
:pep:`503`-Repository-API auf :term:`PyPI` verfügbar. Damit können die Metadaten
der :doc:`Verteilungspakete <python-basics:libs/distribution>` analysiert werden
ohne dass das ganze Paket heruntergeladen werden muss.
der :doc:`Verteilungspakete <python-basics:packs/distribution>` analysiert
werden ohne dass das ganze Paket heruntergeladen werden muss.

In Python-Paketen gibt es noch weitere Felder, in denen Lizenzinformationen
gespeichert werden, wie die `Core metadata specifications
5 changes: 5 additions & 0 deletions docs/productive/logging.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Logging
=======

Eine Einführung in Logging erhaltet ihr in unserem Python-Basics-Tutorial:
:doc:`python-basics:logging/index`.
25 changes: 0 additions & 25 deletions docs/productive/logging/development.ini

This file was deleted.

Loading

0 comments on commit 753d8c9

Please sign in to comment.