oe-python-template 0.6.29__tar.gz → 0.6.31__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {oe_python_template-0.6.29 → oe_python_template-0.6.31}/PKG-INFO +43 -34
- {oe_python_template-0.6.29 → oe_python_template-0.6.31}/README.md +42 -33
- {oe_python_template-0.6.29 → oe_python_template-0.6.31}/pyproject.toml +2 -2
- {oe_python_template-0.6.29 → oe_python_template-0.6.31}/.gitignore +0 -0
- {oe_python_template-0.6.29 → oe_python_template-0.6.31}/LICENSE +0 -0
- {oe_python_template-0.6.29 → oe_python_template-0.6.31}/src/oe_python_template/__init__.py +0 -0
- {oe_python_template-0.6.29 → oe_python_template-0.6.31}/src/oe_python_template/api.py +0 -0
- {oe_python_template-0.6.29 → oe_python_template-0.6.31}/src/oe_python_template/cli.py +0 -0
- {oe_python_template-0.6.29 → oe_python_template-0.6.31}/src/oe_python_template/constants.py +0 -0
- {oe_python_template-0.6.29 → oe_python_template-0.6.31}/src/oe_python_template/service.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: oe-python-template
|
|
3
|
-
Version: 0.6.
|
|
3
|
+
Version: 0.6.31
|
|
4
4
|
Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
|
|
5
5
|
Project-URL: Homepage, https://oe-python-template.readthedocs.io/en/latest/
|
|
6
6
|
Project-URL: Documentation, https://oe-python-template.readthedocs.io/en/latest/
|
|
@@ -103,36 +103,44 @@ Description-Content-Type: text/markdown
|
|
|
103
103
|
|
|
104
104
|
Copier template to scaffold Python projects compliant with best practices and modern tooling.
|
|
105
105
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
1.
|
|
111
|
-
2.
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
106
|
+
### Scaffolding
|
|
107
|
+
|
|
108
|
+
This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to quickly generate (scaffold) a Python package with fully functioning build and test automation:
|
|
109
|
+
|
|
110
|
+
1. Projects generated from this template can be [easily updated](https://copier.readthedocs.io/en/stable/updating/) to benefit from improvements and new features of the template.
|
|
111
|
+
2. During project generation, you can flexibly configure naming of the Python distribution, import package, main author, GitHub repository, organization, and many other aspects to match your specific requirements (see [copier.yml](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/copier.yml) for all available options).
|
|
112
|
+
|
|
113
|
+
### Development Infrastructure
|
|
114
|
+
|
|
115
|
+
Projects generated with this template come with a comprehensive development toolchain and quality assurance framework that supports the entire software development lifecycle - from coding and testing to documentation, release management, and compliance auditing. This infrastructure automates routine tasks, enforces code quality standards, and streamlines the path to production:
|
|
116
|
+
|
|
117
|
+
1. Linting with [Ruff](https://github.com/astral-sh/ruff)
|
|
118
|
+
2. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
|
|
119
|
+
3. Complete set of [pre-commit](https://pre-commit.com/) hooks including [detect-secrets](https://github.com/Yelp/detect-secrets) and [pygrep](https://github.com/pre-commit/pygrep-hooks)
|
|
120
|
+
4. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
|
|
121
|
+
5. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
|
|
122
|
+
6. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
|
|
123
|
+
7. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
|
|
124
|
+
8. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
|
|
125
|
+
9. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
|
|
126
|
+
10. Dependency monitoring with [pip-audit](https://pypi.org/project/pip-audit/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
|
|
127
|
+
11. Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/) and published as release artifacts in CSV and JSON format for compliance checks
|
|
128
|
+
12. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
|
|
129
|
+
13. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
|
|
130
|
+
14. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
|
|
131
|
+
15. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
|
|
132
|
+
16. Documentation published to [Read The Docs](https://readthedocs.org/)
|
|
133
|
+
17. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
|
|
134
|
+
18. Python package published to [PyPI](https://pypi.org/)
|
|
135
|
+
19. Docker images published to [Docker.io](https://hub.docker.com/) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) with [artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)
|
|
136
|
+
20. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
|
|
137
|
+
21. Settings for use with [VSCode](https://code.visualstudio.com/)
|
|
138
|
+
22. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
|
|
139
|
+
|
|
140
|
+
### Application Features
|
|
141
|
+
|
|
142
|
+
Beyond development tooling, projects generated with this template include the code, documentation, and configuration of a fully functioning demo application and service. This reference implementation serves as a starting point for your own business logic with modern patterns and practices already in place:
|
|
143
|
+
|
|
136
144
|
1. Service architecture suitable for use as shared library
|
|
137
145
|
2. Validation with [pydantic](https://docs.pydantic.dev/)
|
|
138
146
|
3. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
|
|
@@ -190,9 +198,10 @@ external services such as CloudCov, SonarQube Cloud, Read The Docs, Docker.io, a
|
|
|
190
198
|
./n bump
|
|
191
199
|
```
|
|
192
200
|
Notes:
|
|
193
|
-
1. You can remove this
|
|
194
|
-
2. The following sections refer to the dummy application and service
|
|
195
|
-
Use
|
|
201
|
+
1. You can remove the above sections - from "Scaffolding" to this notes - post having successfully generated your project.
|
|
202
|
+
2. The following sections refer to the dummy application and service generated into the `tests` and `src` folder by this template.
|
|
203
|
+
Use the documentation and code as inspiration, adapt to your business logic, or remove and start documenting and coding from scratch.
|
|
204
|
+
|
|
196
205
|
|
|
197
206
|
## Overview
|
|
198
207
|
|
|
@@ -42,36 +42,44 @@
|
|
|
42
42
|
|
|
43
43
|
Copier template to scaffold Python projects compliant with best practices and modern tooling.
|
|
44
44
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
1.
|
|
50
|
-
2.
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
45
|
+
### Scaffolding
|
|
46
|
+
|
|
47
|
+
This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to quickly generate (scaffold) a Python package with fully functioning build and test automation:
|
|
48
|
+
|
|
49
|
+
1. Projects generated from this template can be [easily updated](https://copier.readthedocs.io/en/stable/updating/) to benefit from improvements and new features of the template.
|
|
50
|
+
2. During project generation, you can flexibly configure naming of the Python distribution, import package, main author, GitHub repository, organization, and many other aspects to match your specific requirements (see [copier.yml](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/copier.yml) for all available options).
|
|
51
|
+
|
|
52
|
+
### Development Infrastructure
|
|
53
|
+
|
|
54
|
+
Projects generated with this template come with a comprehensive development toolchain and quality assurance framework that supports the entire software development lifecycle - from coding and testing to documentation, release management, and compliance auditing. This infrastructure automates routine tasks, enforces code quality standards, and streamlines the path to production:
|
|
55
|
+
|
|
56
|
+
1. Linting with [Ruff](https://github.com/astral-sh/ruff)
|
|
57
|
+
2. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
|
|
58
|
+
3. Complete set of [pre-commit](https://pre-commit.com/) hooks including [detect-secrets](https://github.com/Yelp/detect-secrets) and [pygrep](https://github.com/pre-commit/pygrep-hooks)
|
|
59
|
+
4. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
|
|
60
|
+
5. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
|
|
61
|
+
6. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
|
|
62
|
+
7. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
|
|
63
|
+
8. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
|
|
64
|
+
9. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
|
|
65
|
+
10. Dependency monitoring with [pip-audit](https://pypi.org/project/pip-audit/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
|
|
66
|
+
11. Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/) and published as release artifacts in CSV and JSON format for compliance checks
|
|
67
|
+
12. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
|
|
68
|
+
13. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
|
|
69
|
+
14. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
|
|
70
|
+
15. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
|
|
71
|
+
16. Documentation published to [Read The Docs](https://readthedocs.org/)
|
|
72
|
+
17. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
|
|
73
|
+
18. Python package published to [PyPI](https://pypi.org/)
|
|
74
|
+
19. Docker images published to [Docker.io](https://hub.docker.com/) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) with [artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)
|
|
75
|
+
20. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
|
|
76
|
+
21. Settings for use with [VSCode](https://code.visualstudio.com/)
|
|
77
|
+
22. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
|
|
78
|
+
|
|
79
|
+
### Application Features
|
|
80
|
+
|
|
81
|
+
Beyond development tooling, projects generated with this template include the code, documentation, and configuration of a fully functioning demo application and service. This reference implementation serves as a starting point for your own business logic with modern patterns and practices already in place:
|
|
82
|
+
|
|
75
83
|
1. Service architecture suitable for use as shared library
|
|
76
84
|
2. Validation with [pydantic](https://docs.pydantic.dev/)
|
|
77
85
|
3. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
|
|
@@ -129,9 +137,10 @@ external services such as CloudCov, SonarQube Cloud, Read The Docs, Docker.io, a
|
|
|
129
137
|
./n bump
|
|
130
138
|
```
|
|
131
139
|
Notes:
|
|
132
|
-
1. You can remove this
|
|
133
|
-
2. The following sections refer to the dummy application and service
|
|
134
|
-
Use
|
|
140
|
+
1. You can remove the above sections - from "Scaffolding" to this notes - post having successfully generated your project.
|
|
141
|
+
2. The following sections refer to the dummy application and service generated into the `tests` and `src` folder by this template.
|
|
142
|
+
Use the documentation and code as inspiration, adapt to your business logic, or remove and start documenting and coding from scratch.
|
|
143
|
+
|
|
135
144
|
|
|
136
145
|
## Overview
|
|
137
146
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "oe-python-template"
|
|
3
|
-
version = "0.6.
|
|
3
|
+
version = "0.6.31"
|
|
4
4
|
description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
|
|
5
5
|
readme = "README.md"
|
|
6
6
|
authors = [
|
|
@@ -248,7 +248,7 @@ source = ["src/"]
|
|
|
248
248
|
|
|
249
249
|
|
|
250
250
|
[tool.bumpversion]
|
|
251
|
-
current_version = "0.6.
|
|
251
|
+
current_version = "0.6.31"
|
|
252
252
|
parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
|
|
253
253
|
serialize = ["{major}.{minor}.{patch}"]
|
|
254
254
|
search = "{current_version}"
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|