oe-python-template-example 0.1.17__tar.gz → 0.1.19__tar.gz

{oe_python_template_example-0.1.17 → oe_python_template_example-0.1.19}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.5.12
+_commit: v0.5.14
 _src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template_example-0.1.17 → oe_python_template_example-0.1.19}/.github/copilot-instructions.md

@@ -1,4 +1,4 @@
-Always conform to the coding styles defined in CODE-STYLE.md in the root
+Always conform to the coding styles defined in CODE_STYLE.md in the root
 directory of this repository when generating code.
 
 Learn about tools to use in CONTRIBUTING.md in the root directory of this

{oe_python_template_example-0.1.17 → oe_python_template_example-0.1.19}/.vscode/settings.json

@@ -57,7 +57,7 @@
     "github.copilot.chat.edits.temporalContext.enabled": true,
     "github.copilot.chat.codeGeneration.instructions": [
         {
-            "file": "CODE-STYLE.md"
+            "file": "CODE_STYLE.md"
         },
         {
             "file": "CONTRIBUTING.md"

oe_python_template_example-0.1.17/CODE-STYLE.md → oe_python_template_example-0.1.19/CODE_STYLE.md

@@ -1,19 +1,10 @@
----
-title: Code Style
-author: Helmut Hoffer von Ankershoffen (@helmut-hoffer-von-ankershoffen)
-audience: all
-status: draft
-created: 2025-03-16
-updated: 2025-03-16
-tags: [style, code, python, typescript]
-description: |
-  This document describes the code style used in [oe-python-template](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template) and derivatives. It defines
-  strict requirements to be followed by all contributors - humans and agents - to
-  ensure consistency and readability across the codebase.
----
-
 # Code Style
 
+Author: Helmut Hoffer von Ankershoffen (@helmut-hoffer-von-ankershoffen )
+Status: Draft
+Created: 2025-03-16
+Updated: 2025-03-16
+
 This document describes the code style used in
 [oe-python-templat](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
 and derivatives. It defines strict requirements to be followed by all
@@ -34,7 +25,7 @@ We favor readability and maintainability over cleverness and brevity.
 - We always write code that is compatible with the Python version indicated in
   the .python-version file in the root of this repository.
 
-# Naming
+## Naming
 
 We believe that good names are essential for code readability and
 maintainability. A good name is one that is descriptive, unambiguous, and
@@ -121,8 +112,6 @@ We generate the final documentation using Sphinx and publish it to readthedocs.
 We use [pytest](https://docs.pytest.org/en/stable/) for testing Python code.
 
 - Tests are defined in the `tests/` directory
-- Tests are named test__.py and classes are named Test_
-- Test functions are named test_*
 - We use pytest fixtures to set up test data and state
 - We leverage several pytest plugins:
   - `pytest-asyncio` for testing async code

{oe_python_template_example-0.1.17 → oe_python_template_example-0.1.19}/CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to OE Python Template Example
+# Contributing
 
 Thank you for considering contributing to OE Python Template Example!
 
@@ -139,7 +139,7 @@ uv run nox -s update_from_template
 
 ## Pull Request Guidelines
 
-- Before starting to write code read the [CODE-STYlE.md](CODE-STYLE.md) document for mandatory coding style
+- Before starting to write code read the [code style guide](CODE_STYLE.md) document for mandatory coding style
   guidelines.
 - **Pre-Commit Hooks:** We use pre-commit hooks to ensure code quality. Please install the pre-commit hooks by running `uv run pre-commit install`. This ensure all tests, linting etc. pass locally before you can commit.
 - **Squash Commits:** Before submitting a pull request, please squash your commits into a single commit.

{oe_python_template_example-0.1.17 → oe_python_template_example-0.1.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.1.17
+Version: 0.1.19
 Summary: 🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 Project-URL: Homepage, https://oe-python-template-example.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template-example.readthedocs.io/en/latest/

{oe_python_template_example-0.1.17 → oe_python_template_example-0.1.19}/SECURITY.md

@@ -49,9 +49,9 @@ We follow these security best practices:
 
 We promote security awareness among contributors and users
 
-- We indicate security as a priority in our mandatory
-  [CODE-STYLE.md](CODE-STYLE.md) document, to be followed by human and agentic
-  contributors.
+- We indicate security as a priority in our
+  [code style guide](CODE_STYLE.md), to be followed by human and agentic
+  contributors as mandatory
 - We publish our security posture in SECURITY.md (this document), encouraring
   users to report vulnerabilities.
 

oe_python_template_example-0.1.19/VERSION

@@ -0,0 +1 @@
+0.1.19

oe_python_template_example-0.1.19/docs/source/code-style.rst

@@ -0,0 +1 @@
+.. mdinclude:: ../../CODE_STYLE.md

{oe_python_template_example-0.1.17 → oe_python_template_example-0.1.19}/docs/source/conf.py

@@ -29,7 +29,7 @@ extensions = [
 project = "oe-python-template-example"
 author = "Helmut Hoffer von Ankershoffen"
 copyright = f" (c) 2025-{datetime.now(UTC).year}, {author}"  # noqa: A001
-version = "0.1.17"
+version = "0.1.19"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template-example"

{oe_python_template_example-0.1.17 → oe_python_template_example-0.1.19}/docs/source/index.rst

@@ -14,9 +14,10 @@
    api_v1
    api_v2
    reference
-   release-notes
    security
+   release-notes
    contributing
+   code-style
 
 .. sidebar-links::
    :caption: Links

{oe_python_template_example-0.1.17 → oe_python_template_example-0.1.19}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template-example"
-version = "0.1.17"
+version = "0.1.19"
 description = "🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template)."
 readme = "README.md"
 authors = [
@@ -242,7 +242,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.1.17"
+current_version = "0.1.19"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template_example-0.1.17 → oe_python_template_example-0.1.19}/sonar-project.properties

@@ -1,6 +1,6 @@
 sonar.projectKey=helmut-hoffer-von-ankershoffen_oe-python-template-example
 sonar.organization=helmut-hoffer-von-ankershoffen
-sonar.projectVersion=0.1.17
+sonar.projectVersion=0.1.19
 sonar.projectDescription=🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 sonar.links.homepage=https://oe-python-template-example.readthedocs.io/en/latest/
 sonar.links.scm=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example

{oe_python_template_example-0.1.17 → oe_python_template_example-0.1.19}/uv.lock

@@ -2075,7 +2075,7 @@ wheels = [
 
 [[package]]
 name = "oe-python-template-example"
-version = "0.1.17"
+version = "0.1.19"
 source = { editable = "." }
 dependencies = [
     { name = "fastapi", extra = ["all", "standard"] },

oe_python_template_example-0.1.17/VERSION

@@ -1 +0,0 @@
-0.1.17