Pythonプロジェクトのサンプル

Pythonパッケージングユーザガイドのパッケージングと配布に関するチュートリアルの助けとして存在するサンプルプロジェクト 。

このプロジェクトは、Pythonプロジェクト開発のベストプラクティス全体をカバーすることを目的としていません。 たとえば、バージョン管理、文書化、またはテストのためのガイダンスやツールの推奨は提供していません。

このプロジェクトのソースはこちらから入手できます 。

Pythonプロジェクトの設定の大部分はsetup.pyファイルで行われます。このファイルの例はこのプロジェクトに含まれています。 このサンプルプロジェクトを必要に応じて調整するには、このファイルを適切に編集する必要があります。

これはプロジェクトのREADMEファイルです。

このファイルはUTF-8エンコーディングを使用する必要があり、適切なキーセットでreStructuredTextまたはmarkdownを使用して書き込むことができます。 PyPI上でプロジェクトWebページを生成するために使用され、一般的なコードホスティングサービスに関するプロジェクトのホームページとして表示され、その目的のために書かれています。

このファイルの一般的な内容には、プロジェクトの概要、基本的な使用例などが含まれます。プロジェクトの変更履歴を含めて、一般的に最新のバージョンの単純な「新機能」セクションは適切かもしれません。