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

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

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

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

@@ -123,5 +123,5 @@
     }
   ],
   "results": {},
-  "generated_at": "2025-03-02T16:35:26Z"
+  "generated_at": "2025-03-02T18:16:03Z"
 }

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

@@ -1,5 +1,12 @@
 [🧠 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
+
+### 📚 Documentation
+
+- Start to document the template and setup process - ([d37c39c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/d37c39c518736301aadf1192f9a48c4cfd1ded6e))
+
+
 ## [0.1.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.3..v0.1.4) - 2025-03-02
 
 ### ⛰️  Features

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.1.4
+Version: 0.2.0
 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/

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

@@ -1,6 +1,13 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
-## [0.1.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.3..0.1.4) - 2025-03-02
+## [0.2.0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.4..v0.2.0) - 2025-03-02
+
+### 📚 Documentation
+
+- Start to document the template and setup process - ([d37c39c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/d37c39c518736301aadf1192f9a48c4cfd1ded6e))
+
+
+## [0.1.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.3..v0.1.4) - 2025-03-02
 
 ### ⛰️  Features
 

oe_python_template-0.2.0/VERSION

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

{oe_python_template-0.1.4 → oe_python_template-0.2.0}/copier.yml

@@ -34,11 +34,14 @@ project_name_snake_case_upper:
 project_description:
   type: str
   help: What does project {{ project_name }} do in one sentence?
-  placeholder: Python project complying with operational excellence practices.
+  placeholder: "Python project complying with operational excellence practices."
   validator: >-
-    {% if not project_description.strip() %}
-    Invalid project description
-    {% endif %}
+      {% if not project_description.strip() %}
+      Project description must not be empty.
+      {% endif %}
+      {% if not project_description.strip().endswith('.') %}
+      Project description must end with a dot.
+      {% endif %}
 
 author_name:
   type: str
@@ -190,12 +193,12 @@ streamlit_project_key:
 #    - application
 #    - shared library
 #  default: package
-# 
+#
 # python_version:
 #   type: str
 #   help: "{% if project_type == 'app' %}Which Python version should your app use?{% else %}What is the minimum Python version your package should support?{% endif %}"
 #   default: "{% if project_type == 'app' %}3.12{% else %}3.10{% endif %}"
-# 
+#
 # ci:
 #   type: str
 #   help: Which CI/CD provider would you like to use?
@@ -204,7 +207,7 @@ streamlit_project_key:
 #     GitLab CI/CD: gitlab
 #   default: "{% if 'github' in project_url %}github{% else %}gitlab{% endif %}"
 #   when: "{{ 'github' not in project_url and 'gitlab' not in project_url }}"
-# 
+#
 # typing:
 #   type: str
 #   help: Do you want to use optional or strict typing and linting?
@@ -212,18 +215,18 @@ streamlit_project_key:
 #     Optional: optional
 #     Strict: strict
 #   default: optional
-# 
+#
 # with_conventional_commits:
 #   type: bool
 #   help: Do you want to follow the Conventional Commits standard (https://www.conventionalcommits.org) for your commit messages?
 #   default: true
-# 
+#
 # with_fastapi_api:
 #   type: bool
 #   help: Does your app need a FastAPI API?
 #   default: false
 #   when: "{{ project_type == 'app' }}"
-# 
+#
 # with_typer_cli:
 #   type: bool
 #   help: Does your {{ project_type }} need a Typer CLI?

{oe_python_template-0.1.4 → oe_python_template-0.2.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.1.4"
+version = "0.2.0"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template"

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

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.1.4"
+version = "0.2.0"
 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.1.4"
+current_version = "0.2.0"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template-0.1.4 → oe_python_template-0.2.0}/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.4
+sonar.projectVersion=0.2.0
 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.0/template/README.md

@@ -0,0 +1 @@
+Will be generated from readme_*.md partials.

{oe_python_template-0.1.4 → oe_python_template-0.2.0}/template/SERVICE_CONNECTIONS.md.jinja

@@ -4,7 +4,7 @@
 
 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
+3. Select (o) Repository token. 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
 
@@ -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 {{ 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
@@ -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 {{ 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
+2. Click on your avatar or profile pic and copy the username below that into your clipboard.
+3. Goto {{ github_repository_url_https }}/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 {{ 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.

{oe_python_template-0.1.4 → oe_python_template-0.2.0}/template/_readme_main.md.jinja

@@ -1,9 +1,60 @@
 {{ project_description }}
 
 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 {{ pypi_distribution_name}} --help              # all CLI commands
 uvx {{ pypi_distribution_name}} command --help      # all options for command
 ```
 
+
 ## Highlights
 
 * {{ project_description}}
@@ -48,6 +100,7 @@ uvx {{ pypi_distribution_name}} 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/{{ docker_io_owner }}/{{ docker_io_image_name }}/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/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.1.4 → oe_python_template-0.2.0}/template/docs/source/conf.py.jinja

@@ -75,10 +75,10 @@ html_logo = "../../logo.png"
 html_theme_options = {
     "announcement": (
         '<a target="_blank" href="{{ github_repository_url_https }}">GitHub</a> - '  # noqa: E501
-        '<a target="_blank" href="https://pypi.org/project/{{ pypi_distribution_name }}">PyPI</a> - '
-        '<a target="_blank" href="https://hub.docker.com/r/{{ docker_io_owner}}/{{ docker_io_image_name }}/tags">Docker</a> - '
+        '<a target="_blank" href="https://pypi.org/project/{{ pypi_distribution_name }}">PyPI</a> - '  # noqa: E501
+        '<a target="_blank" href="https://hub.docker.com/r/{{ docker_io_owner}}/{{ docker_io_image_name }}/tags">Docker</a> - '  # noqa: E501
         '<a target="_blank" href="https://sonarcloud.io/summary/new_code?id={{ sonarqube_key }}">SonarQube</a> - '  # noqa: E501
-        '<a target="_blank" href="https://app.codecov.io/gh/{{ github_repository_owner }}/{{ github_repository_name}}">Codecov</a>'
+        '<a target="_blank" href="https://app.codecov.io/gh/{{ github_repository_owner }}/{{ github_repository_name}}">Codecov</a>'  # noqa: E501
     ),
 }
 

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

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

oe_python_template-0.1.4/VERSION

@@ -1 +0,0 @@
-0.1.4

oe_python_template-0.1.4/template/bump.jinja

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