Skip to content

Commit 361f575

Browse files
chore(deps): update from template
1 parent 04364b8 commit 361f575

4 files changed

Lines changed: 55 additions & 240 deletions

File tree

.copier-answers.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_commit: v0.6.12
1+
_commit: v0.6.14
22
_src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
33
author_email: helmuthva@gmail.com
44
author_github_username: helmut-hoffer-von-ankershoffen
Lines changed: 34 additions & 204 deletions
Original file line numberDiff line numberDiff line change
@@ -1,204 +1,34 @@
1-
components:
2-
schemas:
3-
EchoRequest:
4-
description: Request model for echo endpoint.
5-
properties:
6-
text:
7-
description: The text to echo back
8-
examples:
9-
- Hello, world!
10-
minLength: 1
11-
title: Text
12-
type: string
13-
required:
14-
- text
15-
title: EchoRequest
16-
type: object
17-
EchoResponse:
18-
description: Response model for echo endpoint.
19-
properties:
20-
message:
21-
description: The message content
22-
examples:
23-
- Hello, world!
24-
minLength: 1
25-
title: Message
26-
type: string
27-
required:
28-
- message
29-
title: EchoResponse
30-
type: object
31-
HTTPValidationError:
32-
properties:
33-
detail:
34-
items:
35-
$ref: '#/components/schemas/ValidationError'
36-
title: Detail
37-
type: array
38-
title: HTTPValidationError
39-
type: object
40-
Health:
41-
description: Health status model.
42-
properties:
43-
reason:
44-
anyOf:
45-
- type: string
46-
- type: 'null'
47-
title: Reason
48-
status:
49-
$ref: '#/components/schemas/_HealthStatus'
50-
required:
51-
- status
52-
title: Health
53-
type: object
54-
HelloWorldResponse:
55-
description: Response model for hello-world endpoint.
56-
properties:
57-
message:
58-
description: The hello world message
59-
examples:
60-
- Hello, world!
61-
title: Message
62-
type: string
63-
required:
64-
- message
65-
title: HelloWorldResponse
66-
type: object
67-
ValidationError:
68-
properties:
69-
loc:
70-
items:
71-
anyOf:
72-
- type: string
73-
- type: integer
74-
title: Location
75-
type: array
76-
msg:
77-
title: Message
78-
type: string
79-
type:
80-
title: Error Type
81-
type: string
82-
required:
83-
- loc
84-
- msg
85-
- type
86-
title: ValidationError
87-
type: object
88-
_HealthStatus:
89-
description: Health status enumeration.
90-
enum:
91-
- UP
92-
- DOWN
93-
title: _HealthStatus
94-
type: string
95-
info:
96-
contact:
97-
email: helmuthva@gmail.com
98-
name: Helmut Hoffer von Ankershoffen
99-
url: https://github.com/helmut-hoffer-von-ankershoffen
100-
termsOfService: https://oe-python-template-example.readthedocs.io/en/latest/
101-
title: OE Python Template Example
102-
version: 1.0.0
103-
openapi: 3.1.0
104-
paths:
105-
/echo:
106-
post:
107-
description: "Echo back the provided text.\n\nArgs:\n request
108-
(EchoRequest):\
109-
\ The request containing the text to echo back.\n\nReturns:\n
110-
EchoResponse:\
111-
\ A response containing the echoed text.\n\nRaises:\n 422
112-
Unprocessable\
113-
\ Entity: If text is not provided or empty."
114-
operationId: echo_echo_post
115-
requestBody:
116-
content:
117-
application/json:
118-
schema:
119-
$ref: '#/components/schemas/EchoRequest'
120-
required: true
121-
responses:
122-
'200':
123-
content:
124-
application/json:
125-
schema:
126-
$ref: '#/components/schemas/EchoResponse'
127-
description: Successful Response
128-
'422':
129-
content:
130-
application/json:
131-
schema:
132-
$ref: '#/components/schemas/HTTPValidationError'
133-
description: Validation Error
134-
summary: Echo
135-
tags:
136-
- Basics
137-
/health:
138-
get:
139-
description: "Check the health of the service.\n\nThis endpoint returns
140-
the\
141-
\ health status of the service.\nThe health status can be either UP or
142-
DOWN.\n\
143-
If the service is healthy, the status will be UP.\nIf the service is
144-
unhealthy,\
145-
\ the status will be DOWN and a reason will be provided.\nThe response
146-
will\
147-
\ have a 200 OK status code if the service is healthy,\nand a 500
148-
Internal\
149-
\ Server Error status code if the service is unhealthy.\n\nReturns:\n
150-
Health:\
151-
\ The health status of the service."
152-
operationId: health_health_get
153-
responses:
154-
'200':
155-
content:
156-
application/json:
157-
schema:
158-
$ref: '#/components/schemas/Health'
159-
description: Successful Response
160-
summary: Health
161-
tags:
162-
- Observability
163-
/healthz:
164-
get:
165-
description: "Check the health of the service.\n\nThis endpoint returns
166-
the\
167-
\ health status of the service.\nThe health status can be either UP or
168-
DOWN.\n\
169-
If the service is healthy, the status will be UP.\nIf the service is
170-
unhealthy,\
171-
\ the status will be DOWN and a reason will be provided.\nThe response
172-
will\
173-
\ have a 200 OK status code if the service is healthy,\nand a 500
174-
Internal\
175-
\ Server Error status code if the service is unhealthy.\n\nReturns:\n
176-
Health:\
177-
\ The health status of the service."
178-
operationId: health_healthz_get
179-
responses:
180-
'200':
181-
content:
182-
application/json:
183-
schema:
184-
$ref: '#/components/schemas/Health'
185-
description: Successful Response
186-
summary: Health
187-
tags:
188-
- Observability
189-
/hello-world:
190-
get:
191-
description: "Return a hello world message.\n\nReturns:\n
192-
HelloWorldResponse:\
193-
\ A response containing the hello world message."
194-
operationId: hello_world_hello_world_get
195-
responses:
196-
'200':
197-
content:
198-
application/json:
199-
schema:
200-
$ref: '#/components/schemas/HelloWorldResponse'
201-
description: Successful Response
202-
summary: Hello World
203-
tags:
204-
- Basics
1+
Traceback (most recent call last):
2+
File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/bin/oe-python-template-example", line 4, in <module>
3+
from oe_python_template_example.cli import cli
4+
File "/Users/helmut/Code/oe-python-template-example/src/oe_python_template_example/cli.py", line 13, in <module>
5+
from oe_python_template_example.api import api_v1, api_v2
6+
File "/Users/helmut/Code/oe-python-template-example/src/oe_python_template_example/api.py", line 16, in <module>
7+
from fastapi import Depends, FastAPI, Response, status
8+
File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/lib/python3.13/site-packages/fastapi/__init__.py", line 7, in <module>
9+
from .applications import FastAPI as FastAPI
10+
File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/lib/python3.13/site-packages/fastapi/applications.py", line 16, in <module>
11+
from fastapi import routing
12+
File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/lib/python3.13/site-packages/fastapi/routing.py", line 34, in <module>
13+
from fastapi.dependencies.models import Dependant
14+
File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/lib/python3.13/site-packages/fastapi/dependencies/models.py", line 5, in <module>
15+
from fastapi.security.base import SecurityBase
16+
File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/lib/python3.13/site-packages/fastapi/security/__init__.py", line 1, in <module>
17+
from .api_key import APIKeyCookie as APIKeyCookie
18+
File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/lib/python3.13/site-packages/fastapi/security/api_key.py", line 6, in <module>
19+
from starlette.requests import Request
20+
File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/lib/python3.13/site-packages/starlette/requests.py", line 12, in <module>
21+
from starlette.formparsers import FormParser, MultiPartException, MultiPartParser
22+
File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/lib/python3.13/site-packages/starlette/formparsers.py", line 17, in <module>
23+
import python_multipart as multipart
24+
File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/lib/python3.13/site-packages/python_multipart/__init__.py", line 7, in <module>
25+
from .multipart import (
26+
...<7 lines>...
27+
)
28+
File "<frozen importlib._bootstrap>", line 1360, in _find_and_load
29+
File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked
30+
File "<frozen importlib._bootstrap>", line 935, in _load_unlocked
31+
File "<frozen importlib._bootstrap_external>", line 1022, in exec_module
32+
File "<frozen importlib._bootstrap_external>", line 1155, in get_code
33+
File "<frozen importlib._bootstrap_external>", line 784, in _compile_bytecode
34+
KeyboardInterrupt

