{"id":25983867,"url":"https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example","last_synced_at":"2026-04-21T13:32:12.878Z","repository":{"id":280307185,"uuid":"941587326","full_name":"helmut-hoffer-von-ankershoffen/oe-python-template-example","owner":"helmut-hoffer-von-ankershoffen","description":"🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).","archived":false,"fork":false,"pushed_at":"2026-04-19T06:10:42.000Z","size":1224,"stargazers_count":1,"open_issues_count":19,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-19T08:21:27.260Z","etag":null,"topics":["oe-python-template"],"latest_commit_sha":null,"homepage":"https://oe-python-template-example.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/helmut-hoffer-von-ankershoffen.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-02T16:39:24.000Z","updated_at":"2025-04-27T16:56:27.000Z","dependencies_parsed_at":"2025-03-02T17:17:10.695Z","dependency_job_id":"3615a3b2-06e8-4957-a23b-c5d58fda08c8","html_url":"https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example","commit_stats":null,"previous_names":["helmut-hoffer-von-ankershoffen/oe-python-template-example"],"tags_count":77,"template":false,"template_full_name":null,"purl":"pkg:github/helmut-hoffer-von-ankershoffen/oe-python-template-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helmut-hoffer-von-ankershoffen%2Foe-python-template-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helmut-hoffer-von-ankershoffen%2Foe-python-template-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helmut-hoffer-von-ankershoffen%2Foe-python-template-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helmut-hoffer-von-ankershoffen%2Foe-python-template-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/helmut-hoffer-von-ankershoffen","download_url":"https://codeload.github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helmut-hoffer-von-ankershoffen%2Foe-python-template-example/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32094391,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-21T11:25:29.218Z","status":"ssl_error","status_checked_at":"2026-04-21T11:25:28.499Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["oe-python-template"],"created_at":"2025-03-05T10:33:29.567Z","updated_at":"2026-04-21T13:32:12.863Z","avatar_url":"https://github.com/helmut-hoffer-von-ankershoffen.png","language":"Python","readme":"\n[//]: # (README.md generated from docs/partials/README_*.md)\n\n# 🧠 OE Python Template Example\n\n[![License](https://img.shields.io/github/license/helmut-hoffer-von-ankershoffen/oe-python-template-example?logo=opensourceinitiative\u0026logoColor=3DA639\u0026labelColor=414042\u0026color=A41831)\n](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/LICENSE)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/oe-python-template-example.svg?logo=python\u0026color=204361\u0026labelColor=1E2933)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)\n[![CI](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/ci-cd.yml)\n[![Read the Docs](https://img.shields.io/readthedocs/oe-python-template-example)](https://oe-python-template-example.readthedocs.io/en/latest/)\n[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)\n[![Security](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example\u0026metric=security_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)\n[![Maintainability](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example\u0026metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)\n[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example\u0026metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)\n[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example\u0026metric=code_smells)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)\n[![CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions/workflows/codeql.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)\n[![Dependabot](https://img.shields.io/badge/dependabot-active-brightgreen?style=flat-square\u0026logo=dependabot)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot)\n[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/issues?q=is%3Aissue%20state%3Aopen%20Dependency%20Dashboard)\n[![Coverage](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example/graph/badge.svg?token=SX34YRP30E)](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example)\n[![Ruff](https://img.shields.io/badge/style-Ruff-blue?color=D6FF65)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)\n[![MyPy](https://img.shields.io/badge/mypy-checked-blue)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)\n[![GitHub - Version](https://img.shields.io/github/v/release/helmut-hoffer-von-ankershoffen/oe-python-template-example?label=GitHub\u0026style=flat\u0026labelColor=1C2C2E\u0026color=blue\u0026logo=GitHub\u0026logoColor=white)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases)\n[![GitHub - Commits](https://img.shields.io/github/commit-activity/m/helmut-hoffer-von-ankershoffen/oe-python-template-example/main?label=commits\u0026style=flat\u0026labelColor=1C2C2E\u0026color=blue\u0026logo=GitHub\u0026logoColor=white)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commits/main/)\n[![PyPI - Version](https://img.shields.io/pypi/v/oe-python-template-example.svg?label=PyPI\u0026logo=pypi\u0026logoColor=%23FFD243\u0026labelColor=%230073B7\u0026color=FDFDFD)](https://pypi.python.org/pypi/oe-python-template-example)\n[![PyPI - Status](https://img.shields.io/pypi/status/oe-python-template-example?logo=pypi\u0026logoColor=%23FFD243\u0026labelColor=%230073B7\u0026color=FDFDFD)](https://pypi.python.org/pypi/oe-python-template-example)\n[![Docker - Version](https://img.shields.io/docker/v/helmuthva/oe-python-template-example?sort=semver\u0026label=Docker\u0026logo=docker\u0026logoColor=white\u0026labelColor=1354D4\u0026color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/tags)\n[![Docker - Size](https://img.shields.io/docker/image-size/helmuthva/oe-python-template-example?sort=semver\u0026arch=arm64\u0026label=image\u0026logo=docker\u0026logoColor=white\u0026labelColor=1354D4\u0026color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/)\n[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)\n[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers\u0026message=Open\u0026color=blue\u0026logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTE3IDE2VjdsLTYgNU0yIDlWOGwxLTFoMWw0IDMgOC04aDFsNCAyIDEgMXYxNGwtMSAxLTQgMmgtMWwtOC04LTQgM0gzbC0xLTF2LTFsMy0zIi8+PC9zdmc+)](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[![Open in GitHub Codespaces](https://img.shields.io/static/v1?label=GitHub%20Codespaces\u0026message=Open\u0026color=blue\u0026logo=github)](https://github.com/codespaces/new/helmut-hoffer-von-ankershoffen/oe-python-template-example)\n[![Vercel Deploy](https://deploy-badge.vercel.app/vercel/oe-python-template-example?root=api%2Fv1%2Fhealthz)](https://oe-python-template-example.vercel.app/api/v1/hello/world)\n[![Better Stack Badge](https://uptime.betterstack.com/status-badges/v1/monitor/1vzoq.svg)](https://helmut-hoffer-von-ankershoffen.betteruptime.com/)\n\n\u003c!---\n[![ghcr.io - Version](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags?color=%2344cc11\u0026ignore=0.0%2C0%2Clatest\u0026n=3\u0026label=ghcr.io\u0026trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)\n[![ghcr.io - Sze](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/size?color=%2344cc11\u0026tag=latest\u0026label=size\u0026trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)\n--\u003e\n\n\u003e [!TIP]\n\u003e 📚 [Online documentation](https://oe-python-template-example.readthedocs.io/en/latest/) - 📖 [PDF Manual](https://oe-python-template-example.readthedocs.io/_/downloads/en/latest/pdf/)\n\n\u003e [!NOTE]\n\u003e 🧠 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\n## Overview\n\nAdding OE Python Template Example to your project as a dependency is easy. See\nbelow for usage examples.\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 hello echo \"Lorem Ipsum\"  # echos \"Lorem Ipsum\"\nuvx oe-python-template-example gui                       # opens the graphical user interface (GUI)\nuvx --with \"oe-python-template-example[examples]\" oe-python-template-example gui  # opens the graphical user interface (GUI) with support for scientific computing\nuvx oe-python-template-example system serve              # serves web API\nuvx oe-python-template-example system serve --port=4711  # serves web API on port 4711\nuvx oe-python-template-example system openapi            # serves web API on port 4711\n```\n\nNotes:\n\n1. The API is versioned, mounted at `/api/v1` resp. `/api/v2`\n2. While serving the web 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.\n3. 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 hello echo --help\nuvx oe-python-template-example gui --help\nuvx oe-python-template-example system serve --help\nuvx oe-python-template-example system openapi --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\n1. Various examples demonstrating usage: a.\n   [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py)\n   b.\n   [Streamlit web application](https://oe-python-template-example.streamlit.app/)\n   deployed on [Streamlit Community Cloud](https://streamlit.io/cloud) c.\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\n2. Complete reference documentation\n   [for the library](https://oe-python-template-example.readthedocs.io/en/latest/lib_reference.html),\n   [for the CLI](https://oe-python-template-example.readthedocs.io/en/latest/cli_reference.html)\n   and\n   [for the API](https://oe-python-template-example.readthedocs.io/en/latest/api_reference_v1.html)\n   on Read the Docs\n3. [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)\n4. 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/))\n5. Compliant with modern linting and formatting standards (powered by\n   [Ruff](https://github.com/astral-sh/ruff))\n6. Up-to-date dependencies (monitored by\n   [Renovate](https://github.com/renovatebot/renovate) and\n   [Dependabot](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/dependabot))\n7. [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)\n8. Additional code security checks using\n   [CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/security/code-scanning)\n9. [Security Policy](SECURITY.md)\n10. [License](LICENSE) compliant with the Open Source Initiative (OSI)\n11. 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)\n12. 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 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 rich.console import Console\n\nfrom oe_python_template_example.hello import Service\n\nconsole = Console()\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/lib_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### Vercel Serverless Function\n\nServe the API as a\n[serverless function on Vercel](https://oe-python-template-example.vercel.app/)\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) \u003e \"Start in marimo editor\" (edit).\n\n... or without prior cloning of the repository\n\n```shell\nuvx marimo run https://raw.githubusercontent.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/refs/heads/main/examples/notebook.py\n```\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 hello echo --help\nuvx oe-python-template-example hello echo \"Lorem\"\nuvx oe-python-template-example hello echo \"Lorem\" --json\nuvx oe-python-template-example gui\nuvx --with \"oe-python-template-example[examples]\" oe-python-template-example gui  # opens the graphical user interface (GUI) with support for scientific computing\nuvx oe-python-template-example system info\nuvx oe-python-template-example system health\nuvx oe-python-template-example system openapi\nuvx oe-python-template-example system openapi --output-format=json\nuvx oe-python-template-example system serve\n```\n\nSee the\n[reference documentation of the CLI](https://oe-python-template-example.readthedocs.io/en/latest/cli_reference.html)\nfor detailed documentation of all CLI commands and options.\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\" \u003e .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 hello echo --help\ndocker run helmuthva/oe-python-template-example hello echo \"Lorem\"\ndocker run helmuthva/oe-python-template-example hello echo \"Lorem\" --json\ndocker run helmuthva/oe-python-template-example system info\ndocker run helmuthva/oe-python-template-example system health\ndocker run helmuthva/oe-python-template-example system openapi\ndocker run helmuthva/oe-python-template-example system openapi --output-format=json\ndocker run helmuthva/oe-python-template-example system serve\n```\n\nThe default Docker image includes all extras. Additionally a slim image is\nprovided, with no extras. Run as follows\n\n```shell\ndocker run helmuthva/oe-python-template-example-slim --help\ndocker run helmuthva/oe-python-template-example-slim hello world\n```\n\nYou can pass environment variables as parameters:\n\n```shell\ndocker run --env OE_PYTHON_TEMPLATE_EXAMPLE_HELLO_LANGUAGE=de_DE helmuthva/oe-python-template-example hello world\ndocker run --env OE_PYTHON_TEMPLATE_EXAMPLE_HELLO_LANGUAGE=en_US helmuthva/oe-python-template-example hello world\n```\n\nA docker compose stack is provided. Clone this repository using\n`git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template-example.git`\nand enter the repository folder.\n\nThe .env is passed through from the host to the Docker container.\n\n```shell\ndocker compose run --remove-orphans oe-python-template-example --help\ndocker compose run --remove-orphans oe-python-template-example hello world\ndocker compose run --remove-orphans oe-python-template-example hello echo --help\ndocker compose run --remove-orphans oe-python-template-example hello echo \"Lorem\"\ndocker compose run --remove-orphans oe-python-template-example hello echo \"Lorem\" --json\ndocker compose run --remove-orphans oe-python-template-example system info\ndocker compose run --remove-orphans oe-python-template-example system health\ndocker compose run --remove-orphans oe-python-template-example system openapi\ndocker compose run --remove-orphans oe-python-template-example system openapi --output-format=json\necho \"Running OE Python Template Example's API container as a daemon ...\"\ndocker compose up -d\necho \"Waiting for the API server to start ...\"\nsleep 5\necho \"Checking health of v1 API ...\"\ncurl http://127.0.0.1:8000/api/v1/healthz\necho \"\"\necho \"Saying hello world with v1 API ...\"\ncurl http://127.0.0.1:8000/api/v1/hello/world\necho \"\"\necho \"Swagger docs of v1 API ...\"\ncurl http://127.0.0.1:8000/api/v1/docs\necho \"\"\necho \"Checking health of v2 API ...\"\ncurl http://127.0.0.1:8000/api/v2/healthz\necho \"\"\necho \"Saying hello world with v1 API ...\"\ncurl http://127.0.0.1:8000/api/v2/hello/world\necho \"\"\necho \"Swagger docs of v2 API ...\"\ncurl http://127.0.0.1:8000/api/v2/docs\necho \"\"\necho \"Shutting down the API container ...\"\ndocker compose down\n```\n\n- See the\n  [reference documentation of the API](https://oe-python-template-example.readthedocs.io/en/latest/api_reference_v1.html)\n  for detailed documentation of all API operations and parameters.\n\n## Extra: Lorem Ipsum\n\nNothing yet\n\n\n## Further Reading\n\n* Inspect our [security policy](https://oe-python-template-example.readthedocs.io/en/latest/security.html) with detailed documentation of checks, tools and principles.\n* Check out the [CLI reference](https://oe-python-template-example.readthedocs.io/en/latest/cli_reference.html) with detailed documentation of all CLI commands and options.\n* Check out the [library reference](https://oe-python-template-example.readthedocs.io/en/latest/lib_reference.html) with detailed documentation of public classes and functions.\n* Check out the [API reference](https://oe-python-template-example.readthedocs.io/en/latest/api_reference_v1.html) with detailed documentation of all API operations and parameters.\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 🧠 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* We gratefully acknowledge the [open source projects](https://oe-python-template-example.readthedocs.io/en/latest/attributions.html) that this project builds upon. Thank you to all these wonderful contributors!\n\n## Star History\n\n\u003ca href=\"https://star-history.com/#helmut-hoffer-von-ankershoffen/oe-python-template-example\"\u003e\n \u003cpicture\u003e\n   \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template-example\u0026type=Date\u0026theme=dark\" /\u003e\n   \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template-example\u0026type=Date\" /\u003e\n   \u003cimg alt=\"Star History Chart\" src=\"https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template-example\u0026type=Date\" /\u003e\n \u003c/picture\u003e\n\u003c/a\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelmut-hoffer-von-ankershoffen%2Foe-python-template-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhelmut-hoffer-von-ankershoffen%2Foe-python-template-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelmut-hoffer-von-ankershoffen%2Foe-python-template-example/lists"}