oe-python-template 0.8.34__tar.gz → 0.9.1__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
3
- Version: 0.8.34
3
+ Version: 0.9.1
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/
@@ -129,8 +129,8 @@ Projects generated with this template come with a comprehensive development tool
129
129
  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
130
130
  14. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
131
131
  15. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
132
- 16. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
133
- 17. Documentation published to [Read The Docs](https://readthedocs.org/)
132
+ 16. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation for the library, CLI, and API
133
+ 17. Documentation published to [Read The Docs](https://readthedocs.org/) including generation of PDF and single page HTML versions
134
134
  18. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
135
135
  19. Python package published to [PyPI](https://pypi.org/)
136
136
  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)
@@ -285,6 +285,8 @@ console.print(f"[blue]{message}[/blue]")
285
285
 
286
286
  [Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py) - [Read the reference documentation](https://oe-python-template.readthedocs.io/en/latest/reference.html)
287
287
 
288
+ See the [reference documentation of the library](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html) for detailed documentation of public classes and functions you can use in your code.
289
+
288
290
  ### Streamlit App
289
291
 
290
292
  Serve the functionality provided by OE Python Template in the web by easily integrating the service into a Streamlit application.
@@ -363,6 +365,9 @@ uvx oe-python-template openapi --output-format=json
363
365
  uvx oe-python-template serve
364
366
  ```
365
367
 
368
+ See the [reference documentation of the CLI](https://oe-python-template.readthedocs.io/en/latest/cli_reference.html) for detailed documentation of all CLI commands and options.
369
+
370
+
366
371
  ### Environment
367
372
 
368
373
  The service loads environment variables including support for .env files.
@@ -446,7 +451,7 @@ Dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet i
446
451
  * Check out the [API Reference](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) with detailed documentation of all API operations and parameters.
447
452
  * Our [release notes](https://oe-python-template.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.
448
453
  * In case you want to help us improve 🧠 OE Python Template: The [contribution guidelines](https://oe-python-template.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.
449
- * We gratefully acknowledge the [open source projects](ATTRIBUTIONS.md) that this project builds upon. Thank you to all these wonderful contributors!
454
+ * We gratefully acknowledge the [open source projects](https://oe-python-template.readthedocs.io/en/latest/attributions.html) that this project builds upon. Thank you to all these wonderful contributors!
450
455
 
451
456
  ## Star History
452
457
 
@@ -68,8 +68,8 @@ Projects generated with this template come with a comprehensive development tool
68
68
  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
69
69
  14. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
70
70
  15. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
71
- 16. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
72
- 17. Documentation published to [Read The Docs](https://readthedocs.org/)
71
+ 16. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation for the library, CLI, and API
72
+ 17. Documentation published to [Read The Docs](https://readthedocs.org/) including generation of PDF and single page HTML versions
73
73
  18. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
74
74
  19. Python package published to [PyPI](https://pypi.org/)
75
75
  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)
@@ -224,6 +224,8 @@ console.print(f"[blue]{message}[/blue]")
224
224
 
225
225
  [Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py) - [Read the reference documentation](https://oe-python-template.readthedocs.io/en/latest/reference.html)
226
226
 
227
+ See the [reference documentation of the library](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html) for detailed documentation of public classes and functions you can use in your code.
228
+
227
229
  ### Streamlit App
228
230
 
229
231
  Serve the functionality provided by OE Python Template in the web by easily integrating the service into a Streamlit application.
@@ -302,6 +304,9 @@ uvx oe-python-template openapi --output-format=json
302
304
  uvx oe-python-template serve
303
305
  ```
304
306
 
307
+ See the [reference documentation of the CLI](https://oe-python-template.readthedocs.io/en/latest/cli_reference.html) for detailed documentation of all CLI commands and options.
308
+
309
+
305
310
  ### Environment
306
311
 
307
312
  The service loads environment variables including support for .env files.
@@ -385,7 +390,7 @@ Dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet i
385
390
  * Check out the [API Reference](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) with detailed documentation of all API operations and parameters.
386
391
  * Our [release notes](https://oe-python-template.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.
387
392
  * In case you want to help us improve 🧠 OE Python Template: The [contribution guidelines](https://oe-python-template.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.
388
- * We gratefully acknowledge the [open source projects](ATTRIBUTIONS.md) that this project builds upon. Thank you to all these wonderful contributors!
393
+ * We gratefully acknowledge the [open source projects](https://oe-python-template.readthedocs.io/en/latest/attributions.html) that this project builds upon. Thank you to all these wonderful contributors!
389
394
 
390
395
  ## Star History
391
396
 
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "oe-python-template"
3
- version = "0.8.34"
3
+ version = "0.9.1"
4
4
  description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
5
5
  readme = "README.md"
6
6
  authors = [{ name = "Helmut Hoffer von Ankershoffen", email = "helmuthva@gmail.com" }]
@@ -262,7 +262,7 @@ source = ["src/"]
262
262
 
263
263
 
264
264
  [tool.bumpversion]
265
- current_version = "0.8.34"
265
+ current_version = "0.9.1"
266
266
  parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
267
267
  serialize = ["{major}.{minor}.{patch}"]
268
268
  search = "{current_version}"