Pakete erstellen

  1. Notebooks sind gut geeignet um schnell voranzukommen, doch bei umfangreicher werdendem Code empfiehlt sich, stabilen Code in Pakete auszulagern.

  2. Ihr könnt pytest nicht nur innerhalb eurer Notebooks zum Testen verwenden, sondern auch innerhalb eurer Pakete.

  3. Verwendet Clean Code-Prinzipien mit aussagekräftigen Variablen- und Funktionsnamen, kommentiert sinnvoll und modularisiert den Code.

    Es gibt auch Werkzeuge, die automatisch Coding-Styles anwenden wie z.B. PEP 8 für Python. Mit jupyter-autopep8 könnt ihr dies nicht nur auf eure Notebooks anwenden, sondern z.B. mit black auch auf eure Python-Pakete.

    Für andere Sprachen findet ihr Übersichten in Awesome-Linters und awesome-code-formatters.

    Ihr könnt diese Werkzeuge mit einem Pre-Commit-Hock automatisch vor jedem git commit ausfähren, z.B. mirrors-autopep8, pygrep-hooks oder blacken-docs. Eine gute Übersicht über verfügbare Git Pre-Commit-Hocks erhaltet ihr auf pre-commit.com.