他の人が使用する新しい python パッケージをコーディングしています。使用方法を示すために、新しいパッケージの主要部分を実行するデモ スクリプトを作成しています。
他の人がスクリプトを簡単に見つけられるように、これを行うための規則は何ですか? 別のモジュールにする必要がありますか (何という名前で)? パッケージのルート ディレクトリに配置する必要がありますか? パッケージから?で__init__.py
?
他の人が使用する新しい python パッケージをコーディングしています。使用方法を示すために、新しいパッケージの主要部分を実行するデモ スクリプトを作成しています。
他の人がスクリプトを簡単に見つけられるように、これを行うための規則は何ですか? 別のモジュールにする必要がありますか (何という名前で)? パッケージのルート ディレクトリに配置する必要がありますか? パッケージから?で__init__.py
?
それは別のモジュールにする必要がありますか (何という名前で)?
demo/some_useful_name.py
demo ディレクトリには、デモ スクリプトが含まれています。同様に、テスト ディレクトリにはすべての単体テストが含まれます。
パッケージのルート ディレクトリに配置する必要がありますか?
いいえ、パッケージには含まれていません。デモです。
パッケージから?
はい。
init .py ?
一度もない。
パッケージには 2 つの命があります。(1) アンインストールされたソースとして、(2) インストールされたコードとして lib/site-packages に。
「ソース」には、README、setup.py、demo ディレクトリ、test ディレクトリ、およびパッケージ自体が含まれている必要があります。
最上位の「ソース」setup.py は、パッケージのみをインストールする必要があります。デモとテストはインストールされません。それらはダウンロードの一部として取り残されます。
これに関する実際の規則は見たことがありませんが、私は個人的にそれをメインのセンチネルに__init__.py
配置して、python -m somepackage
.