oe-python-template 0.3.9__tar.gz → 0.4.1__tar.gz

{oe_python_template-0.3.9 → oe_python_template-0.4.1}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.3.8-1-gb8f2dab
+_commit: v0.4.0-1-gdfc1c47
 _src_path: .
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template-0.3.9 → oe_python_template-0.4.1}/.pre-commit-config.yaml

@@ -14,6 +14,7 @@ repos:
     hooks:
       - id: python-check-blanket-noqa
       - id: python-check-blanket-type-ignore
+        exclude: "^examples/notebook.py$"
       - id: python-check-mock-methods
       - id: python-no-eval
       - id: python-no-log-warn

{oe_python_template-0.3.9 → oe_python_template-0.4.1}/.secrets.baseline

@@ -123,5 +123,5 @@
     }
   ],
   "results": {},
-  "generated_at": "2025-03-12T20:19:08Z"
+  "generated_at": "2025-03-13T06:50:07Z"
 }

{oe_python_template-0.3.9 → oe_python_template-0.4.1}/CHANGELOG.md

@@ -1,6 +1,20 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
-## [0.3.9](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.3.8..0.3.9) - 2025-03-12
+## [0.4.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.0..0.4.1) - 2025-03-13
+
+### 🐛 Bug Fixes
+
+- *(tests)* Test_cli_serve - ([ac1a02c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/ac1a02c04f39c664d71ffa127af72635b5eadfa5))
+
+
+## [0.4.0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.3.9..v0.4.0) - 2025-03-13
+
+### ⛰️  Features
+
+- Versioned API - ([dccaa20](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/dccaa202225102f2065f06a7079a2e7490474ca3))
+
+
+## [0.3.9](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.3.8..v0.3.9) - 2025-03-12
 
 ### ⛰️  Features
 

