oe-python-template 0.2.0__py3-none-any.whl → 0.2.1__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.
- oe_python_template-0.2.1.dist-info/METADATA +60 -0
- {oe_python_template-0.2.0.dist-info → oe_python_template-0.2.1.dist-info}/RECORD +5 -5
- oe_python_template-0.2.0.dist-info/METADATA +0 -288
- {oe_python_template-0.2.0.dist-info → oe_python_template-0.2.1.dist-info}/WHEEL +0 -0
- {oe_python_template-0.2.0.dist-info → oe_python_template-0.2.1.dist-info}/entry_points.txt +0 -0
- {oe_python_template-0.2.0.dist-info → oe_python_template-0.2.1.dist-info}/licenses/LICENSE +0 -0
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: oe-python-template
|
|
3
|
+
Version: 0.2.1
|
|
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/en/latest/
|
|
6
|
+
Project-URL: Documentation, https://oe-python-template.readthedocs.io/en/latest/
|
|
7
|
+
Project-URL: Source, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template
|
|
8
|
+
Project-URL: Changelog, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/releases
|
|
9
|
+
Project-URL: Issues, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues
|
|
10
|
+
Author-email: Helmut Hoffer von Ankershoffen <helmuthva@gmail.com>
|
|
11
|
+
License: MIT License
|
|
12
|
+
|
|
13
|
+
Copyright (c) [2025] [Helmut Hoffer von Ankershoffen (helmuthva@gmail.com)]
|
|
14
|
+
|
|
15
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
16
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
17
|
+
in the Software without restriction, including without limitation the rights
|
|
18
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
19
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
20
|
+
furnished to do so, subject to the following conditions:
|
|
21
|
+
|
|
22
|
+
The above copyright notice and this permission notice shall be included in all
|
|
23
|
+
copies or substantial portions of the Software.
|
|
24
|
+
|
|
25
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
26
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
27
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
28
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
29
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
30
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
31
|
+
SOFTWARE.
|
|
32
|
+
License-File: LICENSE
|
|
33
|
+
Keywords: codecov,docker,oe-python-template,pydantic,python,ruff,typer,uv
|
|
34
|
+
Classifier: Development Status :: 2 - Pre-Alpha
|
|
35
|
+
Classifier: Framework :: Pydantic
|
|
36
|
+
Classifier: Framework :: Pytest
|
|
37
|
+
Classifier: Intended Audience :: Developers
|
|
38
|
+
Classifier: Intended Audience :: End Users/Desktop
|
|
39
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
40
|
+
Classifier: Natural Language :: English
|
|
41
|
+
Classifier: Operating System :: MacOS :: MacOS X
|
|
42
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
43
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
44
|
+
Classifier: Programming Language :: Python
|
|
45
|
+
Classifier: Programming Language :: Python :: 3
|
|
46
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
47
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
48
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
49
|
+
Classifier: Typing :: Typed
|
|
50
|
+
Requires-Python: <4.0,>=3.11
|
|
51
|
+
Requires-Dist: pydantic>=2.10.6
|
|
52
|
+
Requires-Dist: python-dotenv>=1.0.1
|
|
53
|
+
Requires-Dist: typer>=0.15.1
|
|
54
|
+
Provides-Extra: examples
|
|
55
|
+
Requires-Dist: jupyter>=1.1.1; extra == 'examples'
|
|
56
|
+
Requires-Dist: marimo>=0.11.13; extra == 'examples'
|
|
57
|
+
Requires-Dist: streamlit>=1.42.2; extra == 'examples'
|
|
58
|
+
Description-Content-Type: text/markdown
|
|
59
|
+
|
|
60
|
+
Will be generated from readme_*.md partials.
|
|
@@ -2,8 +2,8 @@ oe_python_template/__init__.py,sha256=XJAycUgDI2K8T0jVcXbaGfx2UAQJZbYcvJ_SYSqFyD
|
|
|
2
2
|
oe_python_template/cli.py,sha256=5tUw70ffHL-ot0rM7g6BmsVhn9IKBQXwbWU0-n9-wb4,1319
|
|
3
3
|
oe_python_template/constants.py,sha256=Z1c06l5DeRuFxYVLHihHHTYvr8_Qh0nyzVKOe5X3ZNs,350
|
|
4
4
|
oe_python_template/service.py,sha256=p59ch0g81LpsRvL-m-vLPuk0Rf6EYsZfZJ_OCA9vWzQ,500
|
|
5
|
-
oe_python_template-0.2.
|
|
6
|
-
oe_python_template-0.2.
|
|
7
|
-
oe_python_template-0.2.
|
|
8
|
-
oe_python_template-0.2.
|
|
9
|
-
oe_python_template-0.2.
|
|
5
|
+
oe_python_template-0.2.1.dist-info/METADATA,sha256=OC7fyXmDsG8frnx9LzlRBkzUv2JEizXe-_00UoYPkpc,3176
|
|
6
|
+
oe_python_template-0.2.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
|
7
|
+
oe_python_template-0.2.1.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
|
|
8
|
+
oe_python_template-0.2.1.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
|
|
9
|
+
oe_python_template-0.2.1.dist-info/RECORD,,
|
|
@@ -1,288 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: oe-python-template
|
|
3
|
-
Version: 0.2.0
|
|
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/en/latest/
|
|
6
|
-
Project-URL: Documentation, https://oe-python-template.readthedocs.io/en/latest/
|
|
7
|
-
Project-URL: Source, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template
|
|
8
|
-
Project-URL: Changelog, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/releases
|
|
9
|
-
Project-URL: Issues, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues
|
|
10
|
-
Author-email: Helmut Hoffer von Ankershoffen <helmuthva@gmail.com>
|
|
11
|
-
License: MIT License
|
|
12
|
-
|
|
13
|
-
Copyright (c) [2025] [Helmut Hoffer von Ankershoffen (helmuthva@gmail.com)]
|
|
14
|
-
|
|
15
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
16
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
17
|
-
in the Software without restriction, including without limitation the rights
|
|
18
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
19
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
20
|
-
furnished to do so, subject to the following conditions:
|
|
21
|
-
|
|
22
|
-
The above copyright notice and this permission notice shall be included in all
|
|
23
|
-
copies or substantial portions of the Software.
|
|
24
|
-
|
|
25
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
26
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
27
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
28
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
29
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
30
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
31
|
-
SOFTWARE.
|
|
32
|
-
License-File: LICENSE
|
|
33
|
-
Keywords: codecov,docker,oe-python-template,pydantic,python,ruff,typer,uv
|
|
34
|
-
Classifier: Development Status :: 2 - Pre-Alpha
|
|
35
|
-
Classifier: Framework :: Pydantic
|
|
36
|
-
Classifier: Framework :: Pytest
|
|
37
|
-
Classifier: Intended Audience :: Developers
|
|
38
|
-
Classifier: Intended Audience :: End Users/Desktop
|
|
39
|
-
Classifier: License :: OSI Approved :: MIT License
|
|
40
|
-
Classifier: Natural Language :: English
|
|
41
|
-
Classifier: Operating System :: MacOS :: MacOS X
|
|
42
|
-
Classifier: Operating System :: Microsoft :: Windows
|
|
43
|
-
Classifier: Operating System :: POSIX :: Linux
|
|
44
|
-
Classifier: Programming Language :: Python
|
|
45
|
-
Classifier: Programming Language :: Python :: 3
|
|
46
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
47
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
48
|
-
Classifier: Programming Language :: Python :: 3.13
|
|
49
|
-
Classifier: Typing :: Typed
|
|
50
|
-
Requires-Python: <4.0,>=3.11
|
|
51
|
-
Requires-Dist: pydantic>=2.10.6
|
|
52
|
-
Requires-Dist: python-dotenv>=1.0.1
|
|
53
|
-
Requires-Dist: typer>=0.15.1
|
|
54
|
-
Provides-Extra: examples
|
|
55
|
-
Requires-Dist: jupyter>=1.1.1; extra == 'examples'
|
|
56
|
-
Requires-Dist: marimo>=0.11.13; extra == 'examples'
|
|
57
|
-
Requires-Dist: streamlit>=1.42.2; extra == 'examples'
|
|
58
|
-
Description-Content-Type: text/markdown
|
|
59
|
-
|
|
60
|
-
# 🧠 OE Python Template
|
|
61
|
-
|
|
62
|
-
[
|
|
63
|
-
](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/LICENSE)
|
|
64
|
-
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)
|
|
65
|
-
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/test-and-report.yml)
|
|
66
|
-
[](https://oe-python-template.readthedocs.io/en/latest/)
|
|
67
|
-
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
|
|
68
|
-
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
|
|
69
|
-
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
|
|
70
|
-
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
|
|
71
|
-
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
|
|
72
|
-
[](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template)
|
|
73
|
-
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)
|
|
74
|
-
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/releases)
|
|
75
|
-
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commits/main/)
|
|
76
|
-
[](https://pypi.python.org/pypi/oe-python-template)
|
|
77
|
-
[](https://pypi.python.org/pypi/oe-python-template)
|
|
78
|
-
[](https://hub.docker.com/r/helmuthva/oe-python-template/tags)
|
|
79
|
-
[](https://hub.docker.com/r/helmuthva/oe-python-template/)
|
|
80
|
-
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
|
|
81
|
-
<!---
|
|
82
|
-
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/pkgs/container/oe-python-template)
|
|
83
|
-
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/pkgs/container/oe-python-template)
|
|
84
|
-
-->
|
|
85
|
-
|
|
86
|
-
> [!TIP]
|
|
87
|
-
> 📚 [Online documentation](https://oe-python-template.readthedocs.io/en/latest/) - 📖 [PDF Manual](https://oe-python-template.readthedocs.io/_/downloads/en/latest/pdf/)
|
|
88
|
-
---
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
Copier template to scaffold Python projects compliant with best practices and modern tooling.
|
|
92
|
-
|
|
93
|
-
Use Cases:
|
|
94
|
-
1) Lorem Ipsum
|
|
95
|
-
2) Dolor Sit Amet
|
|
96
|
-
3) Consectetur Adipiscing Elit
|
|
97
|
-
|
|
98
|
-
## Overview
|
|
99
|
-
|
|
100
|
-
Adding OE Python Template to your project as a dependency is easy.
|
|
101
|
-
|
|
102
|
-
```shell
|
|
103
|
-
uv add oe-python-template # add dependency to your project
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
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:
|
|
107
|
-
|
|
108
|
-
```shell
|
|
109
|
-
pip install oe-python-template # add dependency to your project
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
Executing the command line interface (CLI) is just as easy:
|
|
113
|
-
|
|
114
|
-
```shell
|
|
115
|
-
uvx oe-python-template
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
The CLI provides extensive help:
|
|
119
|
-
|
|
120
|
-
```shell
|
|
121
|
-
uvx oe-python-template --help # all CLI commands
|
|
122
|
-
uvx oe-python-template command --help # all options for command
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
## Highlights
|
|
126
|
-
|
|
127
|
-
* Copier template to scaffold Python projects compliant with best practices and modern tooling.
|
|
128
|
-
* Various Examples:
|
|
129
|
-
- [Simple Python script]https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
|
|
130
|
-
- [Streamlit web application](https://oe-python-template.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
|
|
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
|
-
* [Complete reference documenation](https://oe-python-template.readthedocs.io/en/latest/reference.html) on Read the Docs
|
|
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
|
-
* 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/))
|
|
135
|
-
* Compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))
|
|
136
|
-
* Up-to-date dependencies (monitored by [Renovate](https://github.com/renovatebot/renovate))
|
|
137
|
-
* [A-grade code quality](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template) in security, maintainability, and reliability with low technical debt and low codesmell (verified by SonarQube)
|
|
138
|
-
* 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/tags)
|
|
139
|
-
* Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
|
|
140
|
-
|
|
141
|
-
## Usage Examples
|
|
142
|
-
|
|
143
|
-
### Minimal Python Script:
|
|
144
|
-
|
|
145
|
-
```python
|
|
146
|
-
"""Example script demonstrating the usage of the service provided by OE Python Template."""
|
|
147
|
-
|
|
148
|
-
from dotenv import load_dotenv
|
|
149
|
-
from rich.console import Console
|
|
150
|
-
|
|
151
|
-
from oe_python_template import Service
|
|
152
|
-
|
|
153
|
-
console = Console()
|
|
154
|
-
|
|
155
|
-
load_dotenv()
|
|
156
|
-
|
|
157
|
-
message = Service.get_hello_world()
|
|
158
|
-
console.print(f"[blue]{message}[/blue]")
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
[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)
|
|
162
|
-
|
|
163
|
-
### Streamlit App
|
|
164
|
-
|
|
165
|
-
Serve the functionality provided by OE Python Template in the web by easily integrating the service into a Streamlit application.
|
|
166
|
-
|
|
167
|
-
[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)
|
|
168
|
-
|
|
169
|
-
... or serve the app locally
|
|
170
|
-
```shell
|
|
171
|
-
uv sync --all-extras # Install streamlit dependency part of the examples extra, see pyproject.toml
|
|
172
|
-
uv run streamlit run examples/streamlit.py # Serve on localhost:8501, opens browser
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
## Notebooks
|
|
176
|
-
|
|
177
|
-
### Jupyter
|
|
178
|
-
|
|
179
|
-
[Show the Jupyter code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb)
|
|
180
|
-
|
|
181
|
-
... or run within VSCode
|
|
182
|
-
|
|
183
|
-
```shell
|
|
184
|
-
uv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml
|
|
185
|
-
```
|
|
186
|
-
Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
|
|
187
|
-
|
|
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).
|
|
213
|
-
|
|
214
|
-
## Command Line Interface (CLI)
|
|
215
|
-
|
|
216
|
-
### Run with [uvx](https://docs.astral.sh/uv/guides/tools/)
|
|
217
|
-
|
|
218
|
-
Show available commands:
|
|
219
|
-
|
|
220
|
-
```shell
|
|
221
|
-
uvx oe-python-template --help
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
Execute commands:
|
|
225
|
-
|
|
226
|
-
```shell
|
|
227
|
-
uvx oe-python-template hello-world
|
|
228
|
-
uvx oe-python-template hello-world --json
|
|
229
|
-
uvx oe-python-template echo "Lorem Ipsum"
|
|
230
|
-
```
|
|
231
|
-
|
|
232
|
-
### Environment
|
|
233
|
-
|
|
234
|
-
The service loads environment variables including support for .env files.
|
|
235
|
-
|
|
236
|
-
```shell
|
|
237
|
-
cp .env.example .env # copy example file
|
|
238
|
-
echo "THE_VAR=MY_VALUE" > .env # overwrite with your values
|
|
239
|
-
```
|
|
240
|
-
|
|
241
|
-
Now run the usage examples again.
|
|
242
|
-
|
|
243
|
-
### Run with Docker
|
|
244
|
-
|
|
245
|
-
You can as well run the CLI within Docker.
|
|
246
|
-
|
|
247
|
-
```shell
|
|
248
|
-
docker run helmuthva/oe-python-template --help
|
|
249
|
-
docker run helmuthva/oe-python-template hello-world
|
|
250
|
-
docker run helmuthva/oe-python-template hello-world --json
|
|
251
|
-
docker run helmuthva/oe-python-template echo "Lorem"
|
|
252
|
-
```
|
|
253
|
-
|
|
254
|
-
Execute command:
|
|
255
|
-
|
|
256
|
-
```shell
|
|
257
|
-
docker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template echo "Lorem Ipsum"
|
|
258
|
-
```
|
|
259
|
-
|
|
260
|
-
Or use docker compose
|
|
261
|
-
|
|
262
|
-
The .env is passed through from the host to the Docker container.
|
|
263
|
-
|
|
264
|
-
```shell
|
|
265
|
-
docker compose up
|
|
266
|
-
docker compose run oe-python-template --help
|
|
267
|
-
```
|
|
268
|
-
|
|
269
|
-
## Extra: Lorem Ipsum
|
|
270
|
-
|
|
271
|
-
Dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam.
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
## Further Reading
|
|
275
|
-
|
|
276
|
-
* Check out the [reference](https://oe-python-template.readthedocs.io/en/latest/reference.html) with detailed documentation of public classes and functions.
|
|
277
|
-
* Our [release notes](https://oe-python-template.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.
|
|
278
|
-
* In case you want to help us improve 🧠 OE Python Template: The [contribution guidelines](https://oe-python-template.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.
|
|
279
|
-
|
|
280
|
-
## Star History
|
|
281
|
-
|
|
282
|
-
<a href="https://star-history.com/#helmut-hoffer-von-ankershoffen/oe-python-template">
|
|
283
|
-
<picture>
|
|
284
|
-
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template&type=Date&theme=dark" />
|
|
285
|
-
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template&type=Date" />
|
|
286
|
-
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template&type=Date" />
|
|
287
|
-
</picture>
|
|
288
|
-
</a>
|
|
File without changes
|
|
File without changes
|
|
File without changes
|