How to properly package/distribute a pure python module?

Andy Todd andy47 at halfcooked.com
Tue Jul 29 07:10:37 EDT 2003


Matt Shomphe wrote:
> Are there any guidelines for packaging a pure python module? 
> Specifically, say I have a set of 10 functions, all of varying
> behaviors (no unifying theme to bind them together into clear
> subsets), that I would like to make available to others.  What is the
> best structure for the distributed module?  A single file called
> "functions.py" that people can put in "site-packages"[1]?  A
> subdirectory called "MyFunctions" with an "__init__.py" and the
> "functions.py" files[2]?  Or should the functions be broken out into
> individual files[3]?
> 
> I'm sure it depends on some other factorsbut are there general rules
> for constructing a nice, logical package for others to use?
> 
> [1] site-packages/functions.py (from functions import f1)
> [2] site-packages/MyFunctions/functions.py, __init__.py (from
> MyFunctions.functions import f1)
> [3] site-packages/MyFunctions/__init__.py, f1.py, f2.py, f3.py (from
> MyFunctions.f1 import f1)

I'd suggest you look at the distribution utilities for Python;

   http://www.python.org/sigs/distutils-sig/doc/

Specifically the documentation on distrbuting Python modules;

   http://www.python.org/doc/current/dist/

The documentation can be a little confusing at first but stick with it 
and if you have any questions please ask them here or on the 
distutils-sig mailing list.

Regards,
Andy
-- 
--------------------------------------------------------------------------------
 From the desk of Andrew J Todd esq - http://www.halfcooked.com/







More information about the Python-list mailing list