a minimalist Python module project (hint: it doesn't do anything)
A stab at a minimalist repo supporting a single Python module. Spurned by <http://twitter.com/jessenoller/status/19853449226> (who still owes me a beer, BTW).
# Why the “lib” subdir?
Allows nicer 3rd-party usage via ‘svn:externals’ – historically when I was using Subversion more. Allows one to put the “lib” dir on PYTHONPATH and not have the “setup.py” and other supportive “.py” files unintentional get on the import path. Separates the important code from the chaf.
# I want to use “README.md” for Markdown rendering on github.com
Then you’ll need to add a “MANIFEST.in” for “python setup.py sdist” to pick up the README file. It only picks up either “README” or “README.txt” by default.
# The “setup.py” is a little hefty
Fair enough, you could argue that. I’d welcome suggestions on paring that
down. I’m a fan of importing the main module (here
mpm) to be able to get
the version from it. A static data file that supported specifying all this
same info would be cool. I’m not up on latest latest Python packaging stuff
to know if something like that has been proposed.
# What’s left TODO?
- do I need to use
setuptoolsin “setup.py” or will distutils do?
- a good minimalist python-land module’s README should probably use reStructuredText, but I’m a Markdown fanboy