| Name | oe-python-template-example JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | 🧠Example project scaffolded and kept up to date with OE Python Template (oe-python-template). |
| upload_time | 2025-03-16 21:37:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.11 |
| license | MIT License Copyright (c) [2025] [Helmut Hoffer von Ankershoffen (helmuthva@gmail.com)] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
act
codecov
copier
cyclonedx
detect-secrets
devcontainer
docker
git-cliff
jupyter
marimo
mypy
nox
oe-python-template
oe-python-template-example
pip-audit
pip-licenses
pre-commit
pydantic
pypi
pytest
python
readthedocs
ruff
sonarcloud
sonarqube
sphinx
streamlit
typer
uv
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[//]: # (README.md generated from docs/partials/README_*.md)
# 🧠OE Python Template Example
[
](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/LICENSE)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/test-and-report.yml)
[](https://oe-python-template-example.readthedocs.io/en/latest/)
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot)
[](https://renovatebot.com/)
[](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commits/main/)
[](https://pypi.python.org/pypi/oe-python-template-example)
[](https://pypi.python.org/pypi/oe-python-template-example)
[](https://hub.docker.com/r/helmuthva/oe-python-template-example/tags)
[](https://hub.docker.com/r/helmuthva/oe-python-template-example/)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example)
[](https://github.com/codespaces/new/helmut-hoffer-von-ankershoffen/oe-python-template-example)
<!---
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)
-->
> [!TIP]
> 📚 [Online documentation](https://oe-python-template-example.readthedocs.io/en/latest/) - 📖 [PDF Manual](https://oe-python-template-example.readthedocs.io/_/downloads/en/latest/pdf/)
> [!NOTE]
> 🧠This project was scaffolded using the template [oe-python-template](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template) with [copier](https://copier.readthedocs.io/).
---
Example project scaffolded and kept up to date with OE Python Template
(oe-python-template).
Use Cases:
1. Dummy CLI application and service demonstrating example usage of the
directory structure and build pipeline generated by oe-python-template
## Overview
Adding OE Python Template Example to your project as a dependency is easy.
```shell
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:
```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:
```shell
uvx oe-python-template-example hello-world # prints "Hello, world! [..]"
uvx oe-python-template-example serve # serves webservice API
uvx oe-python-template-example serve --port=4711 # serves webservice API on port 4711
```
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 CLI provides extensive help:
```shell
uvx oe-python-template-example --help # all CLI commands
uvx oe-python-template-example hello-world --help # help for specific command
uvx oe-python-template-example echo --help
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:
- 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)
## 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-example.git`.
### Minimal Python Script:
```python
"""Example script demonstrating the usage of the service provided by OE Python Template Example."""
from dotenv import load_dotenv
from rich.console import Console
from oe_python_template_example import Service
console = Console()
load_dotenv()
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)
### Streamlit App
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)
... 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
```
## Notebooks
### Jupyter
[Show the Jupyter code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.ipynb)
... or run within VSCode
```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)
Click on `examples/notebook.ipynb` in VSCode and run it.
### Marimo
[Show the marimo code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.py)
Execute the notebook as a WASM based web app
```shell
uv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml
uv run marimo run examples/notebook.py --watch # Serve on localhost:2718, opens browser
```
or edit interactively in your browser
```shell
uv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml
uv run marimo edit examples/notebook.py --watch # Edit on localhost:2718, opens browser
```
... or edit interactively within VSCode
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).
## Command Line Interface (CLI)
### Run with [uvx](https://docs.astral.sh/uv/guides/tools/)
Show available commands:
```shell
uvx oe-python-template-example --help
```
Execute commands:
```shell
uvx oe-python-template-example hello-world
uvx oe-python-template-example echo --help
uvx oe-python-template-example echo "Lorem"
uvx oe-python-template-example echo "Lorem" --json
uvx oe-python-template-example openapi
uvx oe-python-template-example openapi --output-format=json
uvx oe-python-template-example serve
```
### Environment
The service loads environment variables including support for .env files.
```shell
cp .env.example .env # copy example file
echo "THE_VAR=MY_VALUE" > .env # overwrite with your values
```
Now run the usage examples again.
### Run with Docker
You can as well run the CLI within Docker.
```shell
docker run helmuthva/oe-python-template-example --help
docker run helmuthva/oe-python-template-example hello-world
docker run helmuthva/oe-python-template-example echo --help
docker run helmuthva/oe-python-template-example echo "Lorem"
docker run helmuthva/oe-python-template-example echo "Lorem" --json
docker run helmuthva/oe-python-template-example openapi
docker run helmuthva/oe-python-template-example openapi --output-format=json
docker run helmuthva/oe-python-template-example serve
```
Execute command:
```shell
docker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template-example echo "Lorem Ipsum"
```
Or use docker compose
The .env is passed through from the host to the Docker container.
```shell
docker compose run oe-python-template-example --help
docker compose run oe-python-template-example hello-world
docker compose run oe-python-template-example echo --help
docker compose run oe-python-template-example echo "Lorem"
docker compose run oe-python-template-example echo "Lorem" --json
docker compose run oe-python-template-example openapi
docker compose run oe-python-template-example openapi --output-format=json
docker compose up
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
Nothing yet
## Further Reading
* Check out the [reference](https://oe-python-template-example.readthedocs.io/en/latest/reference.html) with detailed documentation of public classes and functions.
* Our [release notes](https://oe-python-template-example.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.
* In case you want to help us improve 🧠OE Python Template Example: The [contribution guidelines](https://oe-python-template-example.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.
## Star History
<a href="https://star-history.com/#helmut-hoffer-von-ankershoffen/oe-python-template-example">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template-example&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template-example&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template-example&type=Date" />
</picture>
</a>
Raw data
{
"_id": null,
"home_page": null,
"name": "oe-python-template-example",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "act, codecov, copier, cyclonedx, detect-secrets, devcontainer, docker, git-cliff, jupyter, marimo, mypy, nox, oe-python-template, oe-python-template-example, pip-audit, pip-licenses, pre-commit, pydantic, pypi, pytest, python, readthedocs, ruff, sonarcloud, sonarqube, sphinx, streamlit, typer, uv",
"author": null,
"author_email": "Helmut Hoffer von Ankershoffen <helmuthva@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/7c/d7/332fc4ac7d7bdbb9c9a5929891d8a6bb7132f553098849fb9842c995a0d0/oe_python_template_example-0.2.0.tar.gz",
"platform": null,
"description": "\n[//]: # (README.md generated from docs/partials/README_*.md)\n\n# \ud83e\udde0 OE Python Template Example\n\n[\n](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/LICENSE)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/test-and-report.yml)\n[](https://oe-python-template-example.readthedocs.io/en/latest/)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot)\n[](https://renovatebot.com/)\n[](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commits/main/)\n[](https://pypi.python.org/pypi/oe-python-template-example)\n[](https://pypi.python.org/pypi/oe-python-template-example)\n[](https://hub.docker.com/r/helmuthva/oe-python-template-example/tags)\n[](https://hub.docker.com/r/helmuthva/oe-python-template-example/)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)\n[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example)\n[](https://github.com/codespaces/new/helmut-hoffer-von-ankershoffen/oe-python-template-example)\n\n<!---\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)\n-->\n\n> [!TIP]\n> \ud83d\udcda [Online documentation](https://oe-python-template-example.readthedocs.io/en/latest/) - \ud83d\udcd6 [PDF Manual](https://oe-python-template-example.readthedocs.io/_/downloads/en/latest/pdf/)\n\n> [!NOTE]\n> \ud83e\udde0 This project was scaffolded using the template [oe-python-template](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template) with [copier](https://copier.readthedocs.io/).\n\n---\n\n\nExample project scaffolded and kept up to date with OE Python Template\n(oe-python-template).\n\nUse Cases:\n\n1. Dummy CLI application and service demonstrating example usage of the\n directory structure and build pipeline generated by oe-python-template\n\n## Overview\n\nAdding OE Python Template Example to your project as a dependency is easy.\n\n```shell\nuv add oe-python-template-example # add dependency to your project\n```\n\nIf you don't have uv installed follow\n[these instructions](https://docs.astral.sh/uv/getting-started/installation/).\nIf you still prefer pip over the modern and fast package manager\n[uv](https://github.com/astral-sh/uv), you can install the library like this:\n\n```shell\npip install oe-python-template-example # add dependency to your project\n```\n\nExecuting the command line interface (CLI) in an isolated Python environment is\njust as easy:\n\n```shell\nuvx oe-python-template-example hello-world # prints \"Hello, world! [..]\"\nuvx oe-python-template-example serve # serves webservice API\nuvx oe-python-template-example serve --port=4711 # serves webservice API on port 4711\n```\n\nNotes:\n\n- The API is versioned, mounted at `/api/v1` resp. `/api/v2`\n- While serving the webservice API go to\n [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world)\n to see the respons of the `hello-world` operation.\n- Interactive documentation is provided at\n [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)\n\nThe CLI provides extensive help:\n\n```shell\nuvx oe-python-template-example --help # all CLI commands\nuvx oe-python-template-example hello-world --help # help for specific command\nuvx oe-python-template-example echo --help\nuvx oe-python-template-example openapi --help\nuvx oe-python-template-example serve --help\n```\n\n## Operational Excellence\n\nThis project is designed with operational excellence in mind, using modern\nPython tooling and practices. It includes:\n\n- Various examples demonstrating usage:\n - [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py)\n - [Streamlit web application](https://oe-python-template-example.streamlit.app/)\n deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)\n - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.ipynb)\n and\n [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.py)\n notebook\n- [Complete reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html)\n on Read the Docs\n- [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example)\n including unit and E2E tests (reported on Codecov)\n- Matrix tested with\n [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)\n to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))\n- Compliant with modern linting and formatting standards (powered by\n [Ruff](https://github.com/astral-sh/ruff))\n- Up-to-date dependencies (monitored by\n [Renovate](https://github.com/renovatebot/renovate) and\n [GitHub Dependabot](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot))\n- [A-grade code quality](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)\n in security, maintainability, and reliability with low technical debt and\n codesmell (verified by SonarQube)\n- Additional code security checks using\n [GitHub CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)\n- [Security Policy](SECURITY.md)\n- [License](LICENSE) compliant with the Open Source Initiative (OSI)\n- 1-liner for installation and execution of command line interface (CLI) via\n [uv(x)](https://github.com/astral-sh/uv) or\n [Docker](https://hub.docker.com/r/helmuthva/oe-python-template-example/tags)\n- Setup for developing inside a\n [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers)\n included (supports VSCode and GitHub Codespaces)\n\n## Usage Examples\n\nThe following examples run from source. Clone this repository first using\n`git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template-example.git`.\n\n### Minimal Python Script:\n\n```python\n\"\"\"Example script demonstrating the usage of the service provided by OE Python Template Example.\"\"\"\n\nfrom dotenv import load_dotenv\nfrom rich.console import Console\n\nfrom oe_python_template_example import Service\n\nconsole = Console()\n\nload_dotenv()\n\nmessage = Service.get_hello_world()\nconsole.print(f\"[blue]{message}[/blue]\")\n```\n\n[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py) -\n[Read the reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html)\n\n### Streamlit App\n\nServe the functionality provided by OE Python Template Example in the web by\neasily integrating the service into a Streamlit application.\n\n[Try it out!](https://oe-python-template-example.streamlit.app) -\n[Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/streamlit.py)\n\n... or serve the app locally\n\n```shell\nuv sync --all-extras # Install streamlit dependency part of the examples extra, see pyproject.toml\nuv run streamlit run examples/streamlit.py # Serve on localhost:8501, opens browser\n```\n\n## Notebooks\n\n### Jupyter\n\n[Show the Jupyter code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.ipynb)\n\n... or run within VSCode\n\n```shell\nuv sync --all-extras # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml\n```\n\nInstall the\n[Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)\n\nClick on `examples/notebook.ipynb` in VSCode and run it.\n\n### Marimo\n\n[Show the marimo code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.py)\n\nExecute the notebook as a WASM based web app\n\n```shell\nuv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml\nuv run marimo run examples/notebook.py --watch # Serve on localhost:2718, opens browser\n```\n\nor edit interactively in your browser\n\n```shell\nuv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml\nuv run marimo edit examples/notebook.py --watch # Edit on localhost:2718, opens browser\n```\n\n... or edit interactively within VSCode\n\nInstall the\n[Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)\n\nClick on `examples/notebook.py` in VSCode and click on the caret next to the Run\nicon above the code (looks like a pencil) > \"Start in marimo editor\" (edit).\n\n## Command Line Interface (CLI)\n\n### Run with [uvx](https://docs.astral.sh/uv/guides/tools/)\n\nShow available commands:\n\n```shell\nuvx oe-python-template-example --help\n```\n\nExecute commands:\n\n```shell\nuvx oe-python-template-example hello-world\nuvx oe-python-template-example echo --help\nuvx oe-python-template-example echo \"Lorem\"\nuvx oe-python-template-example echo \"Lorem\" --json\nuvx oe-python-template-example openapi\nuvx oe-python-template-example openapi --output-format=json\nuvx oe-python-template-example serve\n```\n\n### Environment\n\nThe service loads environment variables including support for .env files.\n\n```shell\ncp .env.example .env # copy example file\necho \"THE_VAR=MY_VALUE\" > .env # overwrite with your values\n```\n\nNow run the usage examples again.\n\n### Run with Docker\n\nYou can as well run the CLI within Docker.\n\n```shell\ndocker run helmuthva/oe-python-template-example --help\ndocker run helmuthva/oe-python-template-example hello-world\ndocker run helmuthva/oe-python-template-example echo --help\ndocker run helmuthva/oe-python-template-example echo \"Lorem\"\ndocker run helmuthva/oe-python-template-example echo \"Lorem\" --json\ndocker run helmuthva/oe-python-template-example openapi\ndocker run helmuthva/oe-python-template-example openapi --output-format=json\ndocker run helmuthva/oe-python-template-example serve\n```\n\nExecute command:\n\n```shell\ndocker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template-example echo \"Lorem Ipsum\"\n```\n\nOr use docker compose\n\nThe .env is passed through from the host to the Docker container.\n\n```shell\ndocker compose run oe-python-template-example --help\ndocker compose run oe-python-template-example hello-world\ndocker compose run oe-python-template-example echo --help\ndocker compose run oe-python-template-example echo \"Lorem\"\ndocker compose run oe-python-template-example echo \"Lorem\" --json\ndocker compose run oe-python-template-example openapi\ndocker compose run oe-python-template-example openapi --output-format=json\ndocker compose up\ncurl http://127.0.0.1:8000/api/v1/hello-world\ncurl http://127.0.0.1:8000/api/v1/docs\ncurl http://127.0.0.1:8000/api/v2/hello-world\ncurl http://127.0.0.1:8000/api/v2/docs\n```\n\n## Extra: Lorem Ipsum\n\nNothing yet\n\n\n## Further Reading\n\n* Check out the [reference](https://oe-python-template-example.readthedocs.io/en/latest/reference.html) with detailed documentation of public classes and functions.\n* Our [release notes](https://oe-python-template-example.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.\n* In case you want to help us improve \ud83e\udde0 OE Python Template Example: The [contribution guidelines](https://oe-python-template-example.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.\n\n## Star History\n\n<a href=\"https://star-history.com/#helmut-hoffer-von-ankershoffen/oe-python-template-example\">\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template-example&type=Date&theme=dark\" />\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template-example&type=Date\" />\n <img alt=\"Star History Chart\" src=\"https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template-example&type=Date\" />\n </picture>\n</a>\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) [2025] [Helmut Hoffer von Ankershoffen (helmuthva@gmail.com)] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "\ud83e\udde0 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).",
"version": "0.2.0",
"project_urls": {
"Changelog": "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases",
"Documentation": "https://oe-python-template-example.readthedocs.io/en/latest/",
"Homepage": "https://oe-python-template-example.readthedocs.io/en/latest/",
"Issues": "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/issues",
"Source": "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example"
},
"split_keywords": [
"act",
" codecov",
" copier",
" cyclonedx",
" detect-secrets",
" devcontainer",
" docker",
" git-cliff",
" jupyter",
" marimo",
" mypy",
" nox",
" oe-python-template",
" oe-python-template-example",
" pip-audit",
" pip-licenses",
" pre-commit",
" pydantic",
" pypi",
" pytest",
" python",
" readthedocs",
" ruff",
" sonarcloud",
" sonarqube",
" sphinx",
" streamlit",
" typer",
" uv"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "affd6b87929a559edb9a453a56ec138be2dc82cc2b4e0224c8a17e8b41456487",
"md5": "f2fffd857d5288594e101b2320b2cf5f",
"sha256": "5b5d81b866670de329ea06a3f4e28976d76a03cc100e53e9b5ee0018ada1d9eb"
},
"downloads": -1,
"filename": "oe_python_template_example-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f2fffd857d5288594e101b2320b2cf5f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 12620,
"upload_time": "2025-03-16T21:37:03",
"upload_time_iso_8601": "2025-03-16T21:37:03.103550Z",
"url": "https://files.pythonhosted.org/packages/af/fd/6b87929a559edb9a453a56ec138be2dc82cc2b4e0224c8a17e8b41456487/oe_python_template_example-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7cd7332fc4ac7d7bdbb9c9a5929891d8a6bb7132f553098849fb9842c995a0d0",
"md5": "21aa836d0d9bec526b5406c96c89563f",
"sha256": "aa8a7a20bbb78219d0a37439e70fac7dec4a392d627a985096b79fbc1bdea9f4"
},
"downloads": -1,
"filename": "oe_python_template_example-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "21aa836d0d9bec526b5406c96c89563f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 13734450,
"upload_time": "2025-03-16T21:37:05",
"upload_time_iso_8601": "2025-03-16T21:37:05.634727Z",
"url": "https://files.pythonhosted.org/packages/7c/d7/332fc4ac7d7bdbb9c9a5929891d8a6bb7132f553098849fb9842c995a0d0/oe_python_template_example-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-16 21:37:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "helmut-hoffer-von-ankershoffen",
"github_project": "oe-python-template-example",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "oe-python-template-example"
}
