cookiecutter hatch pypackage

cookiecutter hatch pypackage

最先端の Python パッケージの Cookiecutter テンプレート: Hatch 、 ruff 、 mypy 、 GitHub Actionsなど!

詳細
特徴

特徴

• 軽量スターター
• Hatchパッケージの管理
• hatch-vcs: git タグからパッケージのバージョンを自動的に決定します (例: v0.9
• isort、flake8、black などを置き換えるruffによるリンティングとフォーマット。
• mypyによる型チェック
• deptryを使用して未使用、欠落、推移的な依存関係をチェックする
• オプションの asyncio セットアップを使用したpytestによる単体テスト。
• Hatch-env-matrics を使用してテストを自動化および標準化する
• MkDocs のマテリアルを使用したドキュメントと、mkdocstrings を使用した docstring 参照のサポート。
• dependabot 、 release-drafter 、 labeler 、 publish to PYPI workflows 、 publish to test PYPI workflowsなどを備えた、すぐに使える GitHub Actions パイプライン。
• hatch-pip-compile: ロックファイルの実験的サポート、
• pyproject.toml: すべてのパッケージ、ビルド、ツール構成を 1 つのファイルにまとめたもの。
• カバレッジ: pytest 統合を使用して Python プログラムのコード カバレッジを測定するツール、
• pre-commit: 作業を容易にする事前コミット git フック。
• Markdown: reStructuredText の代わりに、Markdown がすべてのテキスト ファイルに一貫して使用されます。
• EditorConfig: 複数の開発者に対して一貫したコーディング スタイルを維持します。
• src-layout: 実際の Python パッケージはsrcフォルダーの下に保存され、多くの一般的なエラーを回避します。

?クイックスタート

プロジェクトを生成します。

このプロジェクトでは、 pipx使用して、隔離された環境にhatchインストールします。次のコマンドを実行する前に、 pipxがインストールされていることを確認してください。

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

ジェネレーターは最後に、 hatch env create & git init自動的に呼び出します。

次に、 GitHub Actions pipelines正しく動作するには、次のことを行う必要があります。

• Codecovで GitHub リポジトリを有効にします。
• GitHub リポジトリ シークレットにCODECOV_TOKEN設定します。対応するプロジェクトの Codecov 設定で確認できます。
• GitHub Actionsソースを使用してGitHub Pages有効にします。
• テストのために Test PyPIに公開するオプション。
• PyPI で信頼された発行者メソッドを構成します。これは、パッケージを PyPI にプッシュする最新の安全な方法です。

クラフトで

cruft は Cookiecutter の上のレイヤーで、生成後にテンプレートからプロジェクトを更新できます。

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

デモ

ライセンス

このプロジェクトは、MIT ライセンスの条件に基づいてライセンスされています。