fastapi-easy-responses 0.2.0__tar.gz → 0.2.2__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.
@@ -1,10 +1,10 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: fastapi-easy-responses
3
- Version: 0.2.0
3
+ Version: 0.2.2
4
4
  Summary: A simple package to easily handle and document all HTTP exceptions and other errors in a FastAPI app.
5
5
  Author: Bod Zol
6
6
  Author-email: Bod Zol <5642056+bod-zol@users.noreply.github.com>
7
- Requires-Dist: fastapi[standard]>=0.126.0,<0.200.0
7
+ Requires-Dist: fastapi>=0.126.0,<0.200.0
8
8
  Requires-Python: >=3.10
9
9
  Project-URL: Homepage, https://github.com/bod-zol/fastapi-easy-responses
10
10
  Project-URL: Repository, https://github.com/bod-zol/fastapi-easy-responses
@@ -78,11 +78,19 @@ This package doesn't introduce new response schemas or custom error codes, so ad
78
78
 
79
79
  If you open the documentation, you'll see the following:
80
80
 
81
- ![Documentation sample](./docs/sample-doc.png)
81
+ <img
82
+ src="https://raw.githubusercontent.com/bod-zol/fastapi-easy-responses/refs/heads/master/docs/sample-doc.png"
83
+ alt="Documentation sample"
84
+ style="width: 500px; max-width: 100%;"
85
+ />
82
86
 
83
87
  And if you try it out, you'll see the actual response matches the documentation as expected:
84
88
 
85
- ![Response sample](./docs/sample-response.png)
89
+ <img
90
+ src="https://raw.githubusercontent.com/bod-zol/fastapi-easy-responses/refs/heads/master/docs/sample-response.png"
91
+ alt="Response sample"
92
+ style="width: 500px; max-width: 100%;"
93
+ />
86
94
 
87
95
  ### Dynamic detail
88
96
 
@@ -111,11 +119,19 @@ raise ItemNotFoundError(123)
111
119
 
112
120
  In this case, the documentation will still show the static description:
113
121
 
114
- ![Documentation sample](./docs/sample-dynamic-doc.png)
122
+ <img
123
+ src="https://raw.githubusercontent.com/bod-zol/fastapi-easy-responses/refs/heads/master/docs/sample-dynamic-doc.png"
124
+ alt="Documentation sample"
125
+ style="width: 500px; max-width: 100%;"
126
+ />
115
127
 
116
128
  But the actual response will contain the dynamic detail:
117
129
 
118
- ![Response sample](./docs/sample-dynamic-response.png)
130
+ <img
131
+ src="https://raw.githubusercontent.com/bod-zol/fastapi-easy-responses/refs/heads/master/docs/sample-dynamic-response.png"
132
+ alt="Response sample"
133
+ style="width: 500px; max-width: 100%;"
134
+ />
119
135
 
120
136
  ### Headers
121
137
 
@@ -148,11 +164,19 @@ raise UnauthorizedError()
148
164
 
149
165
  In this case, the documentation will show the given header descriptions:
150
166
 
151
- ![Documentation sample](./docs/sample-header-doc.png)
167
+ <img
168
+ src="https://raw.githubusercontent.com/bod-zol/fastapi-easy-responses/refs/heads/master/docs/sample-header-doc.png"
169
+ alt="Documentation sample"
170
+ style="width: 500px; max-width: 100%;"
171
+ />
152
172
 
153
173
  And the actual response will contain the given headers:
154
174
 
155
- ![Response sample](./docs/sample-header-response.png)
175
+ <img
176
+ src="https://raw.githubusercontent.com/bod-zol/fastapi-easy-responses/refs/heads/master/docs/sample-header-response.png"
177
+ alt="Response sample"
178
+ style="width: 500px; max-width: 100%;"
179
+ />
156
180
 
157
181
  ## Why
158
182
 
@@ -66,11 +66,19 @@ This package doesn't introduce new response schemas or custom error codes, so ad
66
66
 
67
67
  If you open the documentation, you'll see the following:
68
68
 
69
- ![Documentation sample](./docs/sample-doc.png)
69
+ <img
70
+ src="https://raw.githubusercontent.com/bod-zol/fastapi-easy-responses/refs/heads/master/docs/sample-doc.png"
71
+ alt="Documentation sample"
72
+ style="width: 500px; max-width: 100%;"
73
+ />
70
74
 
71
75
  And if you try it out, you'll see the actual response matches the documentation as expected:
72
76
 
73
- ![Response sample](./docs/sample-response.png)
77
+ <img
78
+ src="https://raw.githubusercontent.com/bod-zol/fastapi-easy-responses/refs/heads/master/docs/sample-response.png"
79
+ alt="Response sample"
80
+ style="width: 500px; max-width: 100%;"
81
+ />
74
82
 
