bootstrap python package

Bootstrap-Python-Package

このテンプレートリポジトリは、Pythonパッケージを作成するためのボイラープレートを提供します。次のすべての機能で構成されています。

• ToxとPytestを使用したテストスイート
• MyPyを使用して入力します
• Ruffを使用した糸くず、セキュリティ、コード形式（ブラックコードスタイルとBanditセキュリティルールを使用）
• コードの品質とカバレッジチェックのためのCodeClimeとの統合
• CIパイプラインサポート：
  • 複数のPythonバージョンに対するテスト
  • Pypiでリリース
  • mkdocsを使用したGithubページのドキュメント
• Pycharmプロファイルの基本構成

このリポジトリテンプレートを使用して新しいパッケージを作成する方法

• このテンプレートを使用してGitHubリポジトリを作成します。 （ビッググリーンはUse this template ）
• bootstrap_python_packageディレクトリの名前を変更します
• bootstrap-python-packageとbootstrap_python_packageのすべての発生を検索して交換します
• 次の値を使用して、Pypiで保留中の信頼できる出版社を構成します。
  • PYPIプロジェクト名：GitHubリポジトリ名（この場合はbootstrap-python-package ）
  • 所有者：GitHubリポジトリの所有者（この場合はfebus982 ）
  • リポジトリ名：githubリポジトリ名（この場合はbootstrap-python-package ）
  • ワークフロー名： release.yml
• CODECLIMATE_REPORTER_IDという名前のsecret secret secret（url https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions ）を作成するCodeClimate Reporter ID（ https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter ）。 CodeClimateを使用したくない場合はworkflows/python-quality.ymlを削除するだけです。
• README.mdのバッジを更新してください！ （Shields.ioをチェックしてください。
• IDE設定でPycharm Copyrightプロファイルを更新：エディター|著作権|著作権プロファイル（使用したい場合）
• ローカル開発のセットアップ：
  • リポジトリをクローンします
  • 詩のpip install poetry
  • make dev-dependenciesをインストールします
  • （オプション） git commit中にフォーマットと糸くずが自動的に実行されるように、事前コミットとpre-commit installをインストールして実行することを強くお勧めします。
• GitHubページのセットアップ（ローカル開発セットアップが必要です）：
  • イニシャルドキュメントブランチpoetry run mike deploy dev latest --update-aliases --push
  • gh-pagesブランチから展開するようにgithubページを構成します（url https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages ）
  • main https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments gh-pages v*.*.*

重要：リポジトリは、テストPYPIリポジトリに展開するように構成されています。テストPYPIリポジトリでプロジェクトを作成し、展開パイプラインをテストすることを強くお勧めします。結果に満足したら、公式のPYPIリポジトリでプロジェクトを作成し、 workflows/release.ymlでマークされた行を削除します。

パッケージリリース

このセットアップでは、詩のダイナミックバージョンを使用します。これは、コードでバージョンをコミットする必要はないことを意味しますが、CIパイプラインはGitタグから推測します。

新しいバージョンをリリースするには、GitHubリポジトリに新しいリリースとタグを作成するだけです。

• PythonパッケージをPypiにビルドして展開します
• ドキュメントの新しいバージョンをgithubページにビルドして展開する

重要：デフォルトの構成には、リリース名とタグがコンベンションvX.XX （小文字vが前に先行するセマンティックバージョン）に従う必要があります。正しいバージョンをPypiで公開し、 vを省略します（つまり、 v1.0.0は1.0.0公開します）。

この形式はカスタマイズできます。詩のように跳ね返るドキュメントを参照してください

開発のためのコマンド

開発中に使用されるすべての一般的なコマンドは、Make Targetsを使用して実行できます。

• make dev-dependencies ：開発要件をインストールします
• make update-dependencies ：開発要件を更新します
• make fix ：コードスタイルとリントの自動修正を実行する（可能な場合）
• make test ：システムPythonバージョンに対してテストスイートを実行する
• make check ：利用可能なすべてのPythonバージョン、コードスタイル、糸くずのチェックに対してテストを実行する
• make type 、 make format 、 make lint 、 make bandit ：関連するチェックを実行します
• make docs ：MKDOCS Webサイトをローカルにレンダリングします