Show how to structure a Python project.
Project description
Somepackage
Show how to structure a Python project.
Inspired by https://github.com/kennethreitz/samplemod.
Recommendations
Python 2 or 3?
Develop your code under Python 3, test it for both Python 2 and Python 3 but consider Python 3 to be the default today.
Split your code into packages, modules, and functions
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.
Hide internals with underscores.
Organize related functions into modules.
If modules grow too large, split them.
Import from other modules under somepackage/ using from .somemodule import something.
Do file I/O on the “outside” of your code, not deep inside.
Naming
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).
Interfaces
In somepackage/__init__.py define what should be visible to the outside.
Use https://semver.org.
Testing
Test all non-trivial code. I recommend to use https://pytest.org.
Use Travis CI: https://docs.travis-ci.com/user/languages/python/.
Dependency management
Package dependencies for developers should be listed in requirements.txt.
Package dependencies for users of your code (who will probably install via pip) should be listed in setup.py.
Code style
Follow PEP8: https://www.python.org/dev/peps/pep-0008/
Use pycodestyle to automatically check for PEP8.
Consider using type hints: https://docs.python.org/3/library/typing.html
Consider verifying type annotations at runtime: https://github.com/RussBaz/enforce
Documentation
Use RST for your README (to make it easier for https://pypi.org).
Suggestions? Corrections? Pull requests?
Yes please!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.