oe-python-template 0.7.0__tar.gz → 0.7.2__tar.gz

{oe_python_template-0.7.0 → oe_python_template-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.7.0
+Version: 0.7.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/
@@ -154,48 +154,32 @@ Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-templ
 
 ## Generate a new project
 
-This template is designed to be used with the [copier](https://copier.readthedocs.io/en/stable/) project generator. It allows you to create a new project based on this template and customize it according to your needs.
-To generate a new project, follow these steps:
+To generate, build and release a fully functioning project in a few minutes, follow these 5 steps:
 
-**Step 1**: Install homebrew, uv package manager amd further tools. Copy the following code into your terminal and execute it.
+**Step 1**: Execute the following command to install or update tooling.
 ```shell
-if [[ "$OSTYPE" == "linux-gnu"* ]]; then                  # Install Linux specifics
-  sudo apt-get update -y && sudo apt-get install curl -y  # https://curl.se/
-fi
-if ! command -v brew &> /dev/null; then                   # https://brew.sh/
-  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
-  brew update                                             # Update Homebrew bundles
-fi
-which uv &> /dev/null || brew install uv                  # https://docs.astral.sh/uv/
-which git &> /dev/null || brew install git                # https://git-scm.com/
-which gpg &> /dev/null || brew install gnupg              # https://gnupg.org/
-which pinact &> /dev/null || brew install pinact          # https://github.com/suzuki-shunsuke/pinact
-which jq &> /dev/null || brew install jq                  # https://jqlang.org/
-which libxml2 &> /dev/null || brew install libxml2        # https://en.wikipedia.org/wiki/Libxml2
-which act &> /dev/null || brew install act                # https://nektosact.com/
-which pinact &> /dev/null || brew install pinact          # https://github.com/suzuki-shunsuke/pinact
-if [[ "$OSTYPE" == "darwin"* ]]; then                     # Install macOS specifics
-  which pinentry-mac &> /dev/null || brew install gnupg   # https://github.com/GPGTools/pinentry
-fi
-uv tool install copier                                    # https://copier.readthedocs.io/en/stable/
+# Install Homebrew, uv package manager, copier and further dev tools
+curl -LsSf https://raw.githubusercontent.com/helmut-hoffer-von-ankershoffen/oe-python-template/HEAD/install.sh | sh
 ```
 
 **Step 2**: [Create a repository on GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository), clone to your local machine, and change into it's directory.
 
-**Step 3**: Generate the project. Copy
+**Step 3**: Execute the following command to generate a new project based on this template.
 ```shell
-# ensure to stand in a git repository before executing the next command
+# Ensure to stand in a git repository before executing the next command
 copier copy --trust gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 ```
 
-**Step 4**: Perform initial commit and push. Copy the following code into your terminal and execute it.
+**Step 4**: Execute the following commands to push your initial commit to GitHub.
 ```shell
 git add .
 git commit -m "chore: Initial commit"
 git push
 ```
 
-Visit your GitHub repository and check the Actions tab. The CI workflow should already be running! The workflow will fail at the SonarQube step, as this external service is not yet configured for our new repository.
+Check the [Actions tab](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions) of your GitHub repository: The CI/CD workflow of your project is already running!
+
+The workflow will fail at the SonarQube step, as this external service is not yet configured for our new repository. We will configure SonarQube and other services in the next step!
 
 Notes:
 1. Check out [this manual](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key) on how to set up signed commits
@@ -416,11 +400,30 @@ docker compose run oe-python-template echo "Lorem"
 docker compose run oe-python-template echo "Lorem" --json
 docker compose run oe-python-template openapi
 docker compose run oe-python-template openapi --output-format=json
-docker compose up
+echo "Running OE Python Template's API container as a daemon ..."
+docker compose up -d
+echo "Waiting for the API server to start ..."
+sleep 5
+echo "Checking health of v1 API ..."
+curl http://127.0.0.1:8000/api/v1/healthz
+echo ""
+echo "Saying hello world with v1 API ..."
 curl http://127.0.0.1:8000/api/v1/hello-world
+echo ""
+echo "Swagger docs of v1 API ..."
 curl http://127.0.0.1:8000/api/v1/docs
+echo ""
+echo "Checking health of v2 API ..."
+curl http://127.0.0.1:8000/api/v2/healthz
+echo ""
+echo "Saying hello world with v1 API ..."
 curl http://127.0.0.1:8000/api/v2/hello-world
+echo ""
+echo "Swagger docs of v2 API ..."
 curl http://127.0.0.1:8000/api/v2/docs
+echo ""
+echo "Shutting down the API container ..."
+docker compose down
 ```
 
 ## Extra: Lorem Ipsum

{oe_python_template-0.7.0 → oe_python_template-0.7.2}/README.md

@@ -93,48 +93,32 @@ Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-templ
 
 ## Generate a new project
 
-This template is designed to be used with the [copier](https://copier.readthedocs.io/en/stable/) project generator. It allows you to create a new project based on this template and customize it according to your needs.
-To generate a new project, follow these steps:
+To generate, build and release a fully functioning project in a few minutes, follow these 5 steps:
 
-**Step 1**: Install homebrew, uv package manager amd further tools. Copy the following code into your terminal and execute it.
+**Step 1**: Execute the following command to install or update tooling.
 ```shell
-if [[ "$OSTYPE" == "linux-gnu"* ]]; then                  # Install Linux specifics
-  sudo apt-get update -y && sudo apt-get install curl -y  # https://curl.se/
-fi
-if ! command -v brew &> /dev/null; then                   # https://brew.sh/
-  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
-  brew update                                             # Update Homebrew bundles
-fi
-which uv &> /dev/null || brew install uv                  # https://docs.astral.sh/uv/
-which git &> /dev/null || brew install git                # https://git-scm.com/
-which gpg &> /dev/null || brew install gnupg              # https://gnupg.org/
-which pinact &> /dev/null || brew install pinact          # https://github.com/suzuki-shunsuke/pinact
-which jq &> /dev/null || brew install jq                  # https://jqlang.org/
-which libxml2 &> /dev/null || brew install libxml2        # https://en.wikipedia.org/wiki/Libxml2
-which act &> /dev/null || brew install act                # https://nektosact.com/
-which pinact &> /dev/null || brew install pinact          # https://github.com/suzuki-shunsuke/pinact
-if [[ "$OSTYPE" == "darwin"* ]]; then                     # Install macOS specifics
-  which pinentry-mac &> /dev/null || brew install gnupg   # https://github.com/GPGTools/pinentry
-fi
-uv tool install copier                                    # https://copier.readthedocs.io/en/stable/
+# Install Homebrew, uv package manager, copier and further dev tools
+curl -LsSf https://raw.githubusercontent.com/helmut-hoffer-von-ankershoffen/oe-python-template/HEAD/install.sh | sh
 ```
 
 **Step 2**: [Create a repository on GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository), clone to your local machine, and change into it's directory.
 
-**Step 3**: Generate the project. Copy
+**Step 3**: Execute the following command to generate a new project based on this template.
 ```shell
-# ensure to stand in a git repository before executing the next command
+# Ensure to stand in a git repository before executing the next command
 copier copy --trust gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 ```
 
-**Step 4**: Perform initial commit and push. Copy the following code into your terminal and execute it.
+**Step 4**: Execute the following commands to push your initial commit to GitHub.
 ```shell
 git add .
 git commit -m "chore: Initial commit"
 git push
 ```
 
-Visit your GitHub repository and check the Actions tab. The CI workflow should already be running! The workflow will fail at the SonarQube step, as this external service is not yet configured for our new repository.
+Check the [Actions tab](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions) of your GitHub repository: The CI/CD workflow of your project is already running!
+
+The workflow will fail at the SonarQube step, as this external service is not yet configured for our new repository. We will configure SonarQube and other services in the next step!
 
 Notes:
 1. Check out [this manual](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key) on how to set up signed commits
@@ -355,11 +339,30 @@ docker compose run oe-python-template echo "Lorem"
 docker compose run oe-python-template echo "Lorem" --json
 docker compose run oe-python-template openapi
 docker compose run oe-python-template openapi --output-format=json
-docker compose up
+echo "Running OE Python Template's API container as a daemon ..."
+docker compose up -d
+echo "Waiting for the API server to start ..."
+sleep 5
+echo "Checking health of v1 API ..."
+curl http://127.0.0.1:8000/api/v1/healthz
+echo ""
+echo "Saying hello world with v1 API ..."
 curl http://127.0.0.1:8000/api/v1/hello-world
+echo ""
+echo "Swagger docs of v1 API ..."
 curl http://127.0.0.1:8000/api/v1/docs
+echo ""
+echo "Checking health of v2 API ..."
+curl http://127.0.0.1:8000/api/v2/healthz
+echo ""
+echo "Saying hello world with v1 API ..."
 curl http://127.0.0.1:8000/api/v2/hello-world
+echo ""
+echo "Swagger docs of v2 API ..."
 curl http://127.0.0.1:8000/api/v2/docs
+echo ""
+echo "Shutting down the API container ..."
+docker compose down
 ```
 
 ## Extra: Lorem Ipsum

{oe_python_template-0.7.0 → oe_python_template-0.7.2}/pyproject.toml

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