oe-python-template 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. oe_python_template/__init__.py +1 -2
  2. oe_python_template/cli.py +1 -1
  3. oe_python_template/service.py +3 -1
  4. {oe_python_template-0.1.2.dist-info → oe_python_template-0.1.4.dist-info}/METADATA +34 -8
  5. oe_python_template-0.1.4.dist-info/RECORD +9 -0
  6. oe_python_template-0.1.2.dist-info/RECORD +0 -9
  7. {oe_python_template-0.1.2.dist-info → oe_python_template-0.1.4.dist-info}/WHEEL +0 -0
  8. {oe_python_template-0.1.2.dist-info → oe_python_template-0.1.4.dist-info}/entry_points.txt +0 -0
  9. {oe_python_template-0.1.2.dist-info → oe_python_template-0.1.4.dist-info}/licenses/LICENSE +0 -0
oe_python_template/__init__.py CHANGED
@@ -5,12 +5,11 @@ from .constants import (
5
5
  __project_path__,
6
6
  __version__,
7
7
  )
8
-
9
8
  from .service import Service
10
9
 
11
10
  __all__ = [
11
+ "Service",
12
12
  "__project_name__",
13
13
  "__project_path__",
14
14
  "__version__",
15
- "Service",
16
15
  ]
oe_python_template/cli.py CHANGED
@@ -5,7 +5,7 @@ from typing import Annotated
5
5
  import typer
6
6
  from rich.console import Console
7
7
 
8
- from oe_python_template import __version__, Service
8
+ from oe_python_template import Service, __version__
9
9
 
10
10
  console = Console()
11
11
 
oe_python_template/service.py CHANGED
@@ -1,10 +1,12 @@
1
1
  """Service of OE Python Template."""
2
2
 
3
3
  import os
4
+
4
5
  from dotenv import load_dotenv
5
6
 
6
7
  load_dotenv()
7
- THE_VAR = os.getenv("THE_VAR","not defined")
8
+ THE_VAR = os.getenv("THE_VAR", "not defined")
9
+
8
10
 
9
11
  class Service:
10
12
  """Service of OE Python Template."""
{oe_python_template-0.1.2.dist-info → oe_python_template-0.1.4.dist-info}/METADATA RENAMED
@@ -1,9 +1,9 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: oe-python-template
3
- Version: 0.1.2
3
+ Version: 0.1.4
4
4
  Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
5
- Project-URL: Homepage, https://oe-python-template.readthedocs.io/
6
- Project-URL: Documentation, https://oe-python-template.readthedocs.io/
5
+ Project-URL: Homepage, https://oe-python-template.readthedocs.io/en/latest/
6
+ Project-URL: Documentation, https://oe-python-template.readthedocs.io/en/latest/
7
7
  Project-URL: Source, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template
8
8
  Project-URL: Changelog, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/releases
9
9
  Project-URL: Issues, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues
@@ -63,7 +63,7 @@ Description-Content-Type: text/markdown
63
63
  ](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/LICENSE)
64
64
  [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/oe-python-template.svg?logo=python&color=204361&labelColor=1E2933)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)