75
83
  ### Dynamic detail
76
84
 
@@ -99,11 +107,19 @@ raise ItemNotFoundError(123)
99
107
 
100
108
  In this case, the documentation will still show the static description:
101
109
 
102
- ![Documentation sample](./docs/sample-dynamic-doc.png)
110
+ <img
111
+ src="https://raw.githubusercontent.com/bod-zol/fastapi-easy-responses/refs/heads/master/docs/sample-dynamic-doc.png"
112
+ alt="Documentation sample"
113
+ style="width: 500px; max-width: 100%;"
114
+ />
103
115
 
104
116
  But the actual response will contain the dynamic detail:
105
117
 
106
- ![Response sample](./docs/sample-dynamic-response.png)
118
+ <img
119
+ src="https://raw.githubusercontent.com/bod-zol/fastapi-easy-responses/refs/heads/master/docs/sample-dynamic-response.png"
120
+ alt="Response sample"
121
+ style="width: 500px; max-width: 100%;"
122
+ />
107
123
 
108
124
  ### Headers
109
125
 
@@ -136,11 +152,19 @@ raise UnauthorizedError()
136
152
 
137
153
  In this case, the documentation will show the given header descriptions:
138
154
 
139
- ![Documentation sample](./docs/sample-header-doc.png)
155
+ <img
156
+ src="https://raw.githubusercontent.com/bod-zol/fastapi-easy-responses/refs/heads/master/docs/sample-header-doc.png"
157
+ alt="Documentation sample"
158
+ style="width: 500px; max-width: 100%;"
159
+ />
140
160
 
141
161
  And the actual response will contain the given headers:
142
162
 
143
- ![Response sample](./docs/sample-header-response.png)
163
+ <img
164
+ src="https://raw.githubusercontent.com/bod-zol/fastapi-easy-responses/refs/heads/master/docs/sample-header-response.png"
165
+ alt="Response sample"
166
+ style="width: 500px; max-width: 100%;"
167
+ />
144
168
 
145
169
  ## Why
146
170
 
@@ -0,0 +1,44 @@
1
+ [project]
2
+ name = "fastapi-easy-responses"
3
+ version = "0.2.2"
4
+ description = "A simple package to easily handle and document all HTTP exceptions and other errors in a FastAPI app."
5
+ readme = "README.md"
6
+ requires-python = ">=3.10"
7
+ dependencies = ["fastapi>=0.126.0,<0.200.0"]
8
+
9
+ [[project.authors]]
10
+ name = "Bod Zol"
11
+ email = "5642056+bod-zol@users.noreply.github.com"
12
+
13
+ [project.urls]
14
+ Homepage = "https://github.com/bod-zol/fastapi-easy-responses"
15
+ Repository = "https://github.com/bod-zol/fastapi-easy-responses"
16
+
17
+ [build-system]
18
+ requires = ["uv_build>=0.11.14,<0.12.0"]
19
+ build-backend = "uv_build"
20
+
21
+ [tool.pytest]
22
+ filterwarnings = ["error"]
23
+
24
+ [tool.ruff.lint]
25
+ select = [
26
+ "E",
27
+ "W",
28
+ "F",
29
+ "FAST",
30
+ "I",
31
+ "B",
32
+ "C4",
33
+ "UP",
34
+ ]
35
+
36
+ [dependency-groups]
37
+ dev = [
38
+ "httpx>=0.28.1",
39
+ "httpx2>=2.4.0",
40
+ "pre-commit>=4.6.0",
41
+ "pytest>=9.0.3",
42
+ "pytest-cov>=7.1.0",
43
+ "ruff>=0.15.12",
44
+ ]
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "fastapi-easy-responses"
3
- version = "0.2.0"
3
+ version = "0.2.2"
4
4
  description = "A simple package to easily handle and document all HTTP exceptions and other errors in a FastAPI app."
5
5
  readme = "README.md"
6
6
  authors = [
@@ -8,7 +8,7 @@ authors = [
8
8
  ]
9
9
  requires-python = ">=3.10"
10
10
  dependencies = [
11
- "fastapi[standard]>=0.126.0,<0.200.0",
11
+ "fastapi>=0.126.0,<0.200.0",
12
12
  ]
13
13
 
14
14
  [project.urls]
@@ -36,6 +36,7 @@ select = [
36
36
 
37
37
  [dependency-groups]
38
38
  dev = [
39
+ "httpx>=0.28.1",
39
40
  "httpx2>=2.4.0",
40
41
  "pre-commit>=4.6.0",
41
42
  "pytest>=9.0.3",