oe-python-template 0.0.1__tar.gz → 0.1.0__tar.gz

{oe_python_template-0.0.1 → oe_python_template-0.1.0}/.copier-answers.yml

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

oe_python_template-0.1.0/CHANGELOG.md

@@ -0,0 +1,41 @@
+[🧠 OE Python Template](https://oe-python-template.readthedocs.io/)
+
+## [0.1.0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.0.2..0.1.0) - 2025-03-02
+
+### ⚙️ Miscellaneous Tasks
+
+- Fix in arch for docker images - ([be8de5b](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/be8de5b1d13587017cdb5b7ecc1bba63ea8245fb))
+
+
+## [0.0.2] - 2025-03-02
+
+### ⛰️  Features
+
+- Various - ([5b74351](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/5b74351e71e2ca6cb7305bcabdbe802df55c4bae))
+- Spike - ([21607c9](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/21607c955cd789dbee6171d287e21f45f039c392))
+
+### 🐛 Bug Fixes
+
+- *(Docker)* Runnability - ([164ab1f](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/164ab1fd7ec517d52587cf7f27f0051bdb6ce319))
+- Initial semver - ([9f6fc12](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/9f6fc125c0e24cc0e31580de94db8beb926c8e36))
+- Test - ([52faa74](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/52faa74b2d448b13dc12a4d8f706b34334643d00))
+- Various - ([f99445f](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/f99445f85b346e0eb69a13c98c2ed311fd4cfafe))
+- Chugging along - ([d59fa54](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/d59fa548abc38e88a4605f9588d57bbf9d70d1dc))
+
+### 🚜 Refactor
+
+- *(gitignore)* Section header - ([4ec3972](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/4ec39725978a1e2a3a6138136313365a7f7ee792))
+- .gitignore - ([ed7d503](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/ed7d503f3c8b6ff0be55b149e1a02729b4097629))
+
+### ⚙️ Miscellaneous Tasks
+
+- *(SonarQube)* Wire - ([be10859](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/be108592780cc12c3e6784737a70921c8b65c966))
+- Deps - ([99fba1c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/99fba1cba195dbbf5bb14c617c1a3bd4124771c5))
+- Clean post self-updating - ([4a8615a](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/4a8615a9a33d61a7b71d7a8ceff2695de6bf94bd))
+- Act - ([650a1ba](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/650a1bac5a76ebafded4fda7f98e6e81cc7a8426))
+
+## New Contributors ❤️
+
+* @helmut-hoffer-von-ankershoffen made their first contribution
+
+

{oe_python_template-0.0.1 → oe_python_template-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.0.1
+Version: 0.1.0
 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/
@@ -126,9 +126,9 @@ uvx oe-python-template command --help      # all options for command
 
 * Copier template to scaffold Python projects compliant with best practices and modern tooling.
 * Various Examples:
+  - [Simple Python script]https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
   - [Streamlit web application](https://oe-python-template.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
   - [Jupyter notebook](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/jupyter.ipynb)
-  - [Simple Python script]https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
 * [Complete reference documenation](https://oe-python-template.readthedocs.io/en/latest/reference.html) on Read the Docs
 * [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template) including unit and E2E tests (reported on Codecov)
 * Matrix tested with [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
@@ -140,28 +140,51 @@ uvx oe-python-template command --help      # all options for command
 
 ## Usage Examples
 
-### Streamlit App
+### Minimal Python Script:
 
-[Try it out!](https://oe-python-template.streamlit.app) - [Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/streamlit.py)
+```python
+"""Example script demonstrating the usage of the service provided by OE Python Template."""
 
+from dotenv import load_dotenv
+from rich.console import Console
 
-### Minimal Python Script:
+from oe_python_template import Service
 
-```python
-"""
-Example script demonstrating the usage of OE Python Template.
+console = Console()
 
-"""
+load_dotenv()
 
-print("Hello World")
+message = Service.get_hello_world()
+console.print(f"[blue]{message}[/blue]")
 ```
 
 [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)
 
+### Streamlit App
+
+Serve the functionality provided by OE Python Template in the web by easily integrating the service into a Streamlit application.
+
+[Try it out!](https://oe-python-template.streamlit.app) - [Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/streamlit.py)
+
+... or serve the app locally
+```shell
+uv sync --all-extras                                # Install streamlit dependency part of the examples extra, see pyproject.toml
+uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, opens browser
+```
+
 ## Jupyter Notebook
 
 [Show notebook code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/jupyter.ipynb)
 
+... or run within VSCode
+
+```shell
+uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+```
+Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
+
+Click on `examples/jupyter.ipynb` in VSCode and run it.
+
 ## Command Line Interface (CLI)
 
 ### Run with [uvx](https://docs.astral.sh/uv/guides/tools/)
@@ -172,33 +195,47 @@ Show available commands:
 uvx oe-python-template --help
 ```
 
-Execute command:
+Execute commands:
 
 ```shell
-uvx oe-python-template command "Lorem Ipsum"
+uvx oe-python-template hello-world
+uvx oe-python-template hello-world --json
+uvx oe-python-template echo "Lorem Ipsum"
 ```
 
-### Run with Docker
+### Environment
 
-Note: Replace ENV_KEY_TEST with Lorem Ipsum.
+The service loads environment variables including support for .env files.
 
-Show available commands:
+```shell
+cp .env.example .env              # copy example file
+echo "THE_VAR=MY_VALUE" > .env    # overwrite with your values
+```
+
+Now run the usage examples again.
+
+### Run with Docker
 
-```bash
+You can as well run the CLI within Docker.
+
+```shell
 docker run helmuthva/oe-python-template --help
+docker run helmuthva/oe-python-template hello-world
+docker run helmuthva/oe-python-template hello-world --json
+docker run helmuthva/oe-python-template echo "Lorem"
 ```
 
 Execute command:
 
-```bash
-docker run --env ENV_KEY_TEST=ENV_VALUE_TEST helmuthva/oe-python-template command "Lorem Ipsum"
+```shell
+docker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template echo "Lorem Ipsum"
 ```
 
 Or use docker compose
 
-File .env is passed through
+The .env is passed through from the host to the Docker container.
 
-```bash
+```shell
 docker compose up
 docker compose run oe-python-template --help
 ```

{oe_python_template-0.0.1 → oe_python_template-0.1.0}/README.md

@@ -67,9 +67,9 @@ uvx oe-python-template command --help      # all options for command
 
 * Copier template to scaffold Python projects compliant with best practices and modern tooling.
 * Various Examples:
+  - [Simple Python script]https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
   - [Streamlit web application](https://oe-python-template.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
   - [Jupyter notebook](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/jupyter.ipynb)
-  - [Simple Python script]https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
 * [Complete reference documenation](https://oe-python-template.readthedocs.io/en/latest/reference.html) on Read the Docs
 * [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template) including unit and E2E tests (reported on Codecov)
 * Matrix tested with [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
@@ -81,28 +81,51 @@ uvx oe-python-template command --help      # all options for command
 
 ## Usage Examples
 
-### Streamlit App
+### Minimal Python Script:
 
-[Try it out!](https://oe-python-template.streamlit.app) - [Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/streamlit.py)
+```python
+"""Example script demonstrating the usage of the service provided by OE Python Template."""
 
+from dotenv import load_dotenv
+from rich.console import Console
 
-### Minimal Python Script:
+from oe_python_template import Service
 
-```python
-"""
-Example script demonstrating the usage of OE Python Template.
+console = Console()
 
-"""
+load_dotenv()
 
-print("Hello World")
+message = Service.get_hello_world()
+console.print(f"[blue]{message}[/blue]")
 ```
 
 [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)
 
+### Streamlit App
+
+Serve the functionality provided by OE Python Template in the web by easily integrating the service into a Streamlit application.
+
+[Try it out!](https://oe-python-template.streamlit.app) - [Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/streamlit.py)
+
+... or serve the app locally
+```shell
+uv sync --all-extras                                # Install streamlit dependency part of the examples extra, see pyproject.toml
+uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, opens browser
+```
+
 ## Jupyter Notebook
 
 [Show notebook code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/jupyter.ipynb)
 
+... or run within VSCode
+
+```shell
+uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+```
+Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
+
+Click on `examples/jupyter.ipynb` in VSCode and run it.
+
 ## Command Line Interface (CLI)
 
 ### Run with [uvx](https://docs.astral.sh/uv/guides/tools/)
@@ -113,33 +136,47 @@ Show available commands:
 uvx oe-python-template --help
 ```
 
-Execute command:
+Execute commands:
 
 ```shell
-uvx oe-python-template command "Lorem Ipsum"
+uvx oe-python-template hello-world
+uvx oe-python-template hello-world --json
+uvx oe-python-template echo "Lorem Ipsum"
 ```
 
-### Run with Docker
+### Environment
 
-Note: Replace ENV_KEY_TEST with Lorem Ipsum.
+The service loads environment variables including support for .env files.
 
-Show available commands:
+```shell
+cp .env.example .env              # copy example file
+echo "THE_VAR=MY_VALUE" > .env    # overwrite with your values
+```
+
+Now run the usage examples again.
+
+### Run with Docker
 
-```bash
+You can as well run the CLI within Docker.
+
+```shell
 docker run helmuthva/oe-python-template --help
+docker run helmuthva/oe-python-template hello-world
+docker run helmuthva/oe-python-template hello-world --json
+docker run helmuthva/oe-python-template echo "Lorem"
 ```
 
 Execute command:
 
-```bash
-docker run --env ENV_KEY_TEST=ENV_VALUE_TEST helmuthva/oe-python-template command "Lorem Ipsum"
+```shell
+docker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template echo "Lorem Ipsum"
 ```
 
 Or use docker compose
 
-File .env is passed through
+The .env is passed through from the host to the Docker container.
 
-```bash
+```shell
 docker compose up
 docker compose run oe-python-template --help
 ```

oe_python_template-0.1.0/RELEASE_NOTES.md

@@ -0,0 +1,41 @@
+[🧠 OE Python Template](https://oe-python-template.readthedocs.io/)
+
+## [0.1.0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.0.2..v0.1.0) - 2025-03-02
+
+### ⚙️ Miscellaneous Tasks
+
+- Fix in arch for docker images - ([be8de5b](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/be8de5b1d13587017cdb5b7ecc1bba63ea8245fb))
+
+
+## [0.0.2] - 2025-03-02
+
+### ⛰️  Features
+
+- Various - ([5b74351](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/5b74351e71e2ca6cb7305bcabdbe802df55c4bae))
+- Spike - ([21607c9](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/21607c955cd789dbee6171d287e21f45f039c392))
+
+### 🐛 Bug Fixes
+
+- *(Docker)* Runnability - ([164ab1f](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/164ab1fd7ec517d52587cf7f27f0051bdb6ce319))
+- Initial semver - ([9f6fc12](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/9f6fc125c0e24cc0e31580de94db8beb926c8e36))
+- Test - ([52faa74](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/52faa74b2d448b13dc12a4d8f706b34334643d00))
+- Various - ([f99445f](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/f99445f85b346e0eb69a13c98c2ed311fd4cfafe))
+- Chugging along - ([d59fa54](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/d59fa548abc38e88a4605f9588d57bbf9d70d1dc))
+
+### 🚜 Refactor
+
+- *(gitignore)* Section header - ([4ec3972](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/4ec39725978a1e2a3a6138136313365a7f7ee792))
+- .gitignore - ([ed7d503](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/ed7d503f3c8b6ff0be55b149e1a02729b4097629))
+
+### ⚙️ Miscellaneous Tasks
+
+- *(SonarQube)* Wire - ([be10859](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/be108592780cc12c3e6784737a70921c8b65c966))
+- Deps - ([99fba1c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/99fba1cba195dbbf5bb14c617c1a3bd4124771c5))
+- Clean post self-updating - ([4a8615a](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/4a8615a9a33d61a7b71d7a8ceff2695de6bf94bd))
+- Act - ([650a1ba](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/650a1bac5a76ebafded4fda7f98e6e81cc7a8426))
+
+## New Contributors ❤️
+
+* @helmut-hoffer-von-ankershoffen made their first contribution
+
+

oe_python_template-0.1.0/TEMPLATE.md

@@ -0,0 +1,48 @@
+# Readme of the template
+
+## Setup service connections
+
+### Reporting code coverage via CodeCov
+
+1. Sign-Up at https://app.codecov.io/
+2. Configure via https://app.codecov.io/gh/{{ github_repository_owner }}
+3. Copy value of `CODECOV_TOKEN` into your clipboard
+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
+
+1. Sign-Up at https://sonarcloud.io
+2. Grant access to your new repo via https://github.com/settings/installations -> Configure
+3. Goto https://sonarcloud.io/projects/create and select the repo
+4. Select Previous Code when prompted
+5. Configure by going to https://sonarcloud.io/project/configuration?id={{ sonarqube_key }} and clicking on "With GitHub Actions". Copy the value of `SONAR_TOKEN` into your clipboard.
+6. Goto {{ github_repository_url_https }}/settings/secrets/actions/new and create a new repository secret called `SONAR_TOKEN`, pasting the token from your clipboard as the value
+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)
+
+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/
+3. Goto https://pypi.org/manage/account/ and create an API token of scope "Entire account", calling it {{ github_repository_name }}. Copy the value of the token into your clipboard.
+4. Execute `uv run publish`, entering __token__ as username and paste the token from your clipboard as password. This will register your package on PyPI and upload the build files
+5. Goto https://pypi.org/manage/account/ again and delete the previously created token {{ github_repository_name }} of scope "Entire account".
+6. Now create an new API token, again called {{ github_repository_name }}, but this time of scope "Project: {{ github_repository_name }}". Copy the token into your clipboard.
+7. Goto {{ github_repository_url_https }}/settings/secrets/actions/new and delete the previously created token.
+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)
+
+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.
+3. Goto {{ github_repository_url_https }}/settings/secrets/actions/new and create a new repository secret called `DOCKER_LOGIN`, setting your username at Docker Hub as the value
+4. Goto https://app.docker.com/settings/personal-access-tokens/create and create a new access token setting the description to {{ github_repository_name }}, permissions Read & Write & Delete. Copy the value of the token into your clipboard.
+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)
+
+1. This just works, no further setup required.
+2. Just `bump` to release and publish.

oe_python_template-0.1.0/VERSION

@@ -0,0 +1 @@
+0.1.0

{oe_python_template-0.0.1 → oe_python_template-0.1.0}/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.0.1"
+version = "0.1.0"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template"
@@ -74,7 +74,7 @@ html_static_path = ["_static"]
 html_logo = "../../logo.png"
 html_theme_options = {
     "announcement": (
-        '<a target="_blank" href="https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template">GitHub</a> - '  # noqa: E501
+        '<a target="_blank" href="https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template">GitHub</a> - '
         '<a target="_blank" href="https://pypi.org/project/oe-python-template">PyPI</a> - '
         '<a target="_blank" href="https://hub.docker.com/r/helmuthva/oe-python-template/tags">Docker</a> - '
         '<a target="_blank" href="https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template">SonarQube</a> - '  # noqa: E501

{oe_python_template-0.0.1 → oe_python_template-0.1.0}/examples/jupyter.ipynb

@@ -2,18 +2,15 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 1,
    "metadata": {},
    "outputs": [
     {
-     "data": {
-      "text/plain": [
-       "'Hello, world!'"
-      ]
-     },
-     "execution_count": 13,
-     "metadata": {},
-     "output_type": "execute_result"
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Hello, world! The value of THE_VAR is not defined\n"
+     ]
     }
    ],
    "source": [