oe-python-template 0.6.21__py3-none-any.whl → 0.6.22__py3-none-any.whl

{oe_python_template-0.6.21.dist-info → oe_python_template-0.6.22.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.6.21
+Version: 0.6.22
 Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 Project-URL: Homepage, https://oe-python-template.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template.readthedocs.io/en/latest/
@@ -104,9 +104,19 @@ Description-Content-Type: text/markdown
 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 
 Use Cases:
-1) Fast and easy to use project setup
-2) Consistent update of already scaffolded projects to benefit from new and improved features.
-3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
+1) Fast and easy generation of Python projects from this template
+2) Seamless updates of projects when improvements to the template are released
+3) Generates a fully-functional Python package with test and build automation featuring
+   - Service architecture suiteable for use as shared library
+   - Command-line interface (CLI)
+   - Versioned Web API
+   - Integration examples with Notebooks and Dashboards
+   - Complete developer-tooling with formatting, linting, type checking etc.
+   - CI/CD pipeline for GitHub, PyPI, and Docker registries
+   - Unit and E2E tests including parallel and matrix-testing
+   - Release artifacts include SBOM, license information, and test coverage
+   - Auto-generated documentation published to Read The Docs
+   - Service integrations monitoring code quality, dependencies, and security
 
 ## Scaffolding
 
@@ -157,7 +167,7 @@ Notes:
 
 ## Overview
 
-Adding OE Python Template to your project as a dependency is easy.
+Adding OE Python Template to your project as a dependency is easy. See below for usage examples.
 
 ```shell
 uv add oe-python-template             # add dependency to your project
@@ -165,6 +175,7 @@ uv add oe-python-template             # add dependency to your project
 
 If you don't have uv installed follow [these instructions](https://docs.astral.sh/uv/getting-started/installation/). If you still prefer pip over the modern and fast package manager [uv](https://github.com/astral-sh/uv), you can install the library like this:
 
+
 ```shell
 pip install oe-python-template        # add dependency to your project
 ```
@@ -172,14 +183,14 @@ pip install oe-python-template        # add dependency to your project
 Executing the command line interface (CLI) in an isolated Python environment is just as easy:
 
 ```shell
-uvx oe-python-template hello-world     # prints "Hello, world! [..]"
-uvx oe-python-template serve           # serves webservice API
-uvx oe-python-template serve --port=4711 # serves webservice API on port 4711
+uvx oe-python-template hello-world       # prints "Hello, world! [..]"
+uvx oe-python-template serve             # serves web API
+uvx oe-python-template serve --port=4711 # serves web API on port 4711
 ```
 
 Notes:
 * The API is versioned, mounted at `/api/v1` resp. `/api/v2`
-* While serving the webservice API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the `hello-world` operation.
+* While serving the web API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the `hello-world` operation.
 * Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
 
 
@@ -217,7 +228,7 @@ This project is designed with operational excellence in mind, using modern Pytho
 
 ## Usage Examples
 
-The following examples run from source. Clone this repository first using
+The following examples run from source - clone this repository using
 `git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template.git`.
 
 ### Minimal Python Script:

{oe_python_template-0.6.21.dist-info → oe_python_template-0.6.22.dist-info}/RECORD

@@ -3,8 +3,8 @@ oe_python_template/api.py,sha256=-7d4cLPHmdLZSkzu6UOaCp9hUO0Aq8MNq8uEZuiW9Y4,625
 oe_python_template/cli.py,sha256=jvIPeJzx9esff7-M5pBe2R3vvmpxRvxKIre1VOGndls,3426
 oe_python_template/constants.py,sha256=Z1c06l5DeRuFxYVLHihHHTYvr8_Qh0nyzVKOe5X3ZNs,350
 oe_python_template/service.py,sha256=Gd-B9IIZ1vB1uONVJHA65hPnfeYeKUIcnU3rZbU2lGs,744
-oe_python_template-0.6.21.dist-info/METADATA,sha256=qN8Uoo3aLUwY2e0xMGvGcXxxVO8Q7l7vFKPC6j4p7KY,21994
-oe_python_template-0.6.21.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oe_python_template-0.6.21.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
-oe_python_template-0.6.21.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
-oe_python_template-0.6.21.dist-info/RECORD,,
+oe_python_template-0.6.22.dist-info/METADATA,sha256=wxHhwDOGwkJha3y5SB5fd-QizmJUNiVTAWl2v8BAo14,22571
+oe_python_template-0.6.22.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oe_python_template-0.6.22.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
+oe_python_template-0.6.22.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
+oe_python_template-0.6.22.dist-info/RECORD,,