{oe_python_template-0.3.9 → oe_python_template-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.3.9
+Version: 0.4.1
 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/
@@ -101,9 +101,9 @@ Use Cases:
 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
+## Scaffolding
 
-Step 1: Install uv package manager and copier
+**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
@@ -119,31 +119,32 @@ 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 2**: Now create an empty repository on GitHubm, clone to your local machine, and change into it's directory.
 
-Step 3: Scaffold the project
+**Step 3**: Scaffold the project
 ```shell
 copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 ```
-Step 4: Setup the local environment
+**Step 4**: Setup the local environment
 
 ```shell
 uv run nox -s setup_dev
 ```
 
-Step 5: Perform inital commit and push
+**Step 5**: Perform initial commit and push
 ```shell
 git add .
 git commit -m "feat: Initial commit"
+git push
 ```
 
 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 6**: Follow the [SERVICE_INSTRUCTIONS.md](instructions) to wire up
+external services such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
 
-Step 7: Release the first versions
+**Step 7**: Release the first versions
 ```shell
 ./bump
 ```
@@ -166,24 +167,38 @@ If you don't have uv installed follow [these instructions](https://docs.astral.s
 pip install oe-python-template        # add dependency to your project
 ```
 
-Executing the command line interface (CLI) is just as easy:
+Executing the command line interface (CLI) in an isolated Python environment is just as easy:
 
 ```shell
-uvx oe-python-template
+uvx oe-python-template hello-world     # prints "Hello, world! [..]"
+uvx oe-python-template serve           # serves webservice API
 ```
 
+When serving the API, go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the result.
+
+The API is versioned and provides interactive documentation at [http://127.0.0.1:8000/api/v1/docs](http://127.0.0.1:8000/api/v1/docs) resp. [http://127.0.0.1:8000/api/v2/docs](http://127.0.0.1:8000/api/v2/docs)
+
+
+```shell
+
+When running the webservice API, goto http://127.0.0.1:8000/api/v1/docs
+
 The CLI provides extensive help:
 
 ```shell
 uvx oe-python-template --help                # all CLI commands
 uvx oe-python-template hello-world --help    # help for specific command
+uvx oe-python-template echo --help
+uvx oe-python-template openapi --help
+uvx oe-python-template serve --help
 ```
 
 
-## Highlights
+## Operational Excellence
+
+This project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:
 
-* Copier template to scaffold Python projects compliant with best practices and modern tooling.
-* Various Examples:
+* Various examples demonstrating usage:
   - [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](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py) notebook
@@ -199,6 +214,9 @@ uvx oe-python-template hello-world --help    # help for specific command
 
 ## Usage Examples
 
+The following examples run from source. Clone this repository first using
+`git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template.git`.
+
 ### Minimal Python Script:
 
 ```python
@@ -240,7 +258,7 @@ uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, o
 ... or run within VSCode
 
 ```shell
-uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+uv sync --all-extras                                # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml
 ```
 Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
 
@@ -337,7 +355,10 @@ 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
-curl http://127.0.0.1 8000
+curl http://127.0.0.1:8000/api/v1/hello-world
+curl http://127.0.0.1:8000/api/v1/docs
+curl http://127.0.0.1:8000/api/v2/hello-world
+curl http://127.0.0.1:8000/api/v2/docs
 ```
 
 ## Extra: Lorem Ipsum

{oe_python_template-0.3.9 → oe_python_template-0.4.1}/README.md

@@ -40,9 +40,9 @@ Use Cases:
 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
+## Scaffolding
 
-Step 1: Install uv package manager and copier
+**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
@@ -58,31 +58,32 @@ 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 2**: Now create an empty repository on GitHubm, clone to your local machine, and change into it's directory.
 
-Step 3: Scaffold the project
+**Step 3**: Scaffold the project
 ```shell
 copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 ```
-Step 4: Setup the local environment
+**Step 4**: Setup the local environment
 
 ```shell
 uv run nox -s setup_dev
 ```
 
-Step 5: Perform inital commit and push
+**Step 5**: Perform initial commit and push
 ```shell
 git add .
 git commit -m "feat: Initial commit"
+git push
 ```
 
 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 6**: Follow the [SERVICE_INSTRUCTIONS.md](instructions) to wire up
+external services such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
 
-Step 7: Release the first versions
+**Step 7**: Release the first versions
 ```shell
 ./bump
 ```
@@ -105,24 +106,38 @@ If you don't have uv installed follow [these instructions](https://docs.astral.s
 pip install oe-python-template        # add dependency to your project
 ```
 
-Executing the command line interface (CLI) is just as easy:
+Executing the command line interface (CLI) in an isolated Python environment is just as easy:
 
 ```shell
-uvx oe-python-template
+uvx oe-python-template hello-world     # prints "Hello, world! [..]"
+uvx oe-python-template serve           # serves webservice API
 ```
 
+When serving the API, go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the result.
+
+The API is versioned and provides interactive documentation at [http://127.0.0.1:8000/api/v1/docs](http://127.0.0.1:8000/api/v1/docs) resp. [http://127.0.0.1:8000/api/v2/docs](http://127.0.0.1:8000/api/v2/docs)
+
+
+```shell
+
+When running the webservice API, goto http://127.0.0.1:8000/api/v1/docs
+
 The CLI provides extensive help:
 
 ```shell
 uvx oe-python-template --help                # all CLI commands
 uvx oe-python-template hello-world --help    # help for specific command
+uvx oe-python-template echo --help
+uvx oe-python-template openapi --help
+uvx oe-python-template serve --help
 ```
 
 
-## Highlights
+## Operational Excellence
+
+This project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:
 
-* Copier template to scaffold Python projects compliant with best practices and modern tooling.
-* Various Examples:
+* Various examples demonstrating usage:
   - [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](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py) notebook
@@ -138,6 +153,9 @@ uvx oe-python-template hello-world --help    # help for specific command
 
 ## Usage Examples
 
+The following examples run from source. Clone this repository first using
+`git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template.git`.
+
 ### Minimal Python Script:
 
 ```python
@@ -179,7 +197,7 @@ uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, o
 ... or run within VSCode
 
 ```shell
-uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+uv sync --all-extras                                # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml
 ```
 Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
 
@@ -276,7 +294,10 @@ 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
-curl http://127.0.0.1 8000
+curl http://127.0.0.1:8000/api/v1/hello-world
+curl http://127.0.0.1:8000/api/v1/docs
+curl http://127.0.0.1:8000/api/v2/hello-world
+curl http://127.0.0.1:8000/api/v2/docs
 ```
 
 ## Extra: Lorem Ipsum

oe_python_template-0.4.1/RELEASE_NOTES.md

@@ -0,0 +1,8 @@
+## [0.4.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.4.0..v0.4.1) - 2025-03-13
+
+### 🐛 Bug Fixes
+
+- *(tests)* Test_cli_serve - ([ac1a02c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/ac1a02c04f39c664d71ffa127af72635b5eadfa5))
+
+
+

oe_python_template-0.4.1/VERSION

@@ -0,0 +1 @@
+0.4.1

{oe_python_template-0.3.9 → oe_python_template-0.4.1}/_readme_main.md

@@ -5,9 +5,9 @@ Use Cases:
 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
+## Scaffolding
 
-Step 1: Install uv package manager and copier
+**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
@@ -23,31 +23,32 @@ 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 2**: Now create an empty repository on GitHubm, clone to your local machine, and change into it's directory.
 
-Step 3: Scaffold the project
+**Step 3**: Scaffold the project
 ```shell
 copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 ```
-Step 4: Setup the local environment
+**Step 4**: Setup the local environment
 
 ```shell
 uv run nox -s setup_dev
 ```
 
-Step 5: Perform inital commit and push
+**Step 5**: Perform initial commit and push
 ```shell
 git add .
 git commit -m "feat: Initial commit"
+git push
 ```
 
 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 6**: Follow the [SERVICE_INSTRUCTIONS.md](instructions) to wire up
+external services such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
 
-Step 7: Release the first versions
+**Step 7**: Release the first versions
 ```shell
 ./bump
 ```
@@ -70,24 +71,38 @@ If you don't have uv installed follow [these instructions](https://docs.astral.s
 pip install oe-python-template        # add dependency to your project
 ```
 
-Executing the command line interface (CLI) is just as easy:
+Executing the command line interface (CLI) in an isolated Python environment is just as easy:
 
 ```shell
-uvx oe-python-template
+uvx oe-python-template hello-world     # prints "Hello, world! [..]"
+uvx oe-python-template serve           # serves webservice API
 ```
 
+When serving the API, go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the result.
+
+The API is versioned and provides interactive documentation at [http://127.0.0.1:8000/api/v1/docs](http://127.0.0.1:8000/api/v1/docs) resp. [http://127.0.0.1:8000/api/v2/docs](http://127.0.0.1:8000/api/v2/docs)
+
+
+```shell
+
+When running the webservice API, goto http://127.0.0.1:8000/api/v1/docs
+
 The CLI provides extensive help:
 
 ```shell
 uvx oe-python-template --help                # all CLI commands
 uvx oe-python-template hello-world --help    # help for specific command
+uvx oe-python-template echo --help
+uvx oe-python-template openapi --help
+uvx oe-python-template serve --help
 ```
 
 
-## Highlights
+## Operational Excellence
+
+This project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:
 
-* Copier template to scaffold Python projects compliant with best practices and modern tooling.
-* Various Examples:
+* Various examples demonstrating usage:
   - [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](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py) notebook
@@ -103,6 +118,9 @@ uvx oe-python-template hello-world --help    # help for specific command
 
 ## Usage Examples
 
+The following examples run from source. Clone this repository first using
+`git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template.git`.
+
 ### Minimal Python Script:
 
 ```python
@@ -144,7 +162,7 @@ uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, o
 ... or run within VSCode
 
 ```shell
-uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+uv sync --all-extras                                # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml
 ```
 Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
 
@@ -241,7 +259,10 @@ 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
-curl http://127.0.0.1 8000
+curl http://127.0.0.1:8000/api/v1/hello-world
+curl http://127.0.0.1:8000/api/v1/docs
+curl http://127.0.0.1:8000/api/v2/hello-world
+curl http://127.0.0.1:8000/api/v2/docs
 ```
 
 ## Extra: Lorem Ipsum