pyOpenSci Pythonパッケージガイド#

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

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

このガイドについて

Image with the pyOpenSci flower logo in the upper right hand corner. The image shows the packaging lifecycle. The graphic shows a high level overview of the elements of a Python package. The inside circle has 5 items - user documentation, code/api, test suite, contributor documentation, project metadata / license / readme. In the middle of the circle is says maintainers and has a small icon with people. On the outside circle there is an arrow and it says infrastructure.

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

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

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

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

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

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

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

The first round of our community-developed, how to create a Python package tutorial series for scientists is complete! Join our community review process or watch development of future tutorials in our GitHub repo here.

✿ チュートリアルパッケージの作成 ✿
✿パッケージメタデータチュートリアル✿
✿パッケージングツールのチュートリアル✿
✿ Reference Guides ✿

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

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

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

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

ドキュメンテーション#

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

テスト#

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

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

貢献#

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

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

Python パッケージングガイドへの貢献
xkcd comic showing a stick figure on the ground and one in the air. The one on the ground is saying. `You're flying! how?` The person in the air replies `Python!` Below is a 3 rectangle comic with the following text in each box. Box 1 - I learned it last night. Everything is so simple. Hello world is just print hello world. Box 2 - the person on the ground says - come join us programming is fun again. It's a whole new world. But how are you flying? box 3 - the person flying says - i just typed import antigravity. I also sampled everything in the medicine cabinet. But i think this is the python. The person on the ground is saying - that's it?

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

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

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

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

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

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

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

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

このガイドの方向性#

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

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

This living Python packaging guide is updated as tools and best practices evolve in the Python packaging ecosystem. We will be adding new content over the next year.