読者です 読者をやめる 読者になる 読者になる

pythonで作成しているプロジェクトディレクトリを綺麗に保つ

python

やりたいこと

pythonで作成しているプロジェクトがあって、ディレクトリ構造をきれいにしておきたい。

まちがっても、プロジェクト直下のディレクトリに~py ~pyc ~datが大量に並んでいる状態は避けたい。

そこで、慣習的なディレクトリ構造の作り方はあるのかな?と思って調べてみた。

解決策

stackoverflowのこの回答からちょいちょい引用する。

bin/(scripts/でもいいよ) : コマンドラインインターフェースの類を置く
tests/: テスト環境をおく for your tests
lib/: Cで書かれたライブラリ群をおく(別にCで書かれてなくてもライブラリなら置いてもいいんじゃないかと思うが)
doc/:  ドキュメントの類
apidoc/: API用のドキュメントの類

pythonでは特に決まったルールがあるわけじゃないから、後はすきにディレクトリをきったらいいお。

ということらしい。

とは言え、これでは作ったらいいか?よくわからんままなので、もうちょっと読むと

$ pwd
~/code/sandman
$ tree
.
|- LICENSE
|- README.md
|- TODO.md
|- docs
|   |-- conf.py
|   |-- generated
|   |-- index.rst
|   |-- installation.rst
|   |-- modules.rst
|   |-- quickstart.rst
|   |-- sandman.rst
|- requirements.txt
|- sandman
|   |-- __init__.py
|   |-- exception.py
|   |-- model.py
|   |-- sandman.py
|   |-- test
|       |-- models.py
|       |-- test_sandman.py
|- setup.py

というのがあった。

これを真似ればいいと思う。