bootstrap python package

Bootstrap-Python-Package

Dieses Vorlagen -Repository bietet das Boilerplate, um ein Python -Paket zu erstellen. Es ist mit allen folgenden Funktionen konfiguriert:

• Testsuite mit Tox und PyTest
• Tippen mit MyPy
• LINTING-, Sicherheits- und Codeformat mit RUFF (mithilfe von Sicherheitsregeln des Black -Code -Stils und Banditen)
• Integration mit CodeClimate für Codequalität und Deckungsprüfungen
• CI -Pipeline unterstützend:
  • Testen gegen mehrere Python -Versionen
  • Veröffentlichungen auf pypi
  • GitHub -Seitendokumentation unter Verwendung von MKDOCs
• Pycharm -Profil grundlegende Konfiguration

So verwenden Sie diese Repository -Vorlage, um ein neues Paket zu erstellen

• Erstellen Sie Ihr GitHub -Repository mit dieser Vorlage. (Die große Grün Use this template -Taste)
• Benennen Sie das Verzeichnis bootstrap_python_package
• Suchen und ersetzen Sie alle Vorkommen von bootstrap-python-package und bootstrap_python_package
• Konfigurieren Sie einen anstehenden vertrauenswürdigen Publisher auf PYPI mit den folgenden Werten:
  • PYPI-Projektname: Der Name GitHub Repository (in diesem Fall bootstrap-python-package )
  • Eigentümer: Der Github -Repository -Eigentümer (in diesem Fall febus982 )
  • Repository-Name: Der GitHub-Repository-Name (in diesem Fall bootstrap-python-package )
  • Workflow -Name: release.yml
• Erstellen Sie ein GitHub -Aktionen Secret namens CODECLIMATE_REPORTER_ID (unter url https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions ), die die Codeclimate -Reporter -ID enthalten https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter ). Wenn Sie Codeclimate nicht verwenden möchten, löschen Sie einfach workflows/python-quality.yml .
• Aktualisieren Sie die Abzeichen in README.md ! (Überprüfen Sie Shields.io auf zusätzliche Abzeichen)
• Aktualisieren Sie das Pycharm Copyright -Profil in den IDE -Einstellungen: Editor | Copyright | Urheberrechtsprofile (wenn Sie es verwenden möchten)
• Lokale Entwicklung einrichten:
  • Klonen Sie das Repository
  • Installieren Sie Poesie pip install poetry
  • make dev-dependencies
  • (optional) Es wird dringend empfohlen, das Vorverfahren zu installieren und pre-commit install auszuführen, damit das Formatieren und Linieren während git commit automatisch ausgeführt werden.
• Setup -GitHub -Seiten einrichten (diese erforderliche lokale Entwicklungsanlage):
  • Initialise Dokumentation Branch poetry run mike deploy dev latest --update-aliases --push
  • Konfigurieren Sie GitHub-Seiten, um sie aus der gh-pages -Filiale bereitzustellen (unter URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages )
  • Fügen Sie den main und die v*.*.* Tag-Regeln der Liste "Bereitstellungszweige und Tags" in der Umgebung gh-pages hinzu (in der URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments ))

Wichtig: Das Repository ist so konfiguriert, dass sie im Test PYPI -Repository bereitgestellt werden. Es wird dringend empfohlen, das Projekt im Test PYPI -Repository zu erstellen und die Bereitstellungspipeline zu testen. Wenn Sie mit dem Ergebnis zufrieden sind, erstellen Sie das Projekt im offiziellen PYPI -Repository und entfernen Sie die markierten Linien in workflows/release.yml .

Paketveröffentlichung

Dieses Setup verwendet Poesie-Dynamic-Versionen. Dies bedeutet, dass es nicht notwendig ist, die Version im Code zu begehen, aber die CI -Pipeline schließt sie aus dem Git -Tag.

Um eine neue Version zu veröffentlichen, erstellen Sie einfach eine neue Version und Tag im Github -Repository, um:

• Erstellen und bereitstellen Sie das Python -Paket in PYPI
• Erstellen und bereitstellen eine neue Version der Dokumentation auf GitHub -Seiten

Wichtig: Die Standardkonfiguration erfordert den Freigabennamen und das Tag, um dem Kongress vX.XX zu folgen (semantische Versioning, die von Kleinbuchstaben v vorangetrieben wird). Es wird die richtige Version auf PYPI veröffentlichen und das v weglassen (dh v1.0.0 wird 1.0.0 veröffentlichen).

Dieses Format kann angepasst werden, siehe Dokumente von Poesie-Dynamic-Versionen

Befehle für die Entwicklung

Alle während der Entwicklung verwendeten gemeinsamen Befehle können mit Make -Targets ausgeführt werden:

• make dev-dependencies : Installieren Sie die Entwicklungsanforderungen
• make update-dependencies : Aktualisieren Sie die Entwicklungsanforderungen
• make fix : Rühren Sie den Code -Stil und die automatischen Fixes FININT aus (wenn möglich)
• make test : Führen Sie die Testsuite gegen System -Python -Version aus
• make check : Führen Sie Tests gegen alle verfügbaren Python -Versionen, Codestil und Lintprüfungen aus
• make type , make format , make lint , make bandit : Führen Sie den entsprechenden Scheck aus
• make docs : Rendern Sie die MKDOCS -Website lokal