Skip to content

Dokumentation des Testers

Das Readme-File sollte auf jeden Fall folgende Dinge enthalten:

  • Hinzufügen des Paket-Repositrys, da nicht vorgesehen ist, das Paket auf PyPI hochzuladen.
  • Installieren des Paketes in einem VENV (sowohl produktiv als auch zu development-zwecken)
  • Informationen zur Installation von Development-Dependencies

Außerdem sollten zumindest folgende Dinge enthalten sein:

  • Wie wird mit dem Tester gearbeitet (wichtigste Argumente)
  • --list-tests zum Auflisten aller vom Tester gefundenen Tests
  • --run-tests zum Ausführen eines oder mehrerer Tests
  • ...