cookiecutter hatch pypackage

cookiecutter hatch pypackage

Cookiecutter-Vorlage für ein hochmodernes Python-Paket: Hatch , ruff , mypy , GitHub Actions und mehr!

Details
Merkmale

Merkmale

• Leichter Starter
• Hatch Paketverwaltung
• hatch-vcs: Ermitteln Sie die Paketversion automatisch anhand von Git-Tags, z. B. v0.9
• Flusen und Formatieren mit ruff , das Isort, Flake8, Black usw. ersetzt.
• Typprüfung mit mypy
• Überprüfen Sie ungenutzte, fehlende und transitive Abhängigkeiten mit deptry
• Unit-Tests mit pytest mit optionalem Asyncio-Setup.
• Automatisieren und standardisieren Sie Tests mit Hatch-env-matrices
• Dokumentation mit Material für MkDocs und Docstring-Referenzunterstützung mit mkdocstrings.
• Gebrauchsfertige GitHub Actions-Pipelines mit dependabot , release-drafter , labeler , publish to PYPI workflows , publish to test PYPI workflows und mehr.
• hatch-pip-compile: experimentelle Unterstützung für Sperrdateien,
• pyproject.toml: alle Paket-, Build- und Toolkonfigurationen in einer Datei,
• Abdeckung: Tool zur Messung der Codeabdeckung von Python-Programmen mit Pytest-Integration,
• Pre-Commit: Pre-Commit-Git-Hooks, die Ihnen das Leben erleichtern,
• Markdown: Anstelle von reStructuredText wird Markdown konsistent für alle Textdateien verwendet.
• EditorConfig: Pflegen Sie konsistente Codierungsstile für mehrere Entwickler.
• src-Layout: Das eigentliche Python-Paket wird in einem src -Ordner gespeichert, wodurch viele häufige Fehler vermieden werden.

? Schnellstart

Generieren Sie das Projekt:

In diesem Projekt wird pipx verwendet, um hatch in einer isolierten Umgebung zu installieren. Stellen Sie sicher, dass pipx installiert ist, bevor Sie den folgenden Befehl ausführen.

cookiecutter https://github.com/Aviksaikat/cookiecutter-hatch-pypackage

Der Generator ruft am Ende automatisch hatch env create & git init .

Damit die GitHub Actions pipelines ordnungsgemäß funktionieren, sollten Sie Folgendes tun:

• Aktivieren Sie das GitHub-Repository in Codecov .
• Legen Sie CODECOV_TOKEN in Ihren GitHub-Repository-Geheimnissen fest. Sie finden es in den Codecov-Einstellungen des entsprechenden Projekts.
• Aktivieren Sie GitHub Pages mithilfe der GitHub Actions .
• Option zur Veröffentlichung auf Test PyPI zum Testen.
• Konfigurieren Sie die Trusted Publisher-Methode auf PyPI: Es handelt sich um eine moderne und sichere Methode, um Ihr Paket an PyPI zu übertragen.

Mit Cruft

cruft ist eine Ebene über Cookiecutter, die es Ihnen ermöglicht, Ihr Projekt nach der Generierung anhand der Vorlage zu aktualisieren.

cruft create https://github.com/Aviksaikat/cookiecutter-hatch-pypackage

Demo

Lizenz

Dieses Projekt ist unter den Bedingungen der MIT-Lizenz lizenziert.