summaryrefslogtreecommitdiff
path: root/python-schema-validator.spec
blob: e9c35644032ec197a939a4a542b87ff7507a07bd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
%global _empty_manifest_terminate_build 0
Name:		python-schema-validator
Version:	0.2.5
Release:	1
Summary:	A flask/quart extension to provide schema validation with pydantic.
License:	MIT
URL:		https://github.com/huangxiaohen2738/schema-validator
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/57/ab/fdaca277af898bb228e9e228a639bc8df2649814b67a0bdff9f223bd1bf0/schema_validator-0.2.5.tar.gz
BuildArch:	noarch

Requires:	python3-pyhumps
Requires:	python3-pydantic

%description
#### Generate from quart-schema
### Install
 - `pip install schema-validator`
<details>
<summary>How to use</summary>
```
    from dataclasses import dataclass
    from datetime import datetime
    from typing import Optional
    from pydantic import BaseModel
    from flask import Flask
    from quart import Quart
    from schema_validator import SchemaValidator
    from schema_validator.flask import validate
    # from schema_validator.quart import validate
    app = Flask(__name__)
    # or 
    app = Quart(__name__)
    OR
    schema = SchemaValidator(app)
    schema.init_app(app)
    @dataclass
    class Todo:
        task: str
        due: Optional[datetime]
    class TodoResponse(BaseModel):
        id: int
        name: str
    @app.post("/")
    @validate(body=Todo, responses=TodoResponse)
    def create_todo():
        # balabala
        return dict(id=1, name="2")
    @app.get("/")
    @validate(
        query=Todo,
        responses={200: TodoResponse, 400: TodoResponse}
    )
    def update_todo():
        # balabala
        return TodoResponse(id=1, name="123")
    @app.delete("/")
    @validate(
        body=Todo,
        responses={200: TodoResponse}
    )
    def delete():
        # balabala
        return jsonify(id=1)
    @tags("SOME-TAG", "OTHER-TAG")  # only for swagger
    class View(MethodView):
        @validate(...)
        def get(self):
            return {}
```
</details>
<details>
<summary>How to show the swagger </summary>
```
app.config["SWAGGER_ROUTE"] = True
http://yourhost/swagger/docs   -> show the all swagger
http://yourhost/swagger/docs/{tag} -> show the swagger which include tag
```
</details>
<details>
<summary>How to export the swagger </summary>
```
add command in flask/quart:
    app.cli.add_command(generate_schema_command)
Export all swagger to json file:
 - flask/quart schema -o swagger.json
Export the swagger which include the ACCOUNT tag:
 - flask/quart schema -o swagger.json -t ACCOUNT
```
</details>

%package -n python3-schema-validator
Summary:	A flask/quart extension to provide schema validation with pydantic.
Provides:	python-schema-validator
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-schema-validator
#### Generate from quart-schema
### Install
 - `pip install schema-validator`
<details>
<summary>How to use</summary>
```
    from dataclasses import dataclass
    from datetime import datetime
    from typing import Optional
    from pydantic import BaseModel
    from flask import Flask
    from quart import Quart
    from schema_validator import SchemaValidator
    from schema_validator.flask import validate
    # from schema_validator.quart import validate
    app = Flask(__name__)
    # or 
    app = Quart(__name__)
    OR
    schema = SchemaValidator(app)
    schema.init_app(app)
    @dataclass
    class Todo:
        task: str
        due: Optional[datetime]
    class TodoResponse(BaseModel):
        id: int
        name: str
    @app.post("/")
    @validate(body=Todo, responses=TodoResponse)
    def create_todo():
        # balabala
        return dict(id=1, name="2")
    @app.get("/")
    @validate(
        query=Todo,
        responses={200: TodoResponse, 400: TodoResponse}
    )
    def update_todo():
        # balabala
        return TodoResponse(id=1, name="123")
    @app.delete("/")
    @validate(
        body=Todo,
        responses={200: TodoResponse}
    )
    def delete():
        # balabala
        return jsonify(id=1)
    @tags("SOME-TAG", "OTHER-TAG")  # only for swagger
    class View(MethodView):
        @validate(...)
        def get(self):
            return {}
```
</details>
<details>
<summary>How to show the swagger </summary>
```
app.config["SWAGGER_ROUTE"] = True
http://yourhost/swagger/docs   -> show the all swagger
http://yourhost/swagger/docs/{tag} -> show the swagger which include tag
```
</details>
<details>
<summary>How to export the swagger </summary>
```
add command in flask/quart:
    app.cli.add_command(generate_schema_command)
Export all swagger to json file:
 - flask/quart schema -o swagger.json
Export the swagger which include the ACCOUNT tag:
 - flask/quart schema -o swagger.json -t ACCOUNT
```
</details>

%package help
Summary:	Development documents and examples for schema-validator
Provides:	python3-schema-validator-doc
%description help
#### Generate from quart-schema
### Install
 - `pip install schema-validator`
<details>
<summary>How to use</summary>
```
    from dataclasses import dataclass
    from datetime import datetime
    from typing import Optional
    from pydantic import BaseModel
    from flask import Flask
    from quart import Quart
    from schema_validator import SchemaValidator
    from schema_validator.flask import validate
    # from schema_validator.quart import validate
    app = Flask(__name__)
    # or 
    app = Quart(__name__)
    OR
    schema = SchemaValidator(app)
    schema.init_app(app)
    @dataclass
    class Todo:
        task: str
        due: Optional[datetime]
    class TodoResponse(BaseModel):
        id: int
        name: str
    @app.post("/")
    @validate(body=Todo, responses=TodoResponse)
    def create_todo():
        # balabala
        return dict(id=1, name="2")
    @app.get("/")
    @validate(
        query=Todo,
        responses={200: TodoResponse, 400: TodoResponse}
    )
    def update_todo():
        # balabala
        return TodoResponse(id=1, name="123")
    @app.delete("/")
    @validate(
        body=Todo,
        responses={200: TodoResponse}
    )
    def delete():
        # balabala
        return jsonify(id=1)
    @tags("SOME-TAG", "OTHER-TAG")  # only for swagger
    class View(MethodView):
        @validate(...)
        def get(self):
            return {}
```
</details>
<details>
<summary>How to show the swagger </summary>
```
app.config["SWAGGER_ROUTE"] = True
http://yourhost/swagger/docs   -> show the all swagger
http://yourhost/swagger/docs/{tag} -> show the swagger which include tag
```
</details>
<details>
<summary>How to export the swagger </summary>
```
add command in flask/quart:
    app.cli.add_command(generate_schema_command)
Export all swagger to json file:
 - flask/quart schema -o swagger.json
Export the swagger which include the ACCOUNT tag:
 - flask/quart schema -o swagger.json -t ACCOUNT
```
</details>

%prep
%autosetup -n schema-validator-0.2.5

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-schema-validator -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Tue May 30 2023 Python_Bot <Python_Bot@openeuler.org> - 0.2.5-1
- Package Spec generated