docs/source/_static/openapi_v2.yaml

Lines changed: 16 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -104,12 +104,9 @@ openapi: 3.1.0
104104
paths:
105105
/echo:
106106
post:
107-
description: "Echo back the provided utterance.\n\nArgs:\n request
108-
(Utterance):\
109-
\ The request containing the utterance to echo back.\n\nReturns:\n
110-
EchoResponse:\
111-
\ A response containing the echoed utterance.\n\nRaises:\n 422
112-
Unprocessable\
107+
description: "Echo back the provided utterance.\n\nArgs:\n request (Utterance):\
108+
\ The request containing the utterance to echo back.\n\nReturns:\n EchoResponse:\
109+
\ A response containing the echoed utterance.\n\nRaises:\n 422 Unprocessable\
113110
\ Entity: If utterance is not provided or empty."
114111
operationId: echo_v2_echo_post
115112
requestBody:
@@ -136,18 +133,12 @@ Unprocessable\
136133
- Basics
137134
/health:
138135
get:
139-
description: "Check the health of the service.\n\nThis endpoint returns
140-
the\
141-
\ health status of the service.\nThe health status can be either UP or
142-
DOWN.\n\
143-
If the service is healthy, the status will be UP.\nIf the service is
144-
unhealthy,\
145-
\ the status will be DOWN and a reason will be provided.\nThe response
146-
will\
147-
\ have a 200 OK status code if the service is healthy,\nand a 500
148-
Internal\
149-
\ Server Error status code if the service is unhealthy.\n\nReturns:\n
150-
Health:\
136+
description: "Check the health of the service.\n\nThis endpoint returns the\
137+
\ health status of the service.\nThe health status can be either UP or DOWN.\n\
138+
If the service is healthy, the status will be UP.\nIf the service is unhealthy,\
139+
\ the status will be DOWN and a reason will be provided.\nThe response will\
140+
\ have a 200 OK status code if the service is healthy,\nand a 500 Internal\
141+
\ Server Error status code if the service is unhealthy.\n\nReturns:\n Health:\
151142
\ The health status of the service."
152143
operationId: health_health_get
153144
responses:
@@ -162,18 +153,12 @@ Health:\
162153
- Observability
163154
/healthz:
164155
get:
165-
description: "Check the health of the service.\n\nThis endpoint returns
166-
the\
167-
\ health status of the service.\nThe health status can be either UP or
168-
DOWN.\n\
169-
If the service is healthy, the status will be UP.\nIf the service is
170-
unhealthy,\
171-
\ the status will be DOWN and a reason will be provided.\nThe response
172-
will\
173-
\ have a 200 OK status code if the service is healthy,\nand a 500
174-
Internal\
175-
\ Server Error status code if the service is unhealthy.\n\nReturns:\n
176-
Health:\
156+
description: "Check the health of the service.\n\nThis endpoint returns the\
157+
\ health status of the service.\nThe health status can be either UP or DOWN.\n\
158+
If the service is healthy, the status will be UP.\nIf the service is unhealthy,\
159+
\ the status will be DOWN and a reason will be provided.\nThe response will\
160+
\ have a 200 OK status code if the service is healthy,\nand a 500 Internal\
161+
\ Server Error status code if the service is unhealthy.\n\nReturns:\n Health:\
177162
\ The health status of the service."
178163
operationId: health_healthz_get
179164
responses:
@@ -188,8 +173,7 @@ Health:\
188173
- Observability
189174
/hello-world:
190175
get:
191-
description: "Return a hello world message.\n\nReturns:\n
192-
HelloWorldResponse:\
176+
description: "Return a hello world message.\n\nReturns:\n HelloWorldResponse:\
193177
\ A response containing the hello world message."
194178
operationId: hello_world_hello_world_get
195179
responses:

