このプロジェクトについて
Copier-pythonは、モダンで意見の強いツールチェーンがあらかじめ組み込まれた、新しいPythonプロジェクトを作成するためのCopierテンプレートです。これはランタイムライブラリではなく、コマンドラインから指定したパスにプロジェクトを生成するために使用されます。
クイックスタート
- 前提条件をインストールします:ツールチェーン管理用のmise-en-placeと、Copier本体(例:`mise use -g copier` または `uv tool install copier` 経由)。
- `copier copy "gh:smkent/copier-python" /new/project/path` でプロジェクトを生成します。
- ドキュメントサイトに要件と詳細な使用方法が記載されています。
含まれるツール
- 開発ツールチェーンを管理するためのmise-en-place ("mise")。
- Astralツールセット:uv、ruff、ty。
- pre-commit互換のgit hooksを提供するprek。
- テストフレームワークとしてのpytest(codecov.ioをサポート)。
- プロジェクトドキュメント用のZensical(GitHub Pagesへの自動デプロイ付き)。
更新とリリースの自動化
- プロジェクトの更新はRenovateと`copier update`を通じてサポートされており、生成されたプロジェクトはテンプレートの変更を取り込むことができます。
- リリース自動化は、GitHub Actionsによって駆動されるPyPIパッケージの公開とコンテナイメージのビルドをカバーしています。
クレジット
このテンプレートはpawamoy/copier-uvおよびritwiktiwari/copier-astralからインスピレーションを得たとされています。リポジトリに含まれるライセンスの下で配布されており、PyPIにもcopier-pythonとして公開されています。
対象ユーザー
依存関係管理、リンティング/フォーマット、git hooks、テスト、ドキュメント、CI駆動のリリースがあらかじめ設定された、Pythonパッケージやアプリケーションの再現可能な開始点(スターティングポイント)を求める開発者。また、テンプレートが変更された際に、生成されたプロジェクトを更新し続けたい開発者に適しています。
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.