oe-python-template 0.9.0__py3-none-any.whl → 0.9.2__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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: oe-python-template
3
- Version: 0.9.0
3
+ Version: 0.9.2
4
4
  Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
5
5
  Project-URL: Homepage, https://oe-python-template.readthedocs.io/en/latest/
6
6
  Project-URL: Documentation, https://oe-python-template.readthedocs.io/en/latest/
@@ -247,7 +247,7 @@ This project is designed with operational excellence in mind, using modern Pytho
247
247
  a. [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
248
248
  b. [Streamlit web application](https://oe-python-template.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
249
249
  c. [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
250
- 2. [Complete reference documentation](https://oe-python-template.readthedocs.io/en/latest/reference.html) on Read the Docs
250
+ 2. Complete reference documentation [for the library](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html), [for the CLI](https://oe-python-template.readthedocs.io/en/latest/cli_reference.html) and [for the API](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) on Read the Docs
251
251
  3. [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template) including unit and E2E tests (reported on Codecov)
252
252
  4. 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/))
253
253
  5. Compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))
@@ -283,7 +283,8 @@ message = Service.get_hello_world()
283
283
  console.print(f"[blue]{message}[/blue]")
284
284
  ```
285
285
 
286
- [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)
286
+ [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/lib_reference.html)
287
+
287
288
 
288
289
  ### Streamlit App
289
290
 
@@ -363,6 +364,9 @@ uvx oe-python-template openapi --output-format=json
363
364
  uvx oe-python-template serve
364
365
  ```
365
366
 
367
+ See the [reference documentation of the CLI](https://oe-python-template.readthedocs.io/en/latest/cli_reference.html) for detailed documentation of all CLI commands and options.
368
+
369
+
366
370
  ### Environment
367
371
 
368
372
  The service loads environment variables including support for .env files.
@@ -433,6 +437,9 @@ echo "Shutting down the API container ..."
433
437
  docker compose down
434
438
  ```
435
439
 
440
+ * See the [reference documentation of the API](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) for detailed documentation of all API operations and parameters.
441
+
442
+
436
443
  ## Extra: Lorem Ipsum
437
444
 
438
445
  Dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam.
@@ -5,8 +5,8 @@ oe_python_template/constants.py,sha256=Z1c06l5DeRuFxYVLHihHHTYvr8_Qh0nyzVKOe5X3Z
5
5
  oe_python_template/models.py,sha256=L9uwom3TkuOpN3R30bGKEBQKcrLLEMc-O9e8VVSNTGw,838
6
6
  oe_python_template/service.py,sha256=f_s-NTNcCQb5fWDjW-vNmbp4GCuprOqm8rAp_K_SPIw,1606
7
7
  oe_python_template/settings.py,sha256=87VZ1IEGbV3ivDjpG6x_Mgs2inH2hVd4ZD7DGsHOYFE,743
8
- oe_python_template-0.9.0.dist-info/METADATA,sha256=sXz5-B0IwXbpUDD5yx7MCIl-bu1CNxg9X3_zwPUwo6o,29126
9
- oe_python_template-0.9.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
10
- oe_python_template-0.9.0.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
11
- oe_python_template-0.9.0.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
12
- oe_python_template-0.9.0.dist-info/RECORD,,
8
+ oe_python_template-0.9.2.dist-info/METADATA,sha256=_gyQ4bsKzQMUobT77SWC2G7OU4xkz3qR5NjKsMqZS_k,29699
9
+ oe_python_template-0.9.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
10
+ oe_python_template-0.9.2.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
11
+ oe_python_template-0.9.2.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
12
+ oe_python_template-0.9.2.dist-info/RECORD,,