setup.py
TAU Commander follows the Python Packaging Guide, the same resource that guides package deployment to the
Python Package Index (PyPI). All tasks related to packaging and releasing TAU Commander are handled via the
setup.py script in the project root directory. The script has many commands but most aren’t relevent to
TAU Commander. The important ones are:
build: | Build everything needed for a new TAU Commander installation in the build directory. |
build_sphinx: | Rebuild TAU Commander developer documentation (which you are currently reading) in the build/sphinx directory.
Use the --update-gh-pages option and associated options (see --help ) to update the developer documentation
on Github (http://paratoolsinc.github.io/taucmdr/). |
test: | Run all unit tests and pylint. |
install: | Install a TAU Commander distribution. End users must NEVER use python setup.py install ! TAU Commander needs
its own, private, un-shared Python installation to avoid environment contamination when profiling a user’s code.
For example, if the user’s Python has a package named “tau” installed in it then both TAU Commander and the user’s
code will break. The top-level Makefile will call python setup.py install with appropriate options after
installing a pristine Python just for TAU Commander. |
Use python setup.py <command> --help
to see command line options for each command.