diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0e2de4d --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# project-dummy + +## Explanation + +This is a project dummy. It serves (me, maybe you?) as a "template" for the basic structure of +a Python project. As simple as it can be - copy and adjust. + +## Structure + +This is a project folder containing the folders and files for creating a Python module called +"project-dummy". + +## Credits + +This setup was kicked off while reading Jeff Knupp's ideas[^1] on how to set up a python project. + +Changes since then will be incorporated, like: + +- Define metadata in pyproject.toml which setuptools have adapted since 61.0.0[^2] + +# Resources + +This will list some useful resources to fill in pyproject.toml etc. + +- [Writing pyproject.toml](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/) +- [Setuptools-specific pyproject.toml configuration](https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html) +- [PyPi classifiers](https://pypi.org/classifiers/) + +# Sources + +[^1] [Internet Archive Wayback Machine, 2024-01-05](https://web.archive.org/web/20240105220829/https://www.jeffknupp.com/blog/2013/08/16/open-sourcing-a-python-project-the-right-way/) +[^2] [Setuptools, pyproject_config](https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html) |