Saturday, 24 August 2013

Should I include Sphinx and/or Nose in my module's requirements.txt?

Should I include Sphinx and/or Nose in my module's requirements.txt?

I've created a Python module on Github that uses Nose for unit testing and
Sphinx for generating documentation. I have two questions:
Should I include Sphinx and/or Nose in my module's dependencies in
setup.py (install_requires), as they are not required for basic module
functionality, only if you want to build the documentation/run tests
yourself?
Should I include Sphinx and/or Nose in my module's requirements.txt on
Github, for the same reasons but users that download my project from
Github might be more likely to build docs/run tests?
This is my first Python module, so a bit of best practices/standards
advice would be appreciated.

No comments:

Post a Comment