blob: 88576dc2dc8945c0e82de1e26c9e66c7032bd29e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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. [^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. [^2]: [Setuptools, pyproject_config](https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html)
|
