oe-python-template 0.6.36__tar.gz → 0.7.1__tar.gz

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 (11) hide show
  1. {oe_python_template-0.6.36 → oe_python_template-0.7.1}/PKG-INFO +22 -9
  2. {oe_python_template-0.6.36 → oe_python_template-0.7.1}/README.md +21 -8
  3. {oe_python_template-0.6.36 → oe_python_template-0.7.1}/pyproject.toml +2 -2
  4. {oe_python_template-0.6.36 → oe_python_template-0.7.1}/.gitignore +0 -0
  5. {oe_python_template-0.6.36 → oe_python_template-0.7.1}/LICENSE +0 -0
  6. {oe_python_template-0.6.36 → oe_python_template-0.7.1}/src/oe_python_template/__init__.py +0 -0
  7. {oe_python_template-0.6.36 → oe_python_template-0.7.1}/src/oe_python_template/api.py +0 -0
  8. {oe_python_template-0.6.36 → oe_python_template-0.7.1}/src/oe_python_template/cli.py +0 -0
  9. {oe_python_template-0.6.36 → oe_python_template-0.7.1}/src/oe_python_template/constants.py +0 -0
  10. {oe_python_template-0.6.36 → oe_python_template-0.7.1}/src/oe_python_template/models.py +0 -0
  11. {oe_python_template-0.6.36 → oe_python_template-0.7.1}/src/oe_python_template/service.py +0 -0
{oe_python_template-0.6.36 → oe_python_template-0.7.1}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: oe-python-template
3
- Version: 0.6.36
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" == "darwin"* ]]; then # Install macOS specifics
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
- docker compose up
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
{oe_python_template-0.6.36 → oe_python_template-0.7.1}/README.md RENAMED
@@ -98,9 +98,7 @@ To generate a new project, follow these steps:
98
98
 
99
99
  **Step 1**: Install homebrew, uv package manager amd further tools. Copy the following code into your terminal and execute it.
100
100
  ```shell
101
- if [[ "$OSTYPE" == "darwin"* ]]; then # Install macOS specifics
102
- # Nothing specific yet
103
- elif [[ "$OSTYPE" == "linux-gnu"* ]]; then # Install Linux specifics
101
+ if [[ "$OSTYPE" == "linux-gnu"* ]]; then # Install Linux specifics
104
102
  sudo apt-get update -y && sudo apt-get install curl -y # https://curl.se/
105
103
  fi
106
104
  if ! command -v brew &> /dev/null; then # https://brew.sh/
@@ -116,15 +114,11 @@ which libxml2 &> /dev/null || brew install libxml2 # https://en.wikipedia
116
114
  which act &> /dev/null || brew install act # https://nektosact.com/
117
115
  which pinact &> /dev/null || brew install pinact # https://github.com/suzuki-shunsuke/pinact
118
116
  if [[ "$OSTYPE" == "darwin"* ]]; then # Install macOS specifics
119
- # Nothing specific yet
120
- elif [[ "$OSTYPE" == "linux-gnu"* ]]; then # Install Linux specifics
121
117
  which pinentry-mac &> /dev/null || brew install gnupg # https://github.com/GPGTools/pinentry
122
118
  fi
123
119
  uv tool install copier # https://copier.readthedocs.io/en/stable/
124
120
  ```
125
121
 
126
- Notes:
127
-
128
122
  **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.
129
123
 
130
124
  **Step 3**: Generate the project. Copy
@@ -361,11 +355,30 @@ docker compose run oe-python-template echo "Lorem"
361
355
  docker compose run oe-python-template echo "Lorem" --json
362
356
  docker compose run oe-python-template openapi
363
357
  docker compose run oe-python-template openapi --output-format=json
364
- docker compose up
358
+ echo "Running OE Python Template's API container as a daemon ..."
359
+ docker compose up -d
360
+ echo "Waiting for the API server to start ..."
361
+ sleep 5
362
+ echo "Checking health of v1 API ..."
363
+ curl http://127.0.0.1:8000/api/v1/healthz
364
+ echo ""
365
+ echo "Saying hello world with v1 API ..."
365
366
  curl http://127.0.0.1:8000/api/v1/hello-world
367
+ echo ""
368
+ echo "Swagger docs of v1 API ..."
366
369
  curl http://127.0.0.1:8000/api/v1/docs
370
+ echo ""
371
+ echo "Checking health of v2 API ..."
372
+ curl http://127.0.0.1:8000/api/v2/healthz
373
+ echo ""
374
+ echo "Saying hello world with v1 API ..."
367
375
  curl http://127.0.0.1:8000/api/v2/hello-world
376
+ echo ""
377
+ echo "Swagger docs of v2 API ..."
368
378
  curl http://127.0.0.1:8000/api/v2/docs
379
+ echo ""
380
+ echo "Shutting down the API container ..."
381
+ docker compose down
369
382
  ```
370
383
 
371
384
  ## Extra: Lorem Ipsum
{oe_python_template-0.6.36 → oe_python_template-0.7.1}/pyproject.toml RENAMED
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "oe-python-template"
3
- version = "0.6.36"
3
+ version = "0.7.1"
4
4
  description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
5
5
  readme = "README.md"
6
6
  authors = [
@@ -253,7 +253,7 @@ source = ["src/"]
253
253
 
254
254
 
255
255
  [tool.bumpversion]
256
- current_version = "0.6.36"
256
+ current_version = "0.7.1"
257
257
  parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
258
258
  serialize = ["{major}.{minor}.{patch}"]
259
259
  search = "{current_version}"