65
65
  [![CI](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/test-and-report.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/test-and-report.yml)
66
- [![Read the Docs](https://img.shields.io/readthedocs/oe-python-template)](https://oe-python-template.readthedocs.io/)
66
+ [![Read the Docs](https://img.shields.io/readthedocs/oe-python-template)](https://oe-python-template.readthedocs.io/en/latest/)
67
67
  [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
68
68
  [![Security](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
69
69
  [![Maintainability](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
@@ -128,7 +128,7 @@ uvx oe-python-template command --help # all options for command
128
128
  * Various Examples:
129
129
  - [Simple Python script]https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
130
130
  - [Streamlit web application](https://oe-python-template.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
131
- - [Jupyter notebook](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/jupyter.ipynb)
131
+ - [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
132
132
  * [Complete reference documenation](https://oe-python-template.readthedocs.io/en/latest/reference.html) on Read the Docs
133
133
  * [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template) including unit and E2E tests (reported on Codecov)
134
134
  * 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/))
@@ -172,9 +172,11 @@ uv sync --all-extras # Install streamlit dependen
172
172
  uv run streamlit run examples/streamlit.py # Serve on localhost:8501, opens browser
173
173
  ```
174
174
 
175
- ## Jupyter Notebook
175
+ ## Notebooks
176
176
 
177
- [Show notebook code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/jupyter.ipynb)
177
+ ### Jupyter
178
+
179
+ [Show the Jupyter code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb)
178
180
 
179
181
  ... or run within VSCode
180
182
 
@@ -183,7 +185,31 @@ uv sync --all-extras # Install ipykernel dependen
183
185
  ```
184
186
  Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
185
187
 
186
- Click on `examples/jupyter.ipynb` in VSCode and run it.
188
+ Click on `examples/notebook.ipynb` in VSCode and run it.
189
+
190
+ ### Marimo
191
+
192
+ [Show the marimo code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py)
193
+
194
+ Execute the notebook as a WASM based web app
195
+
196
+ ```shell
197
+ uv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml
198
+ uv run marimo run examples/notebook.py --watch # Serve on localhost:2718, opens browser
199
+ ```
200
+
201
+ or edit interactively in your browser
202
+
203
+ ```shell
204
+ uv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml
205
+ uv run marimo edit examples/notebook.py --watch # Edit on localhost:2718, opens browser
206
+ ```
207
+
208
+ ... or edit interactively within VSCode
209
+
210
+ Install the [Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
211
+
212
+ 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).
187
213
 
188
214
  ## Command Line Interface (CLI)
189
215
 
oe_python_template-0.1.4.dist-info/RECORD ADDED
@@ -0,0 +1,9 @@
1
+ oe_python_template/__init__.py,sha256=XJAycUgDI2K8T0jVcXbaGfx2UAQJZbYcvJ_SYSqFyDA,315
2
+ oe_python_template/cli.py,sha256=5tUw70ffHL-ot0rM7g6BmsVhn9IKBQXwbWU0-n9-wb4,1319
3
+ oe_python_template/constants.py,sha256=Z1c06l5DeRuFxYVLHihHHTYvr8_Qh0nyzVKOe5X3ZNs,350
4
+ oe_python_template/service.py,sha256=p59ch0g81LpsRvL-m-vLPuk0Rf6EYsZfZJ_OCA9vWzQ,500
5
+ oe_python_template-0.1.4.dist-info/METADATA,sha256=GiYwJp0skkB2Vb8WSkZNQvtciRJQfvfVHnoynwhPIrU,15987
6
+ oe_python_template-0.1.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
7
+ oe_python_template-0.1.4.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
8
+ oe_python_template-0.1.4.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
9
+ oe_python_template-0.1.4.dist-info/RECORD,,
oe_python_template-0.1.2.dist-info/RECORD DELETED
@@ -1,9 +0,0 @@
1
- oe_python_template/__init__.py,sha256=Fnde1pSaMfYkaxltxJhP0d4G5o314EmKJThX08th754,316
2
- oe_python_template/cli.py,sha256=JE64lWrsnUEZFLSIuehjDAScTJkBEKlqubaXjlJJcWU,1319
3
- oe_python_template/constants.py,sha256=Z1c06l5DeRuFxYVLHihHHTYvr8_Qh0nyzVKOe5X3ZNs,350
4
- oe_python_template/service.py,sha256=3sXzBoJTZQ2jIsdUfvZSIj47INJmLklfnUBvQC3Wm0o,497
5
- oe_python_template-0.1.2.dist-info/METADATA,sha256=FYnc75tYOn2e2AE8Oc4rVlJxTXs_zf7rSonSSZDAzoE,14814
6
- oe_python_template-0.1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
7
- oe_python_template-0.1.2.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
8
- oe_python_template-0.1.2.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
9
- oe_python_template-0.1.2.dist-info/RECORD,,