ホーム>プログラミング関連>AI ソースコード
ダウンロード

Scientific Python：ガイド、Cookie、およびSP-Repo-Review

クッキー

Scientific Python開発者ガイドに基づいた新しいPythonプロジェクト用のコピー機/Cookiecutterテンプレート。これをPythonパッケージの他のテンプレートと違うのは何ですか？

  • Scientific-Python Development Guide：すべての決定が明確に文書化され、すべてのツールが記述され、すべてが同期されています。
  • パッケージの構築用に選択できる9つの異なるバックエンド。
  • ほとんどのバックエンドのオプションのVCSバージョン。
  • NOXを使用してGitHubアクションでテストされたテンプレート生成。
  • コピー機、Cookeiecutter、およびCruftとの世代をサポートします。
  • github.com URL（デフォルト）をターゲットにする場合はGitHubアクションをサポートし、それ以外の場合は実験的なGitLab CIサポートを追加します。
  • Pybind11を使用したいくつかのコンパイルされたバックエンドが含まれており、Cibuildwheelを使用してすべてのプラットフォーム用にホイールが生成されます。
  • ガイドと統合されたWebAssemblyバージョンを使用して、ガイドラインに対して既存のレポスを評価するためのsp-repo-reviewを提供します。すべてのチェックが架橋されています。
  • PYPAのベストプラクティスに従い、定期的に更新されます。

Scientific-Python Development Guideを最初に読んだことがあり、おそらく1つまたは2つのプロジェクトでそれらを使用したことを確認してください。これは最小限の例やチュートリアルではありません。 Cookeiecutterを使用して新しいプロジェクトを開始するか、既存のプロジェクトの個々のファイルにコピーするための有用なツールのコレクションです（ {{cookiecutter.project_name}}/ ）。

世代中に、パッケージの次のバックエンドから選択できます。

  1. ハッチ：これは、ハッチリングを使用しています。ハッチリングは、ファイルを包含する素敵なモダンなビルダーであり、プラグインを介して拡張可能です。 （純粋なPythonプロジェクトに推奨）
  2. フリット：純粋なPythonプロジェクト向けのモダンで軽量のPEP 621ビルドシステム。 setuptools、no manifest.in、setup.py、またはsetup.cfgを置き換えます。低学習曲線。新しいディストリビューションに簡単にブートストラップします。適切なファイルを入手するのが難しい、ほとんど動的なメタデータサポートはありません。
  3. PDM：基準をサポートする純粋なPythonプロジェクトに対するモダンで意見の少ないオールインワンソリューション。 Setuptools、Venv/Pipenv、Pip、Wheel、Twineを交換します。 PEP 621をサポートします。
  4. 詩：純粋なPythonプロジェクトのオールインワンソリューション。 Setuptools、Venv/Pipenv、Pip、Wheel、Twineを交換します。より高い学習曲線ですが、オールインワンです。ライブラリのいくつかの悪いデフォルトの仮定を作成します。非標準のpyproject.toml configを持つ唯一のもの。
  5. SetUptools：クラシックビルドシステムですが、新しい標準化された構成があります。
  6. pybind11：これは断つ断裂ですが、pybind11で書かれたC ++拡張機能とCibuildwheelによって生成されたホイールを使用しています。
  7. scikit-build：Scikit-build11を使用したScikit-build（cmake）プロジェクトもScikit-build-coreを使用しています。 （C ++プロジェクトに推奨）
  8. Meson-Python：Pybind11を使用するMesonプロジェクト。 （VCSバージョン化なし）
  9. Maturin：Rustバイナリエクステンション用のPEP 621ビルダー。 （VCSバージョン化なし） （錆プロジェクトに推奨）

現在、最良の選択は、おそらく純粋なPythonプロジェクトのハッチであり、バイナリプロジェクトのScikit-Build（Scikit-Build-Core + Pybind11選択など）です。

使用する（最新のコピー機バージョン）

copierとcopier-templates-extensionsをインストールします。 PIPXを使用して、それは次のとおりです。 

pipx install copier
pipx inject copier copier-templates-extensions

次に、コピー機を実行してプロジェクトを生成します。 

copier copy gh:scientific-python/cookie < pkg > --trust

（ <pkg>は新しいプロジェクトを配置するための道です。コピー機が古い場合は、 --UNSAFE --trustの代わりに使用します。

回答の検証でより良いCLI体験が得られます。また、 .copier-answers.ymlファイルを取得します。これにより、将来更新を実行できます。

注：add --vcs-ref=HEAD latedバージョンの代わりに最新バージョンを取得します。ヘッドは常にテストに合格します（そして、CookeiCutterが使用するものです）。

