oe-python-template 0.2.0__tar.gz → 0.2.2__tar.gz

{oe_python_template-0.2.0 → oe_python_template-0.2.2}/.copier-answers.yml

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

{oe_python_template-0.2.0 → oe_python_template-0.2.2}/.secrets.baseline

@@ -123,5 +123,5 @@
     }
   ],
   "results": {},
-  "generated_at": "2025-03-02T18:16:03Z"
+  "generated_at": "2025-03-02T18:20:48Z"
 }

oe_python_template-0.2.0/RELEASE_NOTES.md → oe_python_template-0.2.2/CHANGELOG.md

@@ -1,5 +1,19 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
+## [0.2.2](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.2.1..0.2.2) - 2025-03-02
+
+### 📚 Documentation
+
+- Update - ([ae71c31](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/ae71c31c917a7439dc24fe9b86c48e38cf1d4c29))
+
+
+## [0.2.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.2.0..v0.2.1) - 2025-03-02
+
+### 📚 Documentation
+
+- Update - ([e718c4c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/e718c4ca41f566e9668566a3ac8cb92b93d93904))
+
+
 ## [0.2.0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.4..v0.2.0) - 2025-03-02
 
 ### 📚 Documentation

{oe_python_template-0.2.0 → oe_python_template-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.2.0
+Version: 0.2.2
 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/
@@ -91,9 +91,60 @@ Description-Content-Type: text/markdown
 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 
 Use Cases:
-1) Lorem Ipsum
-2) Dolor Sit Amet
-3) Consectetur Adipiscing Elit
+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
+
+## Scaffolding Instructions
+
+Step 1: Install uv package manager and copier
+```shell
+if [[ "$OSTYPE" == "darwin"* ]]; then                 # Install dependencies for macOS X
+  if ! command -v brew &> /dev/null; then             ## Install Homebrew if not present
+    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+  fi
+elif [[ "$OSTYPE" == "linux-gnu"* ]]; then            # Install dependencies for Linux
+  sudo apt-get update -y && sudo apt-get install curl -y # Install curl
+fi
+if ! command -v uvx &> /dev/null; then                # Install uv package manager if not present
+  curl -LsSf https://astral.sh/uv/install.sh | sh
+  source $HOME/.local/bin/env
+fi
+uv tool install copier                                # Install copier as global tool
+```
+
+Step 2: Now create an empty repo on GitHub and clone it to your local machine in a directory of your choice. Change to that directory.
+
+Step 3: Scaffold the project
+```shell 
+copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
+```
+Step 4: Setup the local environment
+
+```shell
+uv run nox -s setup_eev
+```
+
+Step 5: Perform inital commit and push
+```shell
+git add .
+git commit -m "feat: Initial commit"
+```
+
+Visit your GitHub repository and check the Actions tab. The CI workflow should fail at the SonarQube step, 
+as this external service is not yet configured for our new repository.
+
+Step 6: Follow the instructions in SERVICE_CONNECTIONS.md to setup the connections to external services 
+such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
+
+Step 7: Release the first versions
+```shell
+./bump
+```
+Notes: 
+* You can remove this section post having successfully scafolded your project.
+* The following sections refer to the dummy application and service provided by this template. 
+  Use them as inspiration and adapt them to your own project.
 
 ## Overview
 
