Show how to structure a Python project.
Inspired by https://github.com/kennethreitz/samplemod.
- Develop your code under Python 3, test it for both Python 2 and Python 3 but consider Python 3 to be the default today.
- All code should be inside some function (except perhaps
if __name__ == '__main__':). - Split long functions into smaller functions.
- If you need to scroll through a function over several screens, it is probably too long.
- Functions should do one thing and one thing only.
- Hide internals with underscores.
- Organize related functions into modules.
- If modules grow too large, split them.
- Import from other modules under
somepackage/usingfrom .somemodule import something. - Do file I/O on the "outside" of your code, not deep inside.
- Do not overuse classes.
- Prefer immutable data structures.
- Prefer pure functions.
- Give the subdirectory the same name as your package.
- Before you name your package, check that the name is not taken on https://pypi.org (you may want to upload your package to PyPI one day).
- In
somepackage/__init__.pydefine what should be visible to the outside. - Use https://semver.org.
- Test all non-trivial code. I recommend to use https://pytest.org.
- Use Travis CI: https://docs.travis-ci.com/user/languages/python/.
- Package dependencies for developers should be listed in
requirements.txt. - Alternatively, consider using http://pipenv.readthedocs.io.
- Package dependencies for users of your code (who will probably install via pip) should be listed in
setup.py.
- Follow PEP8: https://www.python.org/dev/peps/pep-0008/
- Use
pycodestyleto automatically check for PEP8.
- Consider using type hints: https://docs.python.org/3/library/typing.html
- Consider using http://mypy-lang.org.
- Consider verifying type annotations at runtime: https://github.com/RussBaz/enforce
- Choose a license and add a LICENSE file.
- Share your package on PyPI. For this you can follow https://github.com/bast/pypi-howto.
- Use RST for your README (to make it easier for https://pypi.org).
Yes please!