A sample Python project
A sample Python project inspired by:
- Python Packaging User Guide's Tutorial on Packaging and Distributing Projects (upstream)
- Filesystem structure of a Python project by Jean-Paul Calderone
- https://stackoverflow.com/q/193161
- https://realpython.com/python-application-layouts/
- https://jeffknupp.com/blog/2013/08/16/open-sourcing-a-python-project-the-right-way/
- https://docs.python.org/3/tutorial/modules.html#packages
Most of the configuration for a Python project is done in the setup.py file,
an example of which is included in this project. You should edit this file
accordingly to adapt this sample project to your needs.
This is the README file for the project.
The file should use UTF-8 encoding and can be written using reStructuredText or markdown with the appropriate key set. It will be used to generate the project webpage on PyPI and will be displayed as the project homepage on common code-hosting services, and should be written for that purpose.
Typical contents for this file would include an overview of the project, basic usage examples, etc. Generally, including the project changelog in here is not a good idea, although a simple “What's New” section for the most recent version may be appropriate.