@@ -122,6 +173,7 @@ uvx oe-python-template --help              # all CLI commands
 uvx oe-python-template command --help      # all options for command
 ```
 
+
 ## Highlights
 
 * Copier template to scaffold Python projects compliant with best practices and modern tooling.
@@ -138,6 +190,7 @@ uvx oe-python-template command --help      # all options for command
 * 1-liner for installation and execution of command line interface (CLI) via [uv(x)](https://github.com/astral-sh/uv) or [Docker](https://hub.docker.com/r/helmuthva/oe-python-template/tags)
 * Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
 
+
 ## Usage Examples
 
 ### Minimal Python Script:

{oe_python_template-0.2.0 → oe_python_template-0.2.2}/README.md

@@ -32,9 +32,60 @@
 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 
 Use Cases:
-1) Lorem Ipsum
-2) Dolor Sit Amet
-3) Consectetur Adipiscing Elit
+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
+
+## Scaffolding Instructions
+
+Step 1: Install uv package manager and copier
+```shell
+if [[ "$OSTYPE" == "darwin"* ]]; then                 # Install dependencies for macOS X
+  if ! command -v brew &> /dev/null; then             ## Install Homebrew if not present
+    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+  fi
+elif [[ "$OSTYPE" == "linux-gnu"* ]]; then            # Install dependencies for Linux
+  sudo apt-get update -y && sudo apt-get install curl -y # Install curl
+fi
+if ! command -v uvx &> /dev/null; then                # Install uv package manager if not present
+  curl -LsSf https://astral.sh/uv/install.sh | sh
+  source $HOME/.local/bin/env
+fi
+uv tool install copier                                # Install copier as global tool
+```
+
+Step 2: Now create an empty repo on GitHub and clone it to your local machine in a directory of your choice. Change to that directory.
+
+Step 3: Scaffold the project
+```shell 
+copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
+```
+Step 4: Setup the local environment
+
+```shell
+uv run nox -s setup_eev
+```
+
+Step 5: Perform inital commit and push
+```shell
+git add .
+git commit -m "feat: Initial commit"
+```
+
+Visit your GitHub repository and check the Actions tab. The CI workflow should fail at the SonarQube step, 
+as this external service is not yet configured for our new repository.
+
+Step 6: Follow the instructions in SERVICE_CONNECTIONS.md to setup the connections to external services 
+such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
+
+Step 7: Release the first versions
+```shell
+./bump
+```
+Notes: 
+* You can remove this section post having successfully scafolded your project.
+* The following sections refer to the dummy application and service provided by this template. 
+  Use them as inspiration and adapt them to your own project.
 
 ## Overview
 
@@ -63,6 +114,7 @@ uvx oe-python-template --help              # all CLI commands
 uvx oe-python-template command --help      # all options for command
 ```
 
+
 ## Highlights
 
 * Copier template to scaffold Python projects compliant with best practices and modern tooling.
