A minimal Python package containing a single function and a minimal set of nose
tests.
It is intended to serve as a template for building other packages.
TODO: Add MkDocs
Adapted from: [http://learnpythonthehardway.org/book/ex46.html]
Whenever you want to start a new project, do this:
- Make a copy of the
python_example_package
directory. Name it after your new project. - Rename
python_example_package
to your project name throughout the skeleton files. - Edit your
setup.py
to have all the information for your project. - Double check it's all working by running tests:
- from the main package directory:
- ipython
-
run tests/python_example_package_tests.py
- Remove the sample function from the package
__init__.py
and the corresponding tests fromtests/
. - Start coding.