oe-python-template-example 0.1.12__py3-none-any.whl → 0.1.13__py3-none-any.whl

{oe_python_template_example-0.1.12.dist-info → oe_python_template_example-0.1.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.1.12
+Version: 0.1.13
 Summary: 🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 Project-URL: Homepage, https://oe-python-template-example.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template-example.readthedocs.io/en/latest/
@@ -100,64 +100,13 @@ Description-Content-Type: text/markdown
 ---
 
 
-Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
+Example project scaffolded and kept up to date with OE Python Template
+(oe-python-template).
 
 Use Cases:
-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
-
-**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 repository on GitHubm, clone to your local machine, and change into it's 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_dev
-```
-
-**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](SERVICE_CONNECTIONS.md) 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
-```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.
+1. Dummy CLI application and service demonstrating example usage of the
+   directory structure and build pipeline generated by oe-python-template
 
 ## Overview
 
@@ -167,13 +116,17 @@ Adding OE Python Template Example to your project as a dependency is easy.
 uv add oe-python-template-example             # add dependency to your project
 ```
 
-If you don't have uv installed follow [these instructions](https://docs.astral.sh/uv/getting-started/installation/). If you still prefer pip over the modern and fast package manager [uv](https://github.com/astral-sh/uv), you can install the library like this:
+If you don't have uv installed follow
+[these instructions](https://docs.astral.sh/uv/getting-started/installation/).
+If you still prefer pip over the modern and fast package manager
+[uv](https://github.com/astral-sh/uv), you can install the library like this:
 
 ```shell
 pip install oe-python-template-example        # add dependency to your project
 ```
 
-Executing the command line interface (CLI) in an isolated Python environment is just as easy:
+Executing the command line interface (CLI) in an isolated Python environment is
+just as easy:
 
 ```shell
 uvx oe-python-template-example hello-world     # prints "Hello, world! [..]"
@@ -182,10 +135,13 @@ uvx oe-python-template-example serve --port=4711 # serves webservice API on port
 ```
 
 Notes:
-* The API is versioned, mounted at ```/api/v1``` resp. ```/api/v2```
-* While serving the webservice 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 respons of the ```hello-world``` operation.
-* Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
 
+- The API is versioned, mounted at `/api/v1` resp. `/api/v2`
+- While serving the webservice 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 respons of the `hello-world` operation.
+- Interactive documentation is provided at
+  [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
 
 The CLI provides extensive help:
 
@@ -197,27 +153,44 @@ uvx oe-python-template-example openapi --help
 uvx oe-python-template-example serve --help
 ```
 
-
 ## Operational Excellence
 
-This project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:
+This project is designed with operational excellence in mind, using modern
+Python tooling and practices. It includes:
 
-* Various examples demonstrating usage:
+- Various examples demonstrating usage:
   - [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py)
-  - [Streamlit web application](https://oe-python-template-example.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
-  - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.py) notebook
-* [Complete reference documentation](https://oe-python-template-example.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-example) including unit and E2E tests (reported on Codecov)
-* Matrix tested with [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
-* Compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))
-* Up-to-date dependencies (monitored by [Renovate](https://github.com/renovatebot/renovate) and [GitHub Dependabot](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot))
-* [A-grade code quality](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example) in security, maintainability, and reliability with low technical debt and codesmell (verified by SonarQube)
-* Additional code security checks using [GitHub CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)
-* [Security Policy](SECURITY.md)
-* [License](LICENSE) compliant with the Open Source Initiative (OSI)
-* 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-example/tags)
-* Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
-
+  - [Streamlit web application](https://oe-python-template-example.streamlit.app/)
+    deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
+  - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.ipynb)
+    and
+    [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.py)
+    notebook
+- [Complete reference documentation](https://oe-python-template-example.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-example)
+  including unit and E2E tests (reported on Codecov)
+- Matrix tested with
+  [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
+  to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
+- Compliant with modern linting and formatting standards (powered by
+  [Ruff](https://github.com/astral-sh/ruff))
+- Up-to-date dependencies (monitored by
+  [Renovate](https://github.com/renovatebot/renovate) and
+  [GitHub Dependabot](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot))
+- [A-grade code quality](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
+  in security, maintainability, and reliability with low technical debt and
+  codesmell (verified by SonarQube)
+- Additional code security checks using
+  [GitHub CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)
+- [Security Policy](SECURITY.md)
+- [License](LICENSE) compliant with the Open Source Initiative (OSI)
+- 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-example/tags)
+- Setup for developing inside a
+  [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers)
+  included (supports VSCode and GitHub Codespaces)
 
 ## Usage Examples
 
@@ -242,15 +215,19 @@ message = Service.get_hello_world()
 console.print(f"[blue]{message}[/blue]")
 ```
 
-[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py) - [Read the reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html)
+[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py) -
+[Read the reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html)
 
 ### Streamlit App
 
-Serve the functionality provided by OE Python Template Example in the web by easily integrating the service into a Streamlit application.
+Serve the functionality provided by OE Python Template Example in the web by
+easily integrating the service into a Streamlit application.
 
-[Try it out!](https://oe-python-template-example.streamlit.app) - [Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/streamlit.py)
+[Try it out!](https://oe-python-template-example.streamlit.app) -
+[Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/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
@@ -267,7 +244,9 @@ uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, o
 ```shell
 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)
+
+Install the
+[Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
 
 Click on `examples/notebook.ipynb` in VSCode and run it.
 
@@ -291,9 +270,11 @@ uv run marimo edit examples/notebook.py --watch     # Edit on localhost:2718, op
 
 ... or edit interactively within VSCode
 
-Install the [Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
+Install the
+[Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
 
-Click on `examples/notebook.py` in VSCode and click on the caret next to the Run icon above the code (looks like a pencil) > "Start in marimo editor" (edit).
+Click on `examples/notebook.py` in VSCode and click on the caret next to the Run
+icon above the code (looks like a pencil) > "Start in marimo editor" (edit).
 
 ## Command Line Interface (CLI)
 
@@ -370,7 +351,7 @@ curl http://127.0.0.1:8000/api/v2/docs
 
 ## Extra: Lorem Ipsum
 
-Dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam.
+Nothing yet
 
 
 ## Further Reading

{oe_python_template_example-0.1.12.dist-info → oe_python_template_example-0.1.13.dist-info}/RECORD

@@ -3,8 +3,8 @@ oe_python_template_example/api.py,sha256=vN2a10Ph4pffsXBx9TpFe0g39lZOE-5dJat2VhM
 oe_python_template_example/cli.py,sha256=BHuDCrzYkvJYDdvk06KwkK_sKQx7h7hhRiO0peQMM1s,3474
 oe_python_template_example/constants.py,sha256=6uQHr2CRgzWQWhUQCRRKiPuFhzKB2iblZk3dIRQ5dDc,358
 oe_python_template_example/service.py,sha256=XlCrklSRy8_YaYvlVYiDFPUubHHm-J8BPx2f7_niGG4,760
-oe_python_template_example-0.1.12.dist-info/METADATA,sha256=AkqqKcHiHLTNI84mbQORnywMJa6Pq6XauTe8_YYU09w,22969
-oe_python_template_example-0.1.12.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oe_python_template_example-0.1.12.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
-oe_python_template_example-0.1.12.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
-oe_python_template_example-0.1.12.dist-info/RECORD,,
+oe_python_template_example-0.1.13.dist-info/METADATA,sha256=ibFW6Vj6SaUabnFFqK_Y9eT6lz37Nrgj13hEr3mPvj8,20898
+oe_python_template_example-0.1.13.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oe_python_template_example-0.1.13.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
+oe_python_template_example-0.1.13.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
+oe_python_template_example-0.1.13.dist-info/RECORD,,