oe-python-template 0.1.1__tar.gz → 0.1.3__tar.gz

{oe_python_template-0.1.1 → oe_python_template-0.1.3}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.1.0
+_commit: v0.1.1
 _src_path: .
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

oe_python_template-0.1.1/RELEASE_NOTES.md → oe_python_template-0.1.3/CHANGELOG.md

@@ -1,5 +1,19 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/)
 
+## [0.1.3](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.2..0.1.3) - 2025-03-02
+
+### ⚙️ Miscellaneous Tasks
+
+- Other - ([630b5b6](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/630b5b6ca7c2a388c7d1425301f88f0da6e468ad))
+
+
+## [0.1.2](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.1..v0.1.2) - 2025-03-02
+
+### 📚 Documentation
+
+- On template - ([48bdcbe](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/48bdcbe863942bc7dd03bc8e71a50cae968c010c))
+
+
 ## [0.1.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.0..v0.1.1) - 2025-03-02
 
 ### ⚙️ Miscellaneous Tasks

{oe_python_template-0.1.1 → oe_python_template-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.1.1
+Version: 0.1.3
 Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 Project-URL: Homepage, https://oe-python-template.readthedocs.io/
 Project-URL: Documentation, https://oe-python-template.readthedocs.io/

oe_python_template-0.1.1/CHANGELOG.md → oe_python_template-0.1.3/RELEASE_NOTES.md

@@ -1,6 +1,20 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/)
 
-## [0.1.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.0..0.1.1) - 2025-03-02
+## [0.1.3](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.2..v0.1.3) - 2025-03-02
+
+### ⚙️ Miscellaneous Tasks
+
+- Other - ([630b5b6](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/630b5b6ca7c2a388c7d1425301f88f0da6e468ad))
+
+
+## [0.1.2](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.1..v0.1.2) - 2025-03-02
+
+### 📚 Documentation
+
+- On template - ([48bdcbe](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/48bdcbe863942bc7dd03bc8e71a50cae968c010c))
+
+
+## [0.1.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.0..v0.1.1) - 2025-03-02
 
 ### ⚙️ Miscellaneous Tasks
 

oe_python_template-0.1.3/VERSION

@@ -0,0 +1 @@
+0.1.3

{oe_python_template-0.1.1 → oe_python_template-0.1.3}/docs/source/conf.py

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

{oe_python_template-0.1.1 → oe_python_template-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.1.1"
+version = "0.1.3"
 description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
 readme = "README.md"
 authors = [
@@ -189,7 +189,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.1.1"
+current_version = "0.1.3"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template-0.1.1 → oe_python_template-0.1.3}/sonar-project.properties

@@ -1,6 +1,6 @@
 sonar.projectKey=helmut-hoffer-von-ankershoffen_oe-python-template
 sonar.organization=helmut-hoffer-von-ankershoffen
-sonar.projectVersion=0.1.1
+sonar.projectVersion=0.1.3
 sonar.projectDescription=OE Python Template
 sonar.links.homepage=https://oe-python-template.readthedocs.io
 sonar.links.scm=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template

oe_python_template-0.1.1/TEMPLATE.md → oe_python_template-0.1.3/template/SERVICE_CONNECTIONS.md.jinja

@@ -1,8 +1,6 @@
-# Readme of the template
+# Setup service connections
 
-## Setup service connections
-
-### Reporting code coverage via CodeCov
+## Reporting code coverage via CodeCov
 
 1. Sign-Up at https://app.codecov.io/
 2. Configure via https://app.codecov.io/gh/{{ github_repository_owner }}
@@ -10,7 +8,7 @@
 4. Goto {{ github_repository_url_https }}/settings/secrets/actions/new and create a new repository secret called `CODECOV_TOKEN`, pasting the token from your clipboard as value
 5. Re-run the `CI / test` GitHub job in case you tried before and it failed as Codecov was not yet wired up
 
-### Analyzing code quality and security analysis via SonarQube cloud
+## Analyzing code quality and security analysis via SonarQube cloud
 
 1. Sign-Up at https://sonarcloud.io
 2. Grant access to your new repo via https://github.com/settings/installations -> Configure
@@ -21,7 +19,15 @@
 7. Goto https://sonarcloud.io/project/settings?id={{ sonarqube_key }} and select "Quality Gate" in the left menu. Select "Sonar way" as default quality gate.
 8. Re-run the `CI / test` GitHub job in case you tried before and it failed as SonarQube was not yet wired up
 
-### Publishing package to Python Package Index (PyPI)
+## Generating and publishing documentation via ReadTheDocs
+
+1. Sign-Up at https://readthed§cs.org/
+2. Goto https://app.readthedocs.org/dashboard/import/ and search for your repo by enterin {{ github_repository_name}} in the search bar
+3. Select the repo and click Continue, then Next.
+4. On https://app.readthedocs.org/projects/{{ github_repository_name }}/ wait for the build of the documentation to finish
+5. Goto https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/
+
+## Publishing package to Python Package Index (PyPI)
 
 1. Execute `uv run build`. This will generate the build files (wheel and tar.gz) in the `dist` folder
 2. Sign-Up at https://pypi.org/
@@ -33,7 +39,7 @@
 8. Then create a new repository secret called `UV_PUBLISH_TOKEN`, pasting the token from your clipboard as value
 9. In case your `CI / test` job passed, and you are ready to release and publish, bump the version of your project by executing `bump`. In case you tried before completing this setup script, you can as well go to {{ github_repository_url_https }}/actions/workflows/package-build-publish-release.yml, click on the failed job, and re-run.
 
-### Publishing Docker images to Docker Hub (docker.io)
+## Publishing Docker images to Docker Hub (docker.io)
 
 1. Sign-Up at https://hub.docker.com/
 2. Click on your avatar or profile pic and copy the username belwo that into your clipboard.
@@ -42,7 +48,7 @@
 5. Goto {{ github_repository_url_https }}/settings/secrets/actions/new and create a new repository secret called `DOCKER_PASSWORD`, pasting the token from your clipboard as the value
 6. In case your `CI / test` job passed, and you are ready to release and publish, bump the version of your project by executing `bump`. In case you tried before completing this setup script, you can as well go to {{ github_repository_url_https }}/actions/workflows/package-build-publish-release.yml, click on the failed job, and re-run.
 
-### Publishing Docker images to GitHub Container Registry (ghcr.io)
+## Publishing Docker images to GitHub Container Registry (ghcr.io)
 
 1. This just works, no further setup required.
 2. Just `bump` to release and publish.

{oe_python_template-0.1.1 → oe_python_template-0.1.3}/uv.lock

@@ -1927,7 +1927,7 @@ wheels = [
 
 [[package]]
 name = "oe-python-template"
-version = "0.1.1"
+version = "0.1.3"
 source = { editable = "." }
 dependencies = [
     { name = "pydantic" },

oe_python_template-0.1.1/VERSION

@@ -1 +0,0 @@
-0.1.1