使用する（クラシッククッカーバージョン）

Brewを使用する場合は、 brew install cookiecutterそれ以外の場合はpipx install cookiecutter （または以下のコマンドにpipx runをprependし、インストールをスキップします）。その後、実行： 

cookiecutter gh:scientific-python/cookie

cookecutter 2.2.3+を使用している場合、コピー機のようなオプションの素晴らしい説明が得られます！

使用する（クラシッククルフトバージョン）

Cruftを使用することもできます。Cruftは、Cookiecutterプロジェクトに機能を追加する能力を追加することもできます。 pipx install cruft pipx runインストールします。その後、実行： 

cruft create gh:scientific-python/cookie

ポストジェネレーション

キーセットアップファイル、 pyproject.toml 、および場合によってはsetup.cfgおよびsetup.py （pybind11の例）を確認してください。 README.mdを更新します。また、 docs/にドキュメントを更新して追加します。

いくつかの例の依存関係と3.9の最小Pythonバージョンがあります。実際に必要/必要なものに変更してください。また、小さなタイピングの例がある基本的なバックポート構造もあります。

コンポーネントが含まれています：

  • GitHubアクションは、世代自体のテストを実行します
    • NOXを使用するため、Cookie開発はローカルでチェックできます
  • githubアクションの展開
    • C ++バックエンドには、ホイールビルド用のCibuildwheelが含まれます
    • Pypi Trusted Publisherの展開を使用します
  • Depenabotは、有用なプルリクエストを通じて、アクションを定期的に最新の状態に保ちます
  • 事前コミットで処理されるフォーマット
    • 新しいプロジェクトに厳格にならない理由はありません。あなたが望んでいないものを削除します。
    • mypy -staticタイピングが含まれています
    • Ruff -Standardフォーマット、糸くず、オートフィックスが含まれます
      • flake8、isort、pyupgrade、yesqa、pycln、および数十のプラグインを置き換えます
    • スペルチェックが含まれています
  • Pylint Noxターゲットを使用してPylintを実行できます。
  • Readthedocs対応のSphinxドキュメントフォルダーと[docs] extra
  • テストフォルダーとpytest [test]追加
  • Noxfileは、いくつかの一般的なターゲットに含まれています

開発者向け：

NOXでローカルでテストできます。 

# See all commands
nox -l

# Run a specific check
nox -s "lint(scikit-build)"

# Run a noxfile command on the project noxfile
nox -s "nox(hatch)" -- docs

ローカルにnoxを持っていない場合は、 pipx run noxを使用できます。

他の同様のプロジェクト

Hypermodern-Pythonは、各機能の優れたドキュメントや使用されている同じツールの多くのような、多くの類似点をチェックする価値のあるもう1つのプロジェクトです。特徴のセットがわずかに異なり、GitHubアクションに焦点が合っています。ほとんどのガイドは、GHAを使用したくない場合は、別のCIシステムにかなり簡単に適応できます。また、詩の使用を強制します（バックエンドの選択をする代わりに）、コンパイルされたプロジェクトをサポートしていません。現在、すべての開発依存関係を共有環境に捨て、長い解決と紛争の可能性を高めています。また、使用することを意図した方法で事前にコミットすることも使用しません。また、かなりのカスタムコードがあります。

歴史

多くのガイド、cookecutter、およびrepo-reviewは、Scikit-hepの一部として始まりました。これらのプロジェクトは、2023年のScientific-Python Developers Summitで、NSLS-IIガイドと統合され、一般化され、組み合わされました。

SP-Repo-Review

sp-repo-review Repo-ReviewのScientific-Python/CookieのScientific-Python開発ガイドに基づいたチェックを提供します。

このツールは、リポジトリのスタイルを確認できます。このように使用： 

pipx run ' sp-repo-review[cli] ' < path to repository >

これにより、結果のリストが生成されます。グリーンチェックマークは、このルールが守られていることを意味し、Red Xはルールがそうではないことを意味します。黄色の警告サインは、以前の必要なチェックが失敗したため、小切手がスキップされたことを意味します。いくつかのチェックは失敗します、それは大丈夫です - 目標は、任意のチェックへの順守を強制することではなく、あなたの注意にすべての可能な問題をもたらすことです。最終的には、無視されているとチェックをマークする方法があるかもしれません。

たとえば、 GH101 、すべてのアクションファイルが素敵なname:フィールド。 CIで表示されているファイルベースの名前に満足している場合は、このチェックを単純に無視するだけでお気軽に注意する必要があります（今のところ視覚的に無視するだけで、無視されたチェックを指定する方法が最終的に追加される可能性があります）。