@@ -79,6 +131,7 @@ uvx oe-python-template command --help      # all options for command
 * 1-liner for installation and execution of command line interface (CLI) via [uv(x)](https://github.com/astral-sh/uv) or [Docker](https://hub.docker.com/r/helmuthva/oe-python-template/tags)
 * Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
 
+
 ## Usage Examples
 
 ### Minimal Python Script:

oe_python_template-0.2.0/CHANGELOG.md → oe_python_template-0.2.2/RELEASE_NOTES.md

@@ -1,6 +1,20 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
-## [0.2.0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.4..0.2.0) - 2025-03-02
+## [0.2.2](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.2.1..v0.2.2) - 2025-03-02
+
+### 📚 Documentation
+
+- Update - ([ae71c31](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/ae71c31c917a7439dc24fe9b86c48e38cf1d4c29))
+
+
+## [0.2.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.2.0..v0.2.1) - 2025-03-02
+
+### 📚 Documentation
+
+- Update - ([e718c4c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/e718c4ca41f566e9668566a3ac8cb92b93d93904))
+
+
+## [0.2.0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.4..v0.2.0) - 2025-03-02
 
 ### 📚 Documentation
 

{oe_python_template-0.2.0 → oe_python_template-0.2.2}/SERVICE_CONNECTIONS.md

@@ -4,7 +4,7 @@
 
 1. Sign-Up at https://app.codecov.io/
 2. Configure via https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen
-3. Copy value of `CODECOV_TOKEN` into your clipboard
+3. Select (o) Repository token. Copy value of `CODECOV_TOKEN` into your clipboard
 4. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/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
 
@@ -21,7 +21,7 @@
 
 ## Generating and publishing documentation via ReadTheDocs (readthedocs.org)
 
-1. Sign-Up at https://readthed§cs.org/
+1. Sign-Up at https://readthedocs.org/
 2. Goto https://app.readthedocs.org/dashboard/import/ and search for your repo by enterin oe-python-template in the search bar
 3. Select the repo and click Continue, then Next.
 4. On https://app.readthedocs.org/projects/oe-python-template/ wait for the build of the documentation to finish
@@ -42,8 +42,8 @@
 ## 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 https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/settings/secrets/actions/new and create a new repository secret called `DOCKER_LOGIN`, setting your username at Docker Hub as the value
+2. Click on your avatar or profile pic and copy the username below that into your clipboard.
+3. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/settings/secrets/actions/new and create a new repository secret called `DOCKER_USERNAME`, 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 oe-python-template, permissions Read & Write & Delete. Copy the value of the token into your clipboard.
 5. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/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 https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/package-build-publish-release.yml, click on the failed job, and re-run.

oe_python_template-0.2.2/VERSION

@@ -0,0 +1 @@
+0.2.2

{oe_python_template-0.2.0 → oe_python_template-0.2.2}/_readme_main.md

@@ -1,9 +1,60 @@
 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 
 Use Cases:
-1) Lorem Ipsum
-2) Dolor Sit Amet
-3) Consectetur Adipiscing Elit
+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
+
+## Scaffolding Instructions
+
+Step 1: Install uv package manager and copier
+```shell
+if [[ "$OSTYPE" == "darwin"* ]]; then                 # Install dependencies for macOS X
+  if ! command -v brew &> /dev/null; then             ## Install Homebrew if not present
+    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+  fi
+elif [[ "$OSTYPE" == "linux-gnu"* ]]; then            # Install dependencies for Linux
+  sudo apt-get update -y && sudo apt-get install curl -y # Install curl
+fi
+if ! command -v uvx &> /dev/null; then                # Install uv package manager if not present
+  curl -LsSf https://astral.sh/uv/install.sh | sh
+  source $HOME/.local/bin/env
+fi
+uv tool install copier                                # Install copier as global tool
+```
+
+Step 2: Now create an empty repo on GitHub and clone it to your local machine in a directory of your choice. Change to that directory.
+
+Step 3: Scaffold the project
+```shell 
+copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
+```
+Step 4: Setup the local environment
+
+```shell
+uv run nox -s setup_eev
+```
+
+Step 5: Perform inital commit and push
+```shell
+git add .
+git commit -m "feat: Initial commit"
+```
+
+Visit your GitHub repository and check the Actions tab. The CI workflow should fail at the SonarQube step, 
+as this external service is not yet configured for our new repository.
+
+Step 6: Follow the instructions in SERVICE_CONNECTIONS.md to setup the connections to external services 
+such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
+
+Step 7: Release the first versions
+```shell
+./bump
+```
+Notes: 
+* You can remove this section post having successfully scafolded your project.
+* The following sections refer to the dummy application and service provided by this template. 
+  Use them as inspiration and adapt them to your own project.
 
 ## Overview
 
@@ -32,6 +83,7 @@ uvx oe-python-template --help              # all CLI commands
 uvx oe-python-template command --help      # all options for command
 ```
 
+
 ## Highlights
 
 * Copier template to scaffold Python projects compliant with best practices and modern tooling.
@@ -48,6 +100,7 @@ uvx oe-python-template command --help      # all options for command
 * 1-liner for installation and execution of command line interface (CLI) via [uv(x)](https://github.com/astral-sh/uv) or [Docker](https://hub.docker.com/r/helmuthva/oe-python-template/tags)
 * Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
 
+
 ## Usage Examples
 
 ### Minimal Python Script:

{oe_python_template-0.2.0 → oe_python_template-0.2.2}/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.2.0"
+version = "0.2.2"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template"

{oe_python_template-0.2.0 → oe_python_template-0.2.2}/pyproject.toml

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

{oe_python_template-0.2.0 → oe_python_template-0.2.2}/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.2.0
+sonar.projectVersion=0.2.2
 sonar.projectDescription=OE Python Template
 sonar.links.homepage=https://oe-python-template.readthedocs.io/en/latest/
 sonar.links.scm=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template

oe_python_template-0.2.2/template/bump.jinja

@@ -0,0 +1,3 @@
+#!/bin/sh
+VERSION_PART=${1:-patch}
+uv run bump-my-version bump "$VERSION_PART" && git push

{oe_python_template-0.2.0 → oe_python_template-0.2.2}/uv.lock

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

oe_python_template-0.2.0/VERSION

@@ -1 +0,0 @@
-0.2.0

oe_python_template-0.2.0/bump

@@ -1,3 +0,0 @@
-#!/bin/sh
-VERSION_PART=${1:-patch}
-bump-my-version bump "$VERSION_PART" && git push