src/oe_python_template_example/api.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818

1919
from oe_python_template_example import Service
2020

21+
TITLE = "OE Python Template Example"
2122
HELLO_WORLD_EXAMPLE = "Hello, world!"
2223
UVICORN_HOST = os.environ.get("UVICORN_HOST", "127.0.0.1")
2324
UVICORN_PORT = os.environ.get("UVICORN_PORT", "8000")
@@ -43,7 +44,7 @@ def get_service() -> Generator[Service, None, None]:
4344

4445
api = FastAPI(
4546
root_path="/api",
46-
title="OE Python Template Example",
47+
title=TITLE,
4748
contact={
4849
"name": CONTACT_NAME,
4950
"email": CONTACT_EMAIL,
@@ -72,7 +73,7 @@ def get_service() -> Generator[Service, None, None]:
7273

7374
api_v1 = FastAPI(
7475
version="1.0.0",
75-
title="OE Python Template Example",
76+
title=TITLE,
7677
contact={
7778
"name": CONTACT_NAME,
7879
"email": CONTACT_EMAIL,
@@ -83,7 +84,7 @@ def get_service() -> Generator[Service, None, None]:
8384

8485
api_v2 = FastAPI(
8586
version="2.0.0",
86-
title="OE Python Template Example",
87+
title=TITLE,
8788
contact={
8889
"name": CONTACT_NAME,
8990
"email": CONTACT_EMAIL,

0 commit comments

Comments
 (0)