oe-python-template 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

oe_python_template/__init__.py

@@ -5,12 +5,11 @@ from .constants import (
     __project_path__,
     __version__,
 )
-
 from .service import Service
 
 __all__ = [
+    "Service",
     "__project_name__",
     "__project_path__",
     "__version__",
-    "Service",
 ]

oe_python_template/cli.py

@@ -5,7 +5,7 @@ from typing import Annotated
 import typer
 from rich.console import Console
 
-from oe_python_template import __version__, Service
+from oe_python_template import Service, __version__
 
 console = Console()
 

{oe_python_template-0.0.1.dist-info → oe_python_template-0.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.0.1
+Version: 0.0.2
 Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 Project-URL: Homepage, https://oe-python-template.readthedocs.io/
 Project-URL: Documentation, https://oe-python-template.readthedocs.io/
@@ -126,9 +126,9 @@ uvx oe-python-template command --help      # all options for command
 
 * Copier template to scaffold Python projects compliant with best practices and modern tooling.
 * Various Examples:
+  - [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 notebook](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/jupyter.ipynb)
-  - [Simple Python script]https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
 * [Complete reference documenation](https://oe-python-template.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) including unit and E2E tests (reported on Codecov)
 * Matrix tested with [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
@@ -140,28 +140,51 @@ uvx oe-python-template command --help      # all options for command
 
 ## Usage Examples
 
-### Streamlit App
+### Minimal Python Script:
 
-[Try it out!](https://oe-python-template.streamlit.app) - [Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/streamlit.py)
+```python
+"""Example script demonstrating the usage of the service provided by OE Python Template."""
 
+from dotenv import load_dotenv
+from rich.console import Console
 
-### Minimal Python Script:
+from oe_python_template import Service
 
-```python
-"""
-Example script demonstrating the usage of OE Python Template.
+console = Console()
 
-"""
+load_dotenv()
 
-print("Hello World")
+message = Service.get_hello_world()
+console.print(f"[blue]{message}[/blue]")
 ```
 
 [Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py) - [Read the reference documentation](https://oe-python-template.readthedocs.io/en/latest/reference.html)
 
+### Streamlit App
+
+Serve the functionality provided by OE Python Template in the web by easily integrating the service into a Streamlit application.
+
+[Try it out!](https://oe-python-template.streamlit.app) - [Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/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
+```
+
 ## Jupyter Notebook
 
 [Show notebook code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/jupyter.ipynb)
 
+... or run within VSCode
+
+```shell
+uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+```
+Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
+
+Click on `examples/jupyter.ipynb` in VSCode and run it.
+
 ## Command Line Interface (CLI)
 
 ### Run with [uvx](https://docs.astral.sh/uv/guides/tools/)
@@ -172,33 +195,47 @@ Show available commands:
 uvx oe-python-template --help
 ```
 
-Execute command:
+Execute commands:
 
 ```shell
-uvx oe-python-template command "Lorem Ipsum"
+uvx oe-python-template hello-world
+uvx oe-python-template hello-world --json
+uvx oe-python-template echo "Lorem Ipsum"
 ```
 
-### Run with Docker
+### Environment
 
-Note: Replace ENV_KEY_TEST with Lorem Ipsum.
+The service loads environment variables including support for .env files.
 
-Show available commands:
+```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
 
-```bash
+You can as well run the CLI within Docker.
+
+```shell
 docker run helmuthva/oe-python-template --help
+docker run helmuthva/oe-python-template hello-world
+docker run helmuthva/oe-python-template hello-world --json
+docker run helmuthva/oe-python-template echo "Lorem"
 ```
 
 Execute command:
 
-```bash
-docker run --env ENV_KEY_TEST=ENV_VALUE_TEST helmuthva/oe-python-template command "Lorem Ipsum"
+```shell
+docker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template echo "Lorem Ipsum"
 ```
 
 Or use docker compose
 
-File .env is passed through
+The .env is passed through from the host to the Docker container.
 
-```bash
+```shell
 docker compose up
 docker compose run oe-python-template --help
 ```

oe_python_template-0.0.2.dist-info/RECORD

@@ -0,0 +1,9 @@
+oe_python_template/__init__.py,sha256=XJAycUgDI2K8T0jVcXbaGfx2UAQJZbYcvJ_SYSqFyDA,315
+oe_python_template/cli.py,sha256=5tUw70ffHL-ot0rM7g6BmsVhn9IKBQXwbWU0-n9-wb4,1319
+oe_python_template/constants.py,sha256=Z1c06l5DeRuFxYVLHihHHTYvr8_Qh0nyzVKOe5X3ZNs,350
+oe_python_template/service.py,sha256=p59ch0g81LpsRvL-m-vLPuk0Rf6EYsZfZJ_OCA9vWzQ,500
+oe_python_template-0.0.2.dist-info/METADATA,sha256=5Coe2O9VH0L_GN44MtKYmvZzZYFJnbprumHMbxk0hKg,14814
+oe_python_template-0.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oe_python_template-0.0.2.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
+oe_python_template-0.0.2.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
+oe_python_template-0.0.2.dist-info/RECORD,,

oe_python_template-0.0.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-oe_python_template/__init__.py,sha256=Fnde1pSaMfYkaxltxJhP0d4G5o314EmKJThX08th754,316
-oe_python_template/cli.py,sha256=JE64lWrsnUEZFLSIuehjDAScTJkBEKlqubaXjlJJcWU,1319
-oe_python_template/constants.py,sha256=Z1c06l5DeRuFxYVLHihHHTYvr8_Qh0nyzVKOe5X3ZNs,350
-oe_python_template/service.py,sha256=p59ch0g81LpsRvL-m-vLPuk0Rf6EYsZfZJ_OCA9vWzQ,500
-oe_python_template-0.0.1.dist-info/METADATA,sha256=wp6J-oZzcSAkI-drBmoA4Dmr3Qs_PPIgJxpHqZi2bW8,13362
-oe_python_template-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oe_python_template-0.0.1.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
-oe_python_template-0.0.1.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
-oe_python_template-0.0.1.dist-info/RECORD,,