すべてのチェックは、少なくともScientific-Python Development Guideで何らかの形で言及されています。最初にそれを読む必要があります - あなたがそれらに従おうとしていない場合、いくつかのチェックは機能しないかもしれません。たとえば、ガイドラインでは、pytest構成がpyproject.tomlに配置されていることが指定されています。他の場所に配置すると、すべてのpytestチェックがスキップされます。

これはもともと、Scikit-hepのために科学的なPythonに移動する前に開発されました。

使用する他の方法

GitHubアクションを使用することもできます。 

- uses : scientific-python/cookie@<version>

または事前コミット： 

- repo : https://github.com/scientific-python/cookie
  rev : <version>
  hooks :
    - id : sp-repo-review

additional_dependenciesを使用して、 validate-pyprojectなどのプラグインを追加する場合は、CLI要件が含まれていることを確認するために"repo-review[cli]"も含める必要があります。

小切手のリスト

一般的な

  • PY001 ：pyproject.tomlがあります
  • PY002 ：readme。（md | rst）ファイルがあります
  • PY003 ：ライセンス*ファイルがあります
  • PY004 ：ドキュメントフォルダーがあります
  • PY005 ：テストフォルダーがあります
  • PY006 ：事前コミット構成があります
  • PY007 ：簡単なタスクランナー（NOX、TOX、PIXIなど）をサポートしています

Pyproject

  • PP002 ：適切なビルドシステムテーブルがあります
  • PP003 ：ホイールをビルドデップとしてリストしません
  • PP004 ：上限Pythonには必要ありません
  • PP301 ：PyprojectにPytestがあります
  • PP302 ：最小値を少なくとも6に設定します
  • PP303 ：テストパスを設定します
  • PP304 ：ログレベルをPytestに設定します
  • PP305 ：XFAIL_STRICTを指定します
  • PP306 ：Strict Configを指定します
  • PP307 ：厳密なマーカーを指定します
  • PP308 ：便利なPytestの概要を指定します
  • PP309 ：指定されたフィルター警告

ドキュメント

  • RTD100 ：readthedocs（pyproject config）を使用します
  • RTD101 ：RTDバージョン番号を2に設定する必要があります
  • RTD102 ：RTDビルド画像を設定する必要があります
  • RTD103 ：RTD Pythonバージョンを設定する必要があります

githubアクション

  • GH100 ：githubアクション構成があります
  • GH101 ：素敵な名前があります
  • GH102 ：繰り返しPRSの自動キャンセル
  • GH103 ：手動ディスパッチトリガーを備えた少なくとも1つのワークフロー
  • GH104 ：Upload-Artifactに一意の名前を使用します
  • GH200 ：Dependabotによって維持されています
  • GH210 ：DependAbotを使用してGitHubアクションバージョンを維持します
  • GH211 ：コアアクションを主要なバージョンとして固定しないでください
  • GH212 ：GHAアップデートグループ化が必要です

マイピー

  • MY100 ：Mypy（Pyproject Config）を使用します
  • MY101 ：Mypy Strictモード
  • MY102 ：mypy show_error_codesは非推奨です
  • MY103 ：Mypyは到達不能に警告します
  • MY104 ：MyPyはコードなしで無視できます
  • MY105 ：MyPyは冗長なExprを有効にします
  • MY106 ：MypyはTruthy-Boolを有効にします

事前コミット

  • PC100 ：コミット前のフックがあります
  • PC110 ：ブラックまたはラフ形式を使用します
  • PC111 ：Blacken-Docsを使用します
  • PC140 ：タイプチェッカーを使用します
  • PC160 ：スペルチェッカーを使用します
  • PC170 ：pygrepフックを使用します（最初の存在の場合にのみ必要です）
  • PC180 ：マークダウンフォーマッタを使用します
  • PC190 ：Ruffを使用します
  • PC191 ：修正が有効になった場合、Ruff Show Fixが修正されます
  • PC901 ：カスタム前委員会CIメッセージ

ラフ

  • RF001 ：Ruff Configがあります
  • RF002 ：ターゲットバージョンを設定する必要があります
  • RF003 ：SRCディレクトリを指定する必要はもうありません（0.6+）
  • RF101 ：Bugbearを選択する必要があります
  • RF102 ：ISORTを選択する必要があります
  • RF103 ：pyupgradeを選択する必要があります
  • RF201 ：非推奨設定の使用は避けてください
  • RF202 ：（new）Lint Configセクションを使用します
拡大する
追加情報
関連アプリ
おすすめ
関連情報 すべて