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
|
%global _empty_manifest_terminate_build 0
Name: python-fastapi-offline
Version: 1.5.3
Release: 1
Summary: FastAPI without reliance on CDNs for docs
License: MIT
URL: https://github.com/turettn/fastapi_offline
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/83/2f/ca78208f99e06918b707333e0625c7485bea8be52ea1d057a08b0094b7d6/fastapi_offline-1.5.3.linux-x86_64.tar.gz
BuildArch: noarch
Requires: python3-fastapi
Requires: python3-pytest
Requires: python3-requests
Requires: python3-starlette[full]
%description
# Overview
[](https://pypi.python.org/pypi/fastapi-offline/)
[](https://github.com/turettn/fastapi_offline/actions/workflows/test.yml)
[](https://codecov.io/gh/turettn/fastapi_offline)
[FastAPI](https://fastapi.tiangolo.com/) is awesome, but the documentation pages (Swagger or Redoc) all depend on external CDNs, which is problematic if you want to run on disconnected networks.
This package includes the required files from the CDN and serves them locally. It also provides a super-simple way to get a FastAPI instance configured to use those files.
Under the hood, this simply automates the process described in the official documentation [here](https://fastapi.tiangolo.com/advanced/extending-openapi/#self-hosting-javascript-and-css-for-docs).
# Installation
You can install this package from PyPi:
```bash
pip install fastapi-offline
```
# Example
Given the example from the [FastAPI tutorial](https://fastapi.tiangolo.com/tutorial/first-steps/):
```python
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello World"}
```
Simply create a `fastapi_offline.FastAPIOffline` object instead:
```python
from fastapi_offline import FastAPIOffline
app = FastAPIOffline()
@app.get("/")
async def root():
return {"message": "Hello World"}
```
Any options passed to `FastAPIOffline()` except `docs_url`, `redoc_url`, `favicon_url`, and `static_url` are passed through to `FastAPI()`. `docs_url` and `redoc_url` are handled by `fastapi-offline`, and use the same syntax as normal `fastapi` library.
`static_url` can be used to set the path for the static js/css files, e.g. `static_url=/static-files` (default: `/static-offline-docs`).
# Using a custom shortcut icon
By default, the FastAPI `favicon.png` is included and used as the shortcut icon on the docs pages. If you want to use a different one, you can specify it with the `favicon_url` argument:
```py
app = FastAPIOffline(
favicon_url="http://my.cool.site/favicon.png"
)
```
# Licensing
* This code is released under the MIT license.
* Parts of Swagger are included in this package. The original license ([Apache 2.0](https://swagger.io/license/)) and copyright apply to those files.
* Parts of Redoc are included in this package. The original license ([MIT](https://github.com/Redocly/redoc/blob/master/LICENSE)) and copyright apply to those files.
* The FastAPI `favicon.png` file is included in this package. The original license ([MIT](https://github.com/Redocly/redoc/blob/master/LICENSE)) and copyright apply to that file.
%package -n python3-fastapi-offline
Summary: FastAPI without reliance on CDNs for docs
Provides: python-fastapi-offline
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-fastapi-offline
# Overview
[](https://pypi.python.org/pypi/fastapi-offline/)
[](https://github.com/turettn/fastapi_offline/actions/workflows/test.yml)
[](https://codecov.io/gh/turettn/fastapi_offline)
[FastAPI](https://fastapi.tiangolo.com/) is awesome, but the documentation pages (Swagger or Redoc) all depend on external CDNs, which is problematic if you want to run on disconnected networks.
This package includes the required files from the CDN and serves them locally. It also provides a super-simple way to get a FastAPI instance configured to use those files.
Under the hood, this simply automates the process described in the official documentation [here](https://fastapi.tiangolo.com/advanced/extending-openapi/#self-hosting-javascript-and-css-for-docs).
# Installation
You can install this package from PyPi:
```bash
pip install fastapi-offline
```
# Example
Given the example from the [FastAPI tutorial](https://fastapi.tiangolo.com/tutorial/first-steps/):
```python
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello World"}
```
Simply create a `fastapi_offline.FastAPIOffline` object instead:
```python
from fastapi_offline import FastAPIOffline
app = FastAPIOffline()
@app.get("/")
async def root():
return {"message": "Hello World"}
```
Any options passed to `FastAPIOffline()` except `docs_url`, `redoc_url`, `favicon_url`, and `static_url` are passed through to `FastAPI()`. `docs_url` and `redoc_url` are handled by `fastapi-offline`, and use the same syntax as normal `fastapi` library.
`static_url` can be used to set the path for the static js/css files, e.g. `static_url=/static-files` (default: `/static-offline-docs`).
# Using a custom shortcut icon
By default, the FastAPI `favicon.png` is included and used as the shortcut icon on the docs pages. If you want to use a different one, you can specify it with the `favicon_url` argument:
```py
app = FastAPIOffline(
favicon_url="http://my.cool.site/favicon.png"
)
```
# Licensing
* This code is released under the MIT license.
* Parts of Swagger are included in this package. The original license ([Apache 2.0](https://swagger.io/license/)) and copyright apply to those files.
* Parts of Redoc are included in this package. The original license ([MIT](https://github.com/Redocly/redoc/blob/master/LICENSE)) and copyright apply to those files.
* The FastAPI `favicon.png` file is included in this package. The original license ([MIT](https://github.com/Redocly/redoc/blob/master/LICENSE)) and copyright apply to that file.
%package help
Summary: Development documents and examples for fastapi-offline
Provides: python3-fastapi-offline-doc
%description help
# Overview
[](https://pypi.python.org/pypi/fastapi-offline/)
[](https://github.com/turettn/fastapi_offline/actions/workflows/test.yml)
[](https://codecov.io/gh/turettn/fastapi_offline)
[FastAPI](https://fastapi.tiangolo.com/) is awesome, but the documentation pages (Swagger or Redoc) all depend on external CDNs, which is problematic if you want to run on disconnected networks.
This package includes the required files from the CDN and serves them locally. It also provides a super-simple way to get a FastAPI instance configured to use those files.
Under the hood, this simply automates the process described in the official documentation [here](https://fastapi.tiangolo.com/advanced/extending-openapi/#self-hosting-javascript-and-css-for-docs).
# Installation
You can install this package from PyPi:
```bash
pip install fastapi-offline
```
# Example
Given the example from the [FastAPI tutorial](https://fastapi.tiangolo.com/tutorial/first-steps/):
```python
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello World"}
```
Simply create a `fastapi_offline.FastAPIOffline` object instead:
```python
from fastapi_offline import FastAPIOffline
app = FastAPIOffline()
@app.get("/")
async def root():
return {"message": "Hello World"}
```
Any options passed to `FastAPIOffline()` except `docs_url`, `redoc_url`, `favicon_url`, and `static_url` are passed through to `FastAPI()`. `docs_url` and `redoc_url` are handled by `fastapi-offline`, and use the same syntax as normal `fastapi` library.
`static_url` can be used to set the path for the static js/css files, e.g. `static_url=/static-files` (default: `/static-offline-docs`).
# Using a custom shortcut icon
By default, the FastAPI `favicon.png` is included and used as the shortcut icon on the docs pages. If you want to use a different one, you can specify it with the `favicon_url` argument:
```py
app = FastAPIOffline(
favicon_url="http://my.cool.site/favicon.png"
)
```
# Licensing
* This code is released under the MIT license.
* Parts of Swagger are included in this package. The original license ([Apache 2.0](https://swagger.io/license/)) and copyright apply to those files.
* Parts of Redoc are included in this package. The original license ([MIT](https://github.com/Redocly/redoc/blob/master/LICENSE)) and copyright apply to those files.
* The FastAPI `favicon.png` file is included in this package. The original license ([MIT](https://github.com/Redocly/redoc/blob/master/LICENSE)) and copyright apply to that file.
%prep
%autosetup -n fastapi-offline-1.5.3
%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-fastapi-offline -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue May 30 2023 Python_Bot <Python_Bot@openeuler.org> - 1.5.3-1
- Package Spec generated
|
