pyOpenSci Pythonパッケージガイド#

私たちは、科学者がオープンサイエンスのワークフローを作成するために必要なPythonツールをサポートしています。

GitHubリリース(日付順最新) DOI

このガイドについて

右上にpyOpenSciの花のロゴがある画像。画像はパッケージングのライフサイクルを示しています。図にはPythonパッケージの要素のハイレベルな概要が示されています。内側の円には5つの項目があります - ユーザードキュメント、コード/API、テストスイート、コントリビュータードキュメント、プロジェクトメタデータ/ライセンス/readme。円の真ん中にはメンテナーと書かれ、人と小さなアイコンがあります。外側の円には矢印があり、インフラストラクチャと書かれています。

このガイドはあなたのお役に立つでしょう:

  1. Pythonパッケージの作成方法を最初から最後まで学ぶ

  2. 幅広いPythonパッケージングツールのエコシステムを理解する

  3. ツールオプションのナビゲートと決定

  4. Pythonパッケージの作成と保守のすべてを理解する

また、パッケージングとパッケージドキュメンテーションにまつわるベストプラクティスの推奨や、コミュニティリソースのキュレーションリストもご覧いただけます。

new チュートリアルシリーズ: Pythonパッケージの作成#

コミュニティが開発した、科学者のためのPythonパッケージの作り方チュートリアルシリーズの第一弾が完成しました！ コミュニティのレビュープロセスに参加したり、 GitHub リポジトリはこちら で今後のチュートリアルの開発を見守ったりしてください。

✿ チュートリアルパッケージの作成 ✿
✿パッケージメタデータチュートリアル✿
✿パッケージングツールのチュートリアル✿
✿ リファレンスガイド ✿

科学者のためのPythonパッケージング#

Python のパッケージングのベストプラクティスについて学びます。 また、Python のパッケージングを支援するために利用可能なパッケージングツールの活発なエコシステムを知ることができます。

✨パッケージの作成✨
✨パッケージを公開する✨

Pythonのパッケージングエコシステムをより深く理解するためのベストプラクティスを学ぶ:

ドキュメンテーション#

✨ドキュメントを書く✨
✨開発者向けドキュメント✨
✨コミュニティのためのドキュメント✨
✨ドキュメントを公開する✨

テスト#

私たちはこのセクションに積極的に取り組んでいます。 開発のフォローはこちら

✨Pythonパッケージのテスト✨
✨テストの実行✨

貢献#

✨コードスタイルとフォーマット✨
Python パッケージングガイドへの貢献
✨貢献したいですか？ ✨

このガイドへのご貢献をお待ちしております。貢献方法についてはこちらをご覧ください。

Python パッケージングガイドへの貢献
xkcdの漫画で、地面に置かれた棒人間と空中にある棒人間が描かれている。地上にいる人が言っている。 `あなたは飛んでいる！どうやって？` 空中にいる人は `Python!` と答える。以下は3つの長方形のマンガで、各ボックスに次のテキストが入っている。ボックス1 - 昨夜学んだ。すべてがとてもシンプルだ。Hello worldはprint hello worldだけ。ボックス2 - 地上にいる人が言う。まったく新しい世界だ。でもどうやって飛んでるの？ボックス3 - 飛んでいる人はこう言う。- `反重力をインポートしました。薬箱の中のものも全部試しました。でもこれがpythonだと思う。地上の人はこう言っている。- これで終わり？

コミュニティが作るガイドブック#

このガイドブックのすべてのページは、コミュニティの広範なレビュープロセスを経ています。 このガイドブックが初心者にやさしく、正確であることを保証するために、私たちは幅広いスキルと専門知識を持つ多様なpythonistaや科学者からのレビューを奨励しています。

ガイドブックの貢献者を見る

このガイドブックの対象者#

このガイドブックはPythonのパッケージングについてもっと学びたいと思っている人のためのものです。 初心者に優しく、以下を提供します:

  1. Pythonパッケージの作成に関する初歩から終わりまでのガイダンス。

  2. Python のパッケージングエコシステムをナビゲートするのに役立つリソースです。

  3. あなたのパッケージが文書化され、使用可能で保守可能な形になるのを助けるリソースの厳選されたリストです。

このガイドの方向性#

このガイドで明確にしてほしいことがあれば、 GitHubにissueを開いてください。 。

レビュープロセスやパッケージング全般について質問がある場合は、 pyOpenSci Discourse forum をご利用ください。

これは Python のパッケージングエコシステムにおけるツールやベストプラクティスの進化に合わせて更新されるこの生きた Python パッケージングガイドです。 来年にかけて新しいコンテンツを追加していく予定です。