Python package convention

Hard to find, but there is a convention for packaging your modules and classes. From Ian Bicking’s presentation, page 18:

MyPackage/

setup.py
ez_setup.py
mypackage/

__init__.py
other_stuff.py
data/

mydata.xml

tests/
docs/

Page 19:

Your “distribution” has a name: MyPackage, not to be confused with your “package”: mypackage. Packages and modules all lower-case by convention.

Page 20:

Documentation and (usually) tests go outside the package, mypackage/ is all that really gets installed. setup.py describes the package

Leave a Reply

Please log in using one of these methods to post your comment:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s


%d bloggers like this: