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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
|
%global _empty_manifest_terminate_build 0
Name: python-saucenao-api
Version: 2.4.0
Release: 1
Summary: Wrapper for SauceNAO JSON API
License: GNU General Public License v3 (GPLv3)
URL: https://github.com/nomnoms12/saucenao_api/
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/cf/4c/3967f981ea2595734e03ca29f4beb3beaf155d53cffd4799cc053dd8e3dd/saucenao_api-2.4.0.tar.gz
BuildArch: noarch
Requires: python3-requests
Requires: python3-aiohttp
Requires: python3-responses
Requires: python3-aioresponses
Requires: python3-pytest
Requires: python3-pytest-cov
%description
# saucenao_api
[](https://github.com/nomnoms12/saucenao_api/actions?query=workflow%3ATests)
[](https://codecov.io/gh/nomnoms12/saucenao_api)
[](https://github.com/nomnoms12/saucenao_api/blob/master/LICENSE)
[](https://saucenao.com)
[](https://pypi.org/project/saucenao-api)
> “The rough edges are a part of its charm”
Unofficial wrapper for the [SauceNAO](https://saucenao.com) JSON API
# Installation
This package requires Python 3.6 or later.
```
pip install -U saucenao_api
```
# Usage
```python
from saucenao_api import SauceNao
# Replace the key with your own
sauce = SauceNao('077f16b38a2452401790540f41246c7d951330c0')
results = sauce.from_url('https://i.imgur.com/oZjCxGo.jpg') # or from_file()
best = results[0] # results sorted by similarity
```
The library attempts to provide a developer friendly container format for all results. Meaning, no matter if SauceNao returns a Pixiv source result or a more obscure source, you'll be able to easily pull the `title`, `urls`, `author` and other useful information:
```python
from saucenao_api import SauceNao
results = SauceNao('077f16b38a2452401790540f41246c7d951330c0').from_url('https://i.imgur.com/oZjCxGo.jpg')
len(results) # 6
bool(results) # True
# Request limits
results.short_remaining # 4 (per 30 seconds limit)
results.long_remaining # 99 (per day limit)
results[0].thumbnail # temporary URL for picture preview
results[0].similarity # 93.3
results[0].title # めぐみん
results[0].urls # ['https://www.pixiv.net/member_illust.php?mode=medium&illust_id=77630170']
results[0].author # frgs
results[0].raw # raw result
```
Video search results and book search results provide additional attributes:
```python
from saucenao_api import SauceNao, VideoSauce, BookSauce
result = SauceNao('077f16b38a2452401790540f41246c7d951330c0').from_url('https://i.imgur.com/k9xlw6f.jpg')[0]
if isinstance(result, VideoSauce):
result.part # 02
result.year # 2009-2009
result.est_time # 00:05:32 / 00:21:10
elif isinstance(result, BookSauce):
result.part
```
*You can use the `dir` function to see all the attributes.*
## Asyncio
```python
import asyncio
from saucenao_api import AIOSauceNao
async def main():
# async requesting is also supported via the AIOSauceNao class
async with AIOSauceNao('077f16b38a2452401790540f41246c7d951330c0') as aio:
results = await aio.from_url('https://i.imgur.com/k9xlw6f.jpg')
asyncio.run(main())
```
The async with functionality is pretty useful if you want to make multiple requests.
Note that you can still search without the `async with` syntax by simply calling `await AIOSauceNao(...).from_url(...)`.
## Advanced usage
```python
from saucenao_api import SauceNao
from saucenao_api.params import DB, Hide, BgColor
sauce = SauceNao(api_key=None, # Optional[str]
testmode=0, # int
dbmask=None, # Optional[int]
dbmaski=None, # Optional[int]
db=DB.ALL, # int
numres=6, # int
frame=1, # int
hide=Hide.NONE, # int
bgcolor=BgColor.NONE, # int
)
```
The parameters `frame`, `hide` and `bgcolor` are taken from the main page and from the [testing page](https://saucenao.com/testing), so their performance is not guaranteed. For the rest see [SauceNAO User Config](https://saucenao.com/user.php?page=search-api) page (registration required).
### Exceptions
All exceptions inherit from `SauceNaoApiError` for easy catching and handling. See [`errors.py`](saucenao_api/errors.py) file for details.
*Note: SauceNao doesn't have good documentation. Exceptions are created only based on observations of changes in the returned status codes. If you find a specific error that is not being processed, please report it.*
# License
This package is based on [`pysaucenao`](https://github.com/FujiMakoto/pysaucenao).
%package -n python3-saucenao-api
Summary: Wrapper for SauceNAO JSON API
Provides: python-saucenao-api
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-saucenao-api
# saucenao_api
[](https://github.com/nomnoms12/saucenao_api/actions?query=workflow%3ATests)
[](https://codecov.io/gh/nomnoms12/saucenao_api)
[](https://github.com/nomnoms12/saucenao_api/blob/master/LICENSE)
[](https://saucenao.com)
[](https://pypi.org/project/saucenao-api)
> “The rough edges are a part of its charm”
Unofficial wrapper for the [SauceNAO](https://saucenao.com) JSON API
# Installation
This package requires Python 3.6 or later.
```
pip install -U saucenao_api
```
# Usage
```python
from saucenao_api import SauceNao
# Replace the key with your own
sauce = SauceNao('077f16b38a2452401790540f41246c7d951330c0')
results = sauce.from_url('https://i.imgur.com/oZjCxGo.jpg') # or from_file()
best = results[0] # results sorted by similarity
```
The library attempts to provide a developer friendly container format for all results. Meaning, no matter if SauceNao returns a Pixiv source result or a more obscure source, you'll be able to easily pull the `title`, `urls`, `author` and other useful information:
```python
from saucenao_api import SauceNao
results = SauceNao('077f16b38a2452401790540f41246c7d951330c0').from_url('https://i.imgur.com/oZjCxGo.jpg')
len(results) # 6
bool(results) # True
# Request limits
results.short_remaining # 4 (per 30 seconds limit)
results.long_remaining # 99 (per day limit)
results[0].thumbnail # temporary URL for picture preview
results[0].similarity # 93.3
results[0].title # めぐみん
results[0].urls # ['https://www.pixiv.net/member_illust.php?mode=medium&illust_id=77630170']
results[0].author # frgs
results[0].raw # raw result
```
Video search results and book search results provide additional attributes:
```python
from saucenao_api import SauceNao, VideoSauce, BookSauce
result = SauceNao('077f16b38a2452401790540f41246c7d951330c0').from_url('https://i.imgur.com/k9xlw6f.jpg')[0]
if isinstance(result, VideoSauce):
result.part # 02
result.year # 2009-2009
result.est_time # 00:05:32 / 00:21:10
elif isinstance(result, BookSauce):
result.part
```
*You can use the `dir` function to see all the attributes.*
## Asyncio
```python
import asyncio
from saucenao_api import AIOSauceNao
async def main():
# async requesting is also supported via the AIOSauceNao class
async with AIOSauceNao('077f16b38a2452401790540f41246c7d951330c0') as aio:
results = await aio.from_url('https://i.imgur.com/k9xlw6f.jpg')
asyncio.run(main())
```
The async with functionality is pretty useful if you want to make multiple requests.
Note that you can still search without the `async with` syntax by simply calling `await AIOSauceNao(...).from_url(...)`.
## Advanced usage
```python
from saucenao_api import SauceNao
from saucenao_api.params import DB, Hide, BgColor
sauce = SauceNao(api_key=None, # Optional[str]
testmode=0, # int
dbmask=None, # Optional[int]
dbmaski=None, # Optional[int]
db=DB.ALL, # int
numres=6, # int
frame=1, # int
hide=Hide.NONE, # int
bgcolor=BgColor.NONE, # int
)
```
The parameters `frame`, `hide` and `bgcolor` are taken from the main page and from the [testing page](https://saucenao.com/testing), so their performance is not guaranteed. For the rest see [SauceNAO User Config](https://saucenao.com/user.php?page=search-api) page (registration required).
### Exceptions
All exceptions inherit from `SauceNaoApiError` for easy catching and handling. See [`errors.py`](saucenao_api/errors.py) file for details.
*Note: SauceNao doesn't have good documentation. Exceptions are created only based on observations of changes in the returned status codes. If you find a specific error that is not being processed, please report it.*
# License
This package is based on [`pysaucenao`](https://github.com/FujiMakoto/pysaucenao).
%package help
Summary: Development documents and examples for saucenao-api
Provides: python3-saucenao-api-doc
%description help
# saucenao_api
[](https://github.com/nomnoms12/saucenao_api/actions?query=workflow%3ATests)
[](https://codecov.io/gh/nomnoms12/saucenao_api)
[](https://github.com/nomnoms12/saucenao_api/blob/master/LICENSE)
[](https://saucenao.com)
[](https://pypi.org/project/saucenao-api)
> “The rough edges are a part of its charm”
Unofficial wrapper for the [SauceNAO](https://saucenao.com) JSON API
# Installation
This package requires Python 3.6 or later.
```
pip install -U saucenao_api
```
# Usage
```python
from saucenao_api import SauceNao
# Replace the key with your own
sauce = SauceNao('077f16b38a2452401790540f41246c7d951330c0')
results = sauce.from_url('https://i.imgur.com/oZjCxGo.jpg') # or from_file()
best = results[0] # results sorted by similarity
```
The library attempts to provide a developer friendly container format for all results. Meaning, no matter if SauceNao returns a Pixiv source result or a more obscure source, you'll be able to easily pull the `title`, `urls`, `author` and other useful information:
```python
from saucenao_api import SauceNao
results = SauceNao('077f16b38a2452401790540f41246c7d951330c0').from_url('https://i.imgur.com/oZjCxGo.jpg')
len(results) # 6
bool(results) # True
# Request limits
results.short_remaining # 4 (per 30 seconds limit)
results.long_remaining # 99 (per day limit)
results[0].thumbnail # temporary URL for picture preview
results[0].similarity # 93.3
results[0].title # めぐみん
results[0].urls # ['https://www.pixiv.net/member_illust.php?mode=medium&illust_id=77630170']
results[0].author # frgs
results[0].raw # raw result
```
Video search results and book search results provide additional attributes:
```python
from saucenao_api import SauceNao, VideoSauce, BookSauce
result = SauceNao('077f16b38a2452401790540f41246c7d951330c0').from_url('https://i.imgur.com/k9xlw6f.jpg')[0]
if isinstance(result, VideoSauce):
result.part # 02
result.year # 2009-2009
result.est_time # 00:05:32 / 00:21:10
elif isinstance(result, BookSauce):
result.part
```
*You can use the `dir` function to see all the attributes.*
## Asyncio
```python
import asyncio
from saucenao_api import AIOSauceNao
async def main():
# async requesting is also supported via the AIOSauceNao class
async with AIOSauceNao('077f16b38a2452401790540f41246c7d951330c0') as aio:
results = await aio.from_url('https://i.imgur.com/k9xlw6f.jpg')
asyncio.run(main())
```
The async with functionality is pretty useful if you want to make multiple requests.
Note that you can still search without the `async with` syntax by simply calling `await AIOSauceNao(...).from_url(...)`.
## Advanced usage
```python
from saucenao_api import SauceNao
from saucenao_api.params import DB, Hide, BgColor
sauce = SauceNao(api_key=None, # Optional[str]
testmode=0, # int
dbmask=None, # Optional[int]
dbmaski=None, # Optional[int]
db=DB.ALL, # int
numres=6, # int
frame=1, # int
hide=Hide.NONE, # int
bgcolor=BgColor.NONE, # int
)
```
The parameters `frame`, `hide` and `bgcolor` are taken from the main page and from the [testing page](https://saucenao.com/testing), so their performance is not guaranteed. For the rest see [SauceNAO User Config](https://saucenao.com/user.php?page=search-api) page (registration required).
### Exceptions
All exceptions inherit from `SauceNaoApiError` for easy catching and handling. See [`errors.py`](saucenao_api/errors.py) file for details.
*Note: SauceNao doesn't have good documentation. Exceptions are created only based on observations of changes in the returned status codes. If you find a specific error that is not being processed, please report it.*
# License
This package is based on [`pysaucenao`](https://github.com/FujiMakoto/pysaucenao).
%prep
%autosetup -n saucenao-api-2.4.0
%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-saucenao-api -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue May 30 2023 Python_Bot <Python_Bot@openeuler.org> - 2.4.0-1
- Package Spec generated
|
