oe-python-template 0.6.28__py3-none-any.whl → 0.6.30__py3-none-any.whl

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.
Files changed (5) hide show
  1. {oe_python_template-0.6.28.dist-info → oe_python_template-0.6.30.dist-info}/METADATA +39 -31
  2. {oe_python_template-0.6.28.dist-info → oe_python_template-0.6.30.dist-info}/RECORD +5 -5
  3. {oe_python_template-0.6.28.dist-info → oe_python_template-0.6.30.dist-info}/WHEEL +0 -0
  4. {oe_python_template-0.6.28.dist-info → oe_python_template-0.6.30.dist-info}/entry_points.txt +0 -0
  5. {oe_python_template-0.6.28.dist-info → oe_python_template-0.6.30.dist-info}/licenses/LICENSE +0 -0
{oe_python_template-0.6.28.dist-info → oe_python_template-0.6.30.dist-info}/METADATA RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: oe-python-template
3
- Version: 0.6.28
3
+ Version: 0.6.30
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
- This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to quickly generate a Python package with fully functioning build and test automation.
107
- 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.
108
-
109
- Features:
110
- 1. Package management with [uv](https://github.com/astral-sh/uv)
111
- 2. Code formatting with [Ruff](https://github.com/astral-sh/ruff)
112
- 3. Linting with [Ruff](https://github.com/astral-sh/ruff)
113
- 4. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
114
- 5. 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)
115
- 6. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
116
- 7. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
117
- 8. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
118
- 9. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
119
- 10. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
120
- 11. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
121
- 12. 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)
122
- 13. 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
123
- 14. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
124
- 15. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
125
- 16. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
126
- 17. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
127
- 18. Documentation published to [Read The Docs](https://readthedocs.org/)
128
- 19. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
129
- 20. Python package published to [PyPI](https://pypi.org/)
130
- 21. 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)
131
- 22. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
132
- 23. Settings for use with [VSCode](https://code.visualstudio.com/)
133
- 24. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
134
-
135
- The generated project includes code, documentation and configuration of a fully functioning demo-application and service, which can be used as a starting point for your own project.
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 the 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/)
{oe_python_template-0.6.28.dist-info → oe_python_template-0.6.30.dist-info}/RECORD RENAMED
@@ -3,8 +3,8 @@ oe_python_template/api.py,sha256=-7d4cLPHmdLZSkzu6UOaCp9hUO0Aq8MNq8uEZuiW9Y4,625
3
3
  oe_python_template/cli.py,sha256=jvIPeJzx9esff7-M5pBe2R3vvmpxRvxKIre1VOGndls,3426
4
4
  oe_python_template/constants.py,sha256=Z1c06l5DeRuFxYVLHihHHTYvr8_Qh0nyzVKOe5X3ZNs,350
5
5
  oe_python_template/service.py,sha256=Gd-B9IIZ1vB1uONVJHA65hPnfeYeKUIcnU3rZbU2lGs,744
6
- oe_python_template-0.6.28.dist-info/METADATA,sha256=HDY9UV8k_Ea9QGafV17Pt2GFZBN03ZciZiHZILDpJnw,26713
7
- oe_python_template-0.6.28.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
8
- oe_python_template-0.6.28.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
9
- oe_python_template-0.6.28.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
10
- oe_python_template-0.6.28.dist-info/RECORD,,
6
+ oe_python_template-0.6.30.dist-info/METADATA,sha256=UJ3jCMlRmEw9rFAjD58iyrAPCe_Vs_2bzJNRNQIDvCU,27518
7
+ oe_python_template-0.6.30.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
8
+ oe_python_template-0.6.30.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
9
+ oe_python_template-0.6.30.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
10
+ oe_python_template-0.6.30.dist-info/RECORD,,