oe-python-template-example 0.2.16__tar.gz → 0.3.0__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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: oe-python-template-example
3
- Version: 0.2.16
3
+ Version: 0.3.0
4
4
  Summary: 🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
5
5
  Project-URL: Homepage, https://oe-python-template-example.readthedocs.io/en/latest/
6
6
  Project-URL: Documentation, https://oe-python-template-example.readthedocs.io/en/latest/
@@ -132,8 +132,8 @@ Projects generated with this template come with a comprehensive development tool
132
132
  13. Software Bill of Materials (SBOM) generated in [CycloneDX](https://cyclonedx.org/) and [SPDX](https://spdx.dev/) formats with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) resp. [trivy](https://trivy.dev/latest/), published as release artifacts
133
133
  14. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
134
134
  15. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
135
- 16. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
136
- 17. Documentation published to [Read The Docs](https://readthedocs.org/)
135
+ 16. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation for the library, CLI, and API
136
+ 17. Documentation published to [Read The Docs](https://readthedocs.org/) including generation of PDF and single page HTML versions
137
137
  18. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
138
138
  19. Python package published to [PyPI](https://pypi.org/)
139
139
  20. 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)
@@ -452,10 +452,12 @@ Nothing yet
452
452
  ## Further Reading
453
453
 
454
454
  * Inspect our [security policy](https://oe-python-template-example.readthedocs.io/en/latest/security.html) with detailed documentation of checks, tools and principles.
455
+ * Check out the [CLI Reference](https://oe-python-template-example.readthedocs.io/en/latest/cli_reference.html) with detailed documentation of all CLI commands and options.
456
+ * Check out the [Library Reference](https://oe-python-template-example.readthedocs.io/en/latest/lib_reference.html) with detailed documentation of public classes and functions.
457
+ * Check out the [API Reference](https://oe-python-template-example.readthedocs.io/en/latest/api_reference_v1.html) with detailed documentation of all API operations and parameters.
455
458
  * Our [release notes](https://oe-python-template-example.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.
456
- * Check out the [reference](https://oe-python-template-example.readthedocs.io/en/latest/reference.html) with detailed documentation of public classes and functions.
457
459
  * In case you want to help us improve 🧠 OE Python Template Example: The [contribution guidelines](https://oe-python-template-example.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.
458
- * We gratefully acknowledge the [open source projects](ATTRIBUTIONS.md) that this project builds upon. Thank you to all these wonderful contributors!
460
+ * We gratefully acknowledge the [open source projects](https://oe-python-template-example.readthedocs.io/en/latest/attributions.html) that this project builds upon. Thank you to all these wonderful contributors!
459
461
 
460
462
  ## Star History
461
463
 
@@ -71,8 +71,8 @@ Projects generated with this template come with a comprehensive development tool
71
71
  13. Software Bill of Materials (SBOM) generated in [CycloneDX](https://cyclonedx.org/) and [SPDX](https://spdx.dev/) formats with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) resp. [trivy](https://trivy.dev/latest/), published as release artifacts
72
72
  14. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
73
73
  15. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
74
- 16. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
75
- 17. Documentation published to [Read The Docs](https://readthedocs.org/)
74
+ 16. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation for the library, CLI, and API
75
+ 17. Documentation published to [Read The Docs](https://readthedocs.org/) including generation of PDF and single page HTML versions
76
76
  18. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
77
77
  19. Python package published to [PyPI](https://pypi.org/)
78
78
  20. 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)
@@ -391,10 +391,12 @@ Nothing yet
391
391
  ## Further Reading
392
392
 
393
393
  * Inspect our [security policy](https://oe-python-template-example.readthedocs.io/en/latest/security.html) with detailed documentation of checks, tools and principles.
394
+ * Check out the [CLI Reference](https://oe-python-template-example.readthedocs.io/en/latest/cli_reference.html) with detailed documentation of all CLI commands and options.
395
+ * Check out the [Library Reference](https://oe-python-template-example.readthedocs.io/en/latest/lib_reference.html) with detailed documentation of public classes and functions.
396
+ * Check out the [API Reference](https://oe-python-template-example.readthedocs.io/en/latest/api_reference_v1.html) with detailed documentation of all API operations and parameters.
394
397
  * Our [release notes](https://oe-python-template-example.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.
395
- * Check out the [reference](https://oe-python-template-example.readthedocs.io/en/latest/reference.html) with detailed documentation of public classes and functions.
396
398
  * In case you want to help us improve 🧠 OE Python Template Example: The [contribution guidelines](https://oe-python-template-example.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.
397
- * We gratefully acknowledge the [open source projects](ATTRIBUTIONS.md) that this project builds upon. Thank you to all these wonderful contributors!
399
+ * We gratefully acknowledge the [open source projects](https://oe-python-template-example.readthedocs.io/en/latest/attributions.html) that this project builds upon. Thank you to all these wonderful contributors!
398
400
 
399
401
  ## Star History
400
402
 
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "oe-python-template-example"
3
- version = "0.2.16"
3
+ version = "0.3.0"
4
4
  description = "🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template)."
5
5
  readme = "README.md"
6
6
  authors = [
@@ -137,6 +137,7 @@ dev = [
137
137
  "swagger-plugin-for-sphinx>=5.1.0",
138
138
  "tomli>=2.1.0",
139
139
  "types-pyyaml>=6.0.12.20250402",
140
+ "types-requests>=2.32.0.20250328",
140
141
  "watchdog>=6.0.0",
141
142
  ]
142
143
 
@@ -244,6 +245,7 @@ markers = [
244
245
  "no_extras: tests that do require no extras installed",
245
246
  "scheduled: tests to run on a schedule",
246
247
  "sequential: exclude from parallel test execution",
248
+ "skip_with_act: don't run with act",
247
249
  # Custom
248
250
  # Nothing yet
249
251
  ]
@@ -262,7 +264,7 @@ source = ["src/"]
262
264
 
263
265
 
264
266
  [tool.bumpversion]
265
- current_version = "0.2.16"
267
+ current_version = "0.3.0"
266
268
  parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
267
269
  serialize = ["{major}.{minor}.{patch}"]
268
270
  search = "{current_version}"