oe-python-template 0.6.36__py3-none-any.whl → 0.7.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.6.36.dist-info → oe_python_template-0.7.1.dist-info}/METADATA +22 -9
- {oe_python_template-0.6.36.dist-info → oe_python_template-0.7.1.dist-info}/RECORD +5 -5
- {oe_python_template-0.6.36.dist-info → oe_python_template-0.7.1.dist-info}/WHEEL +0 -0
- {oe_python_template-0.6.36.dist-info → oe_python_template-0.7.1.dist-info}/entry_points.txt +0 -0
- {oe_python_template-0.6.36.dist-info → oe_python_template-0.7.1.dist-info}/licenses/LICENSE +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: oe-python-template
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.7.1
|
|
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/
|
|
@@ -159,9 +159,7 @@ To generate a new project, follow these steps:
|
|
|
159
159
|
|
|
160
160
|
**Step 1**: Install homebrew, uv package manager amd further tools. Copy the following code into your terminal and execute it.
|
|
161
161
|
```shell
|
|
162
|
-
if [[ "$OSTYPE" == "
|
|
163
|
-
# Nothing specific yet
|
|
164
|
-
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then # Install Linux specifics
|
|
162
|
+
if [[ "$OSTYPE" == "linux-gnu"* ]]; then # Install Linux specifics
|
|
165
163
|
sudo apt-get update -y && sudo apt-get install curl -y # https://curl.se/
|
|
166
164
|
fi
|
|
167
165
|
if ! command -v brew &> /dev/null; then # https://brew.sh/
|
|
@@ -177,15 +175,11 @@ which libxml2 &> /dev/null || brew install libxml2 # https://en.wikipedia
|
|
|
177
175
|
which act &> /dev/null || brew install act # https://nektosact.com/
|
|
178
176
|
which pinact &> /dev/null || brew install pinact # https://github.com/suzuki-shunsuke/pinact
|
|
179
177
|
if [[ "$OSTYPE" == "darwin"* ]]; then # Install macOS specifics
|
|
180
|
-
# Nothing specific yet
|
|
181
|
-
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then # Install Linux specifics
|
|
182
178
|
which pinentry-mac &> /dev/null || brew install gnupg # https://github.com/GPGTools/pinentry
|
|
183
179
|
fi
|
|
184
180
|
uv tool install copier # https://copier.readthedocs.io/en/stable/
|
|
185
181
|
```
|
|
186
182
|
|
|
187
|
-
Notes:
|
|
188
|
-
|
|
189
183
|
**Step 2**: [Create a repository on GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository), clone to your local machine, and change into it's directory.
|
|
190
184
|
|
|
191
185
|
**Step 3**: Generate the project. Copy
|
|
@@ -422,11 +416,30 @@ docker compose run oe-python-template echo "Lorem"
|
|
|
422
416
|
docker compose run oe-python-template echo "Lorem" --json
|
|
423
417
|
docker compose run oe-python-template openapi
|
|
424
418
|
docker compose run oe-python-template openapi --output-format=json
|
|
425
|
-
|
|
419
|
+
echo "Running OE Python Template's API container as a daemon ..."
|
|
420
|
+
docker compose up -d
|
|
421
|
+
echo "Waiting for the API server to start ..."
|
|
422
|
+
sleep 5
|
|
423
|
+
echo "Checking health of v1 API ..."
|
|
424
|
+
curl http://127.0.0.1:8000/api/v1/healthz
|
|
425
|
+
echo ""
|
|
426
|
+
echo "Saying hello world with v1 API ..."
|
|
426
427
|
curl http://127.0.0.1:8000/api/v1/hello-world
|
|
428
|
+
echo ""
|
|
429
|
+
echo "Swagger docs of v1 API ..."
|
|
427
430
|
curl http://127.0.0.1:8000/api/v1/docs
|
|
431
|
+
echo ""
|
|
432
|
+
echo "Checking health of v2 API ..."
|
|
433
|
+
curl http://127.0.0.1:8000/api/v2/healthz
|
|
434
|
+
echo ""
|
|
435
|
+
echo "Saying hello world with v1 API ..."
|
|
428
436
|
curl http://127.0.0.1:8000/api/v2/hello-world
|
|
437
|
+
echo ""
|
|
438
|
+
echo "Swagger docs of v2 API ..."
|
|
429
439
|
curl http://127.0.0.1:8000/api/v2/docs
|
|
440
|
+
echo ""
|
|
441
|
+
echo "Shutting down the API container ..."
|
|
442
|
+
docker compose down
|
|
430
443
|
```
|
|
431
444
|
|
|
432
445
|
## Extra: Lorem Ipsum
|
|
@@ -4,8 +4,8 @@ oe_python_template/cli.py,sha256=RwVJztulrFbdKRASqdjWLhCM7YNgBoxiP4tvlmekE30,349
|
|
|
4
4
|
oe_python_template/constants.py,sha256=Z1c06l5DeRuFxYVLHihHHTYvr8_Qh0nyzVKOe5X3ZNs,350
|
|
5
5
|
oe_python_template/models.py,sha256=L9uwom3TkuOpN3R30bGKEBQKcrLLEMc-O9e8VVSNTGw,838
|
|
6
6
|
oe_python_template/service.py,sha256=wHwaD_2oSMle41QKXC64T4uKznUnyuV9d4b9Cu7lIoY,1202
|
|
7
|
-
oe_python_template-0.
|
|
8
|
-
oe_python_template-0.
|
|
9
|
-
oe_python_template-0.
|
|
10
|
-
oe_python_template-0.
|
|
11
|
-
oe_python_template-0.
|
|
7
|
+
oe_python_template-0.7.1.dist-info/METADATA,sha256=GvbquwzgYRLKvygidMqI14fgytbaUFbQbWn5OSgWSyw,29144
|
|
8
|
+
oe_python_template-0.7.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
|
9
|
+
oe_python_template-0.7.1.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
|
|
10
|
+
oe_python_template-0.7.1.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
|
|
11
|
+
oe_python_template-0.7.1.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|
|
File without changes
|