├── CHANGELOG.md
├── DOCUMENTATION.md
├── LICENSE
├── MANIFEST
├── README.md
├── examples
    └── save_image.py
├── setup.cfg
├── setup.py
└── sr_api
    ├── __init__.py
    ├── client.py
    ├── definition.py
    ├── http.py
    ├── image.py
    ├── lyrics.py
    ├── meme.py
    ├── minecraft.py
    ├── options.py
    ├── pokedex.py
    └── quote.py


/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | ## v1.1.4 - Oktober 16, 2020
 2 | * Now using yarl to improve url formatting and preventing Error 404 when using premium on some endpoints
 3 | * Added option to search pokemon by ID
 4 | * images, gifs, facts and filters now can be selected with `sr_api.Animal/Gif/filter.<option>` e.g. `sr_api.Animal.cat` (this may or may not become required in the future!)
 5 | 
 6 | ## v1.1.3 - Oktober 16, 2020
 7 | * Fix pokedex sprites and evolution line
 8 | 
 9 | ### v1.1.2 - Oktober 16, 2020
10 | * OwOify lyrics with `client.get_lyrics(title, owo=True)`
11 | * Pass your own `aiohttp.ClientSession` so you dont have to separately close sr_api's session with `client = sr_api.Client(session=mysession)`
12 | * Fixed a typo in the docs
13 | * Add examples
14 | 
15 | ### v1.1.1 - Oktober 14, 2020
16 | * Fixed the big mistake I made
17 | * gave access to sr_api.InputError and sr_api.PremiumOnly
18 | 
19 | ### v1.1.0 - Oktober 14, 2020
20 | * Fixed client token error
21 | * Added amongus endpoint
22 | * Client.view_color is no longer a coroutine
23 | * Client.youtube_comment is no longer a coroutine
24 | * Client.filter is no longer a coroutine
25 | 
26 | ### v1.0.6 - September 6, 2020
27 | * `Client.filter()` now returns an `Image` object
28 | 
29 | ### v1.0.5 - September 6, 2020
30 | * Added `spin` back because apparently SRA didnt document it.
31 | 
32 | ### v1.0.4 - September 6, 2020
33 | * Fixed type where you couldn't use the `greyscale` filter
34 | * Removed `spin` from filter method, unsure how it even got there
35 | 
36 | ### v1.0.3 - September 5, 2020
37 | * You can now get the url from methods that return an `Image` object by casting the object to `str`
38 | 
39 | ### v1.0.2 - September 5, 2020
40 | * Fixed passing a key in `Client`
41 | 
42 | ### v1.0.1 - September 5, 2020
43 | * Added "key" to `Client.__slots__`
44 | 
45 | ### v1.0 - September 5, 2020
46 | * Renamed `Client.beta()` to `Client.filter()` since its no longer a beta feature
47 | * Added `whale` and `pikachu` to `Client.get_image()`
48 | * Added `invertgreyscale`, `brightness`, `threshold`, `red`, `green` & `blue` to `Client.filter()`
49 | * Added `Client.youtube_comment()`
50 | * Added `Client.view_color()`
51 | * Added `Client.rgb_to_hex()`
52 | * Added `Client.hex_to_rgb()`
53 | * Added `Client.get_joke()`
54 | * Added support for using premium. Provide your premium key in the Client init like `client = sr_api.Client("key here")`. Dont provide a key if you dont have one.
55 | * Removed `Client.get_pikachu()` which is now available in `Client.get_image()`
56 | 
57 | ### v0.4 - January 3, 2020
58 | * Fixed issue with beta endpoint
59 | 
60 | ### v0.3 - December 15, 2019
61 | * Fixed last update where I forgot to change a crucial part
62 | 
63 | ### v0.2 - December 15, 2019
64 | * Fixed where `Meme.read()` and `Meme.save()` used `self.url` in stead of `self.image`
65 | 
66 | ### v0.1 - December 10, 2019
67 | * Initial release
68 | 


--------------------------------------------------------------------------------
/DOCUMENTATION.md:
--------------------------------------------------------------------------------
  1 | # SR_Api
  2 | 
  3 | Welcome, and thank you for using this api wrapper! This wrapper is completely async! Please note that I am not the creator of some-random-api. I only made this api wrapper! I also want to thank ir-3 for helping me get started with this.
  4 | 
  5 | For any questions and support for the wrapper, you can visit the [Discord support server](https://discord.gg/wZSH7pz "Devision")
  6 |  
  7 | ## Getting Started:
  8 | 
  9 | To begin with, you'll have to install the package by doing one of the following commands:
 10 | - `pip install -U sr_api`
 11 | - `python -m pip -U install sr_api`
 12 |  
 13 | Or you can install directly from source by doing one of the following commands:
 14 | - `pip install -U git+https://github.com/iDutchy/sr_api`
 15 | - `python -m pip install -U git+https://github.com/iDutchy/sr_api`
 16 |  
 17 | After that, you will have to create the client:
 18 | ```python
 19 | import sr_api
 20 | 
 21 | client = sr_api.Client() #Alternatively you can use your own aiohttp.ClientSession by passing session=yoursession to this
 22 | ```
 23 | Or if you have premium, provide your premium key like this:
 24 | ```python
 25 | import sr_api
 26 | 
 27 | client = sr_api.Client("premium key here")
 28 | ```
 29 |  
 30 | For future reference in this documentation: when referring to 'client' we refer to what has been defined above!
 31 |  
 32 |   
 33 | ## Using the wrapper:
 34 |  
 35 | All available endpoints you can use.
 36 | 
 37 | ### client.amongus(username, avatar, impostor=False)
 38 | ---
 39 | **Premium Endpoint**
 40 | Get a gif from voting someone away as the impostor
 41 | 
 42 | **WARNING:** The Image.url returned by this function will very likely not embed! You will have to use Image.read to get the bytes object and work from there! DO NOT SHARE THE URL EITHER SINCE IT CONTAINS YOUR PREMIUM KEY
 43 | 
 44 | **Parameters:**\
 45 | **- username** *(string)*: The name of the impostor
 46 | **- avatar** *(string)*: The avatar url of the impostor
 47 | **- impostor** *(boolean)* Whether or not the ejected user was an impostor.
 48 | 
 49 | **Return type:** [Image](https://github.com/iDutchy/sr_api/blob/master/DOCUMENTATION.md#image "Image object attributes") *(object)*
 50 | 
 51 | ### client.petpet(avatar)
 52 | ---
 53 | **Premium Endpoint**
 54 | Get a gif of someone or something being petted.
 55 | 
 56 | **WARNING:** The Image.url returned by this function will very likely not embed! You will have to use Image.read to get the bytes object and work from there! DO NOT SHARE THE URL EITHER SINCE IT CONTAINS YOUR PREMIUM KEY
 57 | 
 58 | **Parameters:**\
 59 | **- avatar** *(string)*: The avatar url of the petted object.
 60 | 
 61 | **Return type:** [Image](https://github.com/iDutchy/sr_api/blob/master/DOCUMENTATION.md#image "Image object attributes") *(object)*
 62 | 
 63 | ### *await* client.get_image(animal)
 64 | ---
 65 | Get a random animal image.
 66 | 
 67 | **Available options:** `dog`, `cat`, `panda`, `red_panda`, `fox`, `birb`, `koala`, `kangaroo`, `racoon`, `whale`, `pikachu`  
 68 | **Parameters:**\
 69 | **- animal** *(string)*: The animal you want to get an image from.
 70 |    
 71 | **Return type:** [Image](https://github.com/iDutchy/sr_api/blob/master/DOCUMENTATION.md#image "Image object attributes") *(object)*
 72 | 
 73 | ### *await* client.get_fact(animal)
 74 | ---
 75 | Get a random animal fact.
 76 | 
 77 | **Available options:** `cat`, `dog`, `koala`, `fox`, `bird`, `elephant`, `panda`, `racoon`, `kangaroo`, `giraffe`, `whale`
 78 |   
 79 | **Parameters:**\
 80 | **- animal** *(string)*: The animal you want to get a random fact from.
 81 |    
 82 | **Return type:** string
 83 | 
 84 | ### *await* client.bot_token()
 85 | ---
 86 | Get a random bots token. *These are not real and can not be used to make a real bot*
 87 | 
 88 | **Return type:** string
 89 | 
 90 | ### *await* client.get_gif(option)
 91 | ---
 92 | Get a random funny gif.
 93 | 
 94 | **Available options:** `wink`, `pat`, `hug`, `face-palm`
 95 | 
 96 | **Parameters:**\
 97 | **- option** *(string)*: The type of gif you want.
 98 | 
 99 | **Return type:** [Image](https://github.com/iDutchy/sr_api/blob/master/DOCUMENTATION.md#image "Image object attributes") *(object)*
100 | 
101 | ### *await* client.chatbot(text)
102 | ---
103 | Talk with the chatbot.
104 | 
105 | **Parameters:**\
106 | **- text** *(string)*: Your line to the bot.
107 | 
108 | **Return type:** string
109 | 
110 | ### *await* client.mc_user(username)
111 | ---
112 | Get the username history and UUID from a minecraft user.
113 | 
114 | **Parameters:**\
115 | **- username** *(string)*: Name of the minecraft user.
116 | 
117 | **Return type:** [MCuser](https://github.com/iDutchy/sr_api/blob/master/DOCUMENTATION.md#mcuser "MCuser object attributes") *(object)*
118 | 
119 | ### *await* client.get_pokemon(name=None, pokemon_id=None)
120 | ---
121 | Search for a pokemon in the pokedex.
122 | **Note:** You can search by name OR id, not both!
123 | 
124 | **Parameters:**\
125 | **- name** *(string)*: Name of the pokémon.
126 | **- pokemon_id** *(int)*: ID of the pokemon
127 | 
128 | **Return type:** [Pokemon](https://github.com/iDutchy/sr_api/blob/master/DOCUMENTATION.md#pokemon "Pokemon object attributes") *(object)*
129 | 
130 | ### *await* client.encode_binary(text)
131 | ---
132 | Encode text in binary.
133 | 
134 | **Parameters:**\
135 | **- text** *(string)*: Text you want to encode.
136 | 
137 | **Return type:** string
138 | 
139 | ### *await* client.decode_binary(binary)
140 | ---
141 | Decode binary to text.
142 | 
143 | **Parameters:**\
144 | **- binary** *(string)*: Binary you want to decode.
145 | 
146 | **Return type:** string
147 | 
148 | ### *await* client.encode_base64(text)
149 | ---
150 | Encode text in base64.
151 | 
152 | **Parameters:**\
153 | **- text** *(string)*: Text you want to encode.
154 | 
155 | **Return type:** string
156 | 
157 | ### *await* client.decode_base64(text)
158 | ---
159 | Decode base64 to text.
160 | 
161 | **Parameters:**\
162 | **- text** *(string)*: Text you want to decode.
163 | 
164 | **Return type:** string
165 | 
166 | ### *await* client.get_lyrics(title, owo=False)
167 | ---
168 | Get the lyrics from a song.
169 | 
170 | **Parameters:**\
171 | **- title** *(string)*: Title of the song you want to get lyrics from.
172 | **- owo** *(bool)*: Wheter to OwOify the lyrics. Defaults to `False`
173 | 
174 | **Return type:** [Lyrics](https://github.com/iDutchy/sr_api/blob/master/DOCUMENTATION.md#lyrics "Lyrics object attributes") *(object)*
175 | 
176 | ### *await* client.get_meme()
177 | ---
178 | Get a random meme.
179 | 
180 | **Return type:** [Meme](https://github.com/iDutchy/sr_api/blob/master/DOCUMENTATION.md#meme "Meme object attributes") *(object)*
181 | 
182 | ### *await* client.anime_quote()
183 | ---
184 | Get a random quote from an anime.
185 | 
186 | **Return type:** [Quote](https://github.com/iDutchy/sr_api/blob/master/DOCUMENTATION.md#quote "Quote object attributes") *(object)*
187 | 
188 | ### *await* client.get_joke()
189 | ---
190 | Get a random joke.
191 | 
192 | **Return type:** string
193 | 
194 | ### *await* client.define(word)
195 | ---
196 | Get the definition from a word.
197 | 
198 | **Parameters:**\
199 | **- word** *(string)*: The word you want to define.
200 | 
201 | **Return type:** [Definition](https://github.com/iDutchy/sr_api/blob/master/DOCUMENTATION.md#definition "Definition object attributes") *(object)*
202 | 
203 | ### client.filter(option, url)
204 | ---
205 | **Available options:** `gay`, `wasted`, `greyscale`, `invert`, `triggered`, `blur`, `blurple`, `glass`, `pixelate`, `sepia`, `invertgreyscale`, `brightness`, `threshold`, `red`, `green`, `blue`, `spin`
206 | 
207 | **WARNING:** The Image.url returned by this function will very likely not embed! You will have to use Image.read to get the bytes object and work from there!
208 | 
209 | **Parameters:**\
210 | **- option** *(string)*: The type of image manipulation you want to use.\
211 | **- url** *(string)*: The url from the image you want to manipulate.
212 | 
213 | **Return type:** [Image](https://github.com/iDutchy/sr_api/blob/master/DOCUMENTATION.md#image "Image object attributes") *(object)*
214 | 
215 | ### client.youtube_comment(avatar, username, comment)
216 | ---
217 | Generate a fake youtube comment.
218 | 
219 | **WARNING:** The Image.url returned by this function will very likely not embed! You will have to use Image.read to get the bytes object and work from there!
220 | 
221 | **Parameters:**\
222 | **- avatar** *(string)*: The avatar you want to use.\
223 | **- username** *(string)*: The username for the comment.\
224 | **- comment** *(string)*: The content of the comment.
225 | 
226 | **Return type:** [Image](https://github.com/iDutchy/sr_api/blob/master/DOCUMENTATION.md#image "Image object attributes") *(object)*
227 | 
228 | ### client.view_color(color)
229 | ---
230 | View a color.
231 | 
232 | **WARNING:** The Image.url returned by this function will very likely not embed! You will have to use Image.read to get the bytes object and work from there!
233 | 
234 | **Parameters:**\
235 | **- color** *(string)*: The color you want an image of. Example: `"123456"`
236 | 
237 | **Return type:** [Image](https://github.com/iDutchy/sr_api/blob/master/DOCUMENTATION.md#image "Image object attributes") *(object)*
238 | 
239 | ### *await* client.rgb_to_hex(color_hex)
240 | ---
241 | Convert RGB to HEX
242 | 
243 | **Parameters:**\
244 | **- color_hex** *(string)*: The RGB value you want to convert. Example: `"255,255,255"`
245 | 
246 | **Return type:** string
247 | 
248 | ### *await* client.hex_to_rgb(color_hex)
249 | ---
250 | Convert HEX to RGB
251 | 
252 | **Parameters:**\
253 | **- color_hex** *(string)*: The HEX value you want to convert. Example: `"123456"`
254 | 
255 | **Return type:** dict ("r", "g", "b")
256 | 
257 | ---
258 | ---
259 | ---
260 | 
261 | ## Objects
262 | 
263 | Here is explained what attributes the returned objects have
264 | 
265 | ### Image
266 | ---
267 | The object returned from `client.get_image()`,  `client.get_gif()`, `client.youtube_comment()` and `client.view_color()`
268 | 
269 | #### Image.url
270 | The url of the image
271 | 
272 | #### *await* Image.read()
273 | This will return a bytes object from the image
274 | 
275 | #### *await* Image.save(filepath)
276 | Locally save the image.\
277 | **Note:** 'filepath' requires a *full* path! e.g. `/home/John/myimage.png`
278 | 
279 | ### Lyrics
280 | ---
281 | The object returned from `client.get_lyrics()`
282 | 
283 | #### Lyrics.title
284 | The title of the song
285 | 
286 | #### Lyrics.author
287 | The author of the song
288 | 
289 | #### Lyrics.lyrics
290 | The full lyrics of the song
291 | 
292 | #### Lyrics.thumbnail
293 | A thumbnail of the song
294 | 
295 | #### Lyrics.link
296 | A link to the songs Genius page
297 | 
298 | #### Lyrics.save()
299 | This will locally save a `.txt` file of the lyrics
300 | 
301 | ### Meme
302 | ---
303 | The object returned from `client.get_meme()`
304 | 
305 | #### Meme.id
306 | The ID of the meme
307 | 
308 | #### Meme.image
309 | URL of the meme's image
310 | 
311 | #### Meme.caption
312 | Description of the meme
313 | 
314 | #### Meme.category
315 | The category the meme belongs to
316 | 
317 | #### *await* Meme.save(filepath)
318 | Locally save an image of the meme.\
319 | **Note:** 'filepath' requires a *full* path! e.g. `/home/John/meme.png`
320 | 
321 | ### MCuser
322 | ---
323 | The object returned from `client.mc_user()`
324 | 
325 | #### MCuser.name
326 | Minecraft username
327 | 
328 | #### MCuser.uuid
329 | The users UUID
330 | 
331 | #### MCuser.history
332 | This will return a *list* of *dicts* with the users name history and date it was changed.
333 | 
334 | #### MCuser.formatted_history
335 | A pre formatted list of the users name history
336 | 
337 | #### MCuser.reversed_formatted_history
338 | A pre formatted list of the users name history in reversed order
339 | 
340 | ### Quote
341 | ---
342 | The object returned from `client.anime_quote()`
343 | 
344 | #### Quote.quote
345 | The characters quote
346 | 
347 | #### Quote.character
348 | The character the quote is from
349 | 
350 | #### Quote.anime
351 | The anime show the character/quote is from
352 | 
353 | ### Definition
354 | ---
355 | The object returned from `client.define()`
356 | 
357 | #### Definition.word
358 | The word that is being defined
359 | 
360 | #### Definition.definition
361 | The definition of the word
362 | 
363 | ### Pokemon
364 | ---
365 | The object returned from `client.get_pokemon()`
366 | 
367 | #### Pokemon.name
368 | The name of the pokémon
369 | 
370 | #### Pokemon.id
371 | The ID of the pokémon
372 | 
373 | #### Pokemon.type
374 | Returns a *list* of the types
375 | 
376 | #### Pokemon.abilities
377 | Returns a *list* of the pokémons abilities
378 | 
379 | #### Pokemon.height
380 | The pokémons height
381 | 
382 | #### Pokemon.weight
383 | The pokémons weight
384 | 
385 | #### Pokemon.base_experience
386 | The base experience of the pokémon
387 | 
388 | #### Pokemon.gender
389 | Returns a *list* of the pokémons genders
390 | 
391 | #### Pokemon.egg_groups
392 | Returns a *list* of the pokémons egg groups
393 | 
394 | #### Pokemon.hp
395 | The pokémons HP stats
396 | 
397 | #### Pokemon.attack
398 | The pokémons Attack stats
399 | 
400 | #### Pokemon.defense
401 | The pokémons Defense stats
402 | 
403 | #### Pokemon.sp_atk
404 | The pokémons Special Attack stats
405 | 
406 | #### Pokemon.sp_def
407 | The pokémons Special Defense stats
408 | 
409 | #### Pokemon.speed
410 | The pokémons Speed stats
411 | 
412 | #### Pokemon.total
413 | The pokémons total stats
414 | 
415 | #### Pokemon.evolutionStage
416 | The pokémons evolution stage
417 | 
418 | #### Pokemon.evolutionLine
419 | Returns a *list* of the pokémons evolution line
420 | 
421 | #### Pokemon.spriteNormal
422 | A `.png` url of the pokémons character
423 | 
424 | #### Pokemon.spriteAnimated
425 | A `.gif` url of the pokémons character
426 | 
427 | #### Pokemon.description
428 | A description of the pokémon
429 | 
430 | #### Pokemon.generation
431 | The generation the pokémon is from
432 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2019 iDutchy
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/MANIFEST:
--------------------------------------------------------------------------------
 1 | # file GENERATED by distutils, do NOT edit
 2 | setup.cfg
 3 | setup.py
 4 | sr_api/__init__.py
 5 | sr_api/client.py
 6 | sr_api/definition.py
 7 | sr_api/http.py
 8 | sr_api/image.py
 9 | sr_api/lyrics.py
10 | sr_api/meme.py
11 | sr_api/minecraft.py
12 | sr_api/pokedex.py
13 | sr_api/quote.py
14 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # SR_Api
 2 | An async Python wrapper for some-random-api
 3 | 
 4 | Welcome, and thank you for using this api wrapper! This wrapper is completely async! Please note that I am not the creator of some-random-api. I only made this api wrapper! I also want to thank ir-3 for helping me get started with this.
 5 | 
 6 | For any questions and support for the wrapper, you can visit the [Discord support server](https://discord.gg/wZSH7pz "Devision")
 7 | 
 8 | # Getting Started:
 9 | To begin with, you'll have to install the package by doing one of the following commands:
10 | - `pip install -U sr_api`
11 | - `python -m pip -U install sr_api`
12 |  
13 | Or you can install directly from source by doing one of the following commands:
14 | - `pip install -U git+https://github.com/iDutchy/sr_api`
15 | - `python -m pip install -U git+https://github.com/iDutchy/sr_api`
16 |  
17 | After that, you will have to create the client:
18 | ```python
19 | import sr_api
20 | 
21 | client = sr_api.Client()
22 | ```
23 | 
24 | For full usage, please read the [documentation](https://github.com/iDutchy/sr_api/blob/master/DOCUMENTATION.md)
25 | 


--------------------------------------------------------------------------------
/examples/save_image.py:
--------------------------------------------------------------------------------
 1 | import asyncio
 2 | from sr_api import Client
 3 | 
 4 | 
 5 | async def main():
 6 |     client = Client()
 7 | 
 8 |     image = await client.get_image("red_panda")
 9 |     await image.save("panda.png")
10 | 
11 |     await client.close()
12 | 
13 | 
14 | asyncio.get_event_loop().run_until_complete(main())


--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | [metadata]
2 | description-file = README.md
3 | 


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
 1 | from distutils.core import setup
 2 | 
 3 | setup(
 4 |   name = 'sr_api',
 5 |   packages = ['sr_api'],
 6 |   version = '1.1.5',
 7 |   license='MIT',
 8 |   description = 'An async wrapper for some-random-api',
 9 |   author = 'Niels Steenman',
10 |   author_email = 'ngssteenman@gmail.com',
11 |   url = 'https://github.com/iDutchy/sr_api',
12 |   download_url = 'https://github.com/iDutchy/sr_api/archive/1.1.5.tar.gz',
13 |   keywords = ['wrapper', 'api', 'random'],
14 |   install_requires=['aiohttp', 'yarl'],
15 |   classifiers=[
16 |     'Development Status :: 5 - Production/Stable',
17 |     'Intended Audience :: Developers',
18 |     'Topic :: Software Development :: Build Tools',
19 |     'License :: OSI Approved :: MIT License',
20 |     'Programming Language :: Python :: 3',
21 |     'Programming Language :: Python :: 3.4',
22 |     'Programming Language :: Python :: 3.5',
23 |     'Programming Language :: Python :: 3.6',
24 |     'Programming Language :: Python :: 3.7'
25 |   ],
26 | )


--------------------------------------------------------------------------------
/sr_api/__init__.py:
--------------------------------------------------------------------------------
1 | from .client import Client, InputError, PremiumOnly
2 | from .options import Animal, Gif, Filter


--------------------------------------------------------------------------------
/sr_api/client.py:
--------------------------------------------------------------------------------
  1 | import random
  2 | import aiohttp
  3 | 
  4 | from yarl import URL
  5 | 
  6 | from .http import HTTPClient
  7 | from .image import Image
  8 | from .pokedex import Pokedex
  9 | from .minecraft import Minecraft
 10 | from .lyrics import Lyrics
 11 | from .meme import Meme
 12 | from .quote import Quote
 13 | from .definition import Definition
 14 | from .options import Animal, Gif, Filter
 15 | 
 16 | class InputError(Exception):
 17 |     __slots__ = ()
 18 |     pass
 19 | 
 20 | class PremiumOnly(Exception):
 21 |     __slots__ = ()
 22 |     pass
 23 | 
 24 | class Client:
 25 | 
 26 |     __slots__ = ("_http_client", "key")
 27 | 
 28 |     # SR API BASE PATH
 29 |     WEBSITE = "https://some-random-api.ml/"
 30 | 
 31 |     def __init__(self, key=None, *, session: aiohttp.ClientSession = None):
 32 |         self._http_client = HTTPClient(session)
 33 |         self.key = key
 34 | 
 35 |     def srapi_url(self, path, query={}):
 36 |         if self.key:
 37 |             query['key'] = self.key
 38 | 
 39 |         url = URL.build(
 40 |             scheme="https",
 41 |             host="some-random-api.ml",
 42 |             path="/"+path.lstrip("/"),
 43 |             query=query)
 44 | 
 45 |         return str(url)
 46 | 
 47 |     def amongus(self, username, avatar, impostor = False):
 48 |         if self.key is None:
 49 |             raise PremiumOnly("This endpoint can only be used by premium users.")
 50 | 
 51 |         url = self.srapi_url("premium/amongus", {"username": username, "avatar": avatar, "impostor": str(impostor).lower()})
 52 |         return Image(self._http_client, url)
 53 |     
 54 |     def petpet(self, avatar):
 55 |         if self.key is None:
 56 |             raise PremiumOnly("This endpoint can only be used by premium users.")
 57 | 
 58 |         url = self.srapi_url("premium/petpet", {"avatar": avatar})
 59 |         return Image(self._http_client, url)
 60 |     
 61 |     async def get_animal(self, name=None):
 62 |         options = ("dog", "cat", "panda", "fox", "red_panda", "koala", "birb", 
 63 |                    "bird", "racoon", "raccoon", "kangaroo")
 64 |         response = await self._http_client.get(self.srapi_url("animal/" + name.lower() if name else random.choice(options)))
 65 |         return response
 66 | 
 67 |     async def get_image(self, name=None):
 68 |         options = ("dog", "cat", "panda", "red_panda", "fox", "birb", "koala",
 69 |                    "kangaroo", "racoon", "whale", "pikachu", "bird", "raccoon")
 70 | 
 71 |         if name.lower() not in options and name is not None:
 72 |             raise InputError(name.lower() + " is not a valid option!")
 73 | 
 74 |         if name is None:
 75 |             response = await self._http_client.get(self.srapi_url("img/" + random.choice(options)))
 76 |             url = response.get("link")
 77 | 
 78 |         else:
 79 |             response = await self._http_client.get(self.srapi_url("img/" + name.lower()))
 80 |             url = response.get("link")
 81 | 
 82 |         return Image(self._http_client, url)
 83 |     
 84 |     async def get_pokemon(self, name=None, pokemon_id=None, dym=None):
 85 |         if not name and not pokemon_id:
 86 |             raise InputError("Please provide either a name or an ID!")
 87 |         if name and pokemon_id:
 88 |             raise InputError("Please provide a name or ID, not both!")
 89 | 
 90 |         if name:
 91 |             q = {"pokemon": name}
 92 |         elif pokemon_id:
 93 |             q = {"id": pokemon_id}
 94 |         if dym:
 95 |             if self.key is None:
 96 |                 raise PremiumOnly("The dym parameter can only be used by premium users.")
 97 |             q += {"dym": dym}
 98 | 
 99 |         response = await self._http_client.get(self.srapi_url("pokedex", q))
100 |         if "error" in response:
101 |             raise InputError("Pokémon " + name + " was not found")
102 |         return Pokedex(response)
103 |     
104 |     async def get_fact(self, name):
105 |         options = ("cat", "dog", "panda", "koala", "fox", "bird", "racoon", "kangaroo", "elephant", "giraffe", "whale", "birb", "raccoon")
106 |         if not name.lower() in options:
107 |             raise InputError(name + " is not a valid option!")
108 | 
109 |         response = await self._http_client.get(self.srapi_url("facts/" + name))
110 |         fact = response.get("fact")
111 |         
112 |         return fact
113 |     
114 |     async def bot_token(self):
115 |         response = await self._http_client.get(self.srapi_url("bottoken"))
116 |         token = response.get("token")
117 |                                                               
118 |         return token
119 |     
120 |     async def get_gif(self, name):
121 |         options = ("wink", "pat", "hug", "face-palm")
122 |         if not name.lower() in options:
123 |             raise InputError(name + " is not a valid option!")
124 | 
125 |         response = await self._http_client.get(self.srapi_url("animu/" + name))
126 |         url = response.get("link")
127 | 
128 |         return Image(self._http_client, url)
129 |     
130 |     async def chatbot(self, text, uid=None):
131 |         if self.key is None:
132 |             raise PremiumOnly("This endpoint can only be used by premium users.")
133 |             
134 |         query = {"message": text}
135 |         if uid:
136 |             query += {'uid': uid}
137 | 
138 |         response = await self._http_client.get(self.srapi_url("chatbot", query))
139 |         res = response.get("response")
140 |         
141 |         return res
142 |         
143 |     async def mc_user(self, name):
144 |         response = await self._http_client.get(self.srapi_url("mc", {"username": name}))
145 |         
146 |         if "error" in response:
147 |             raise InputError(response.get("error"))
148 |         
149 |         return Minecraft(response)
150 |     
151 |     async def get_lyrics(self, title, owo=False):
152 |         q = {"title": title}
153 |         if owo:
154 |             q['cancer'] = 'true'
155 |         response = await self._http_client.get(self.srapi_url("lyrics", q))
156 |         
157 |         if "error" in response:
158 |             raise InputError(response.get("error"))
159 |         
160 |         return Lyrics(response)
161 | 
162 |     async def encode_binary(self, text):
163 |         response = await self._http_client.get(self.srapi_url("binary", {"text": text}))
164 |         res = response.get("binary")
165 |         
166 |         return res
167 |     
168 |     async def decode_binary(self, text):
169 |         response = await self._http_client.get(self.srapi_url("binary", {"decode": text}))
170 |         res = response.get("text")
171 |         
172 |         return res
173 |     
174 |     async def encode_base64(self, text):
175 |         response = await self._http_client.get(self.srapi_url("base64", {"encode": text}))
176 |         res = response.get("base64")
177 |         
178 |         return res
179 |     
180 |     async def decode_base64(self, text):
181 |         response = await self._http_client.get(self.srapi_url("base64", {"decode": text}))
182 |         res = response.get("text")
183 |         
184 |         return res
185 |     
186 |     async def get_meme(self):
187 |         response = await self._http_client.get(self.srapi_url("meme"))
188 |         
189 |         return Meme(self._http_client, response)
190 |     
191 |     async def anime_quote(self):
192 |         response = await self._http_client.get(self.srapi_url("animu/quote"))
193 |         
194 |         return Quote(response)
195 |     
196 |     async def define(self, text):
197 |         response = await self._http_client.get(self.srapi_url("dictionary", {"word": text}))
198 |         
199 |         if "error" in response:
200 |             raise InputError(response.get("error") + " " + text)
201 |             
202 |         return Definition(response)
203 | 
204 |     async def get_joke(self):
205 |         response = await self._http_client.get(self.srapi_url("joke"))
206 |         res = response.get("joke")
207 |         return res
208 | 
209 |     def filter(self, option, url):
210 |         options = (
211 |             'greyscale', 'invert', 'invertgreyscale', 'brightness', 'threshold', 'sepia', 'red', 'green', 'blue', 'blurple',
212 |             'pixelate', 'blur', 'gay', 'glass', 'wasted', 'triggered', 'spin', 'jail', 'blurple2')
213 | 
214 |         if option.lower() not in options:
215 |             raise InputError(option.lower() + " is not a valid option!")
216 | 
217 |         end_url = self.srapi_url("canvas/" + str(option).lower(), {"avatar": url})
218 |         return Image(self._http_client, end_url)
219 | 
220 |     def youtube_comment(self, avatar, username, comment):
221 |         url = self.srapi_url("canvas/youtube-comment", {"avatar": avatar, "username": username, "comment": comment})
222 |         return Image(self._http_client, url)
223 | 
224 |     def view_color(self, color):
225 |         color = color.replace("#", '')
226 |         url = self.srapi_url("canvas/colorviewer", {"hex": color})
227 |         return Image(self._http_client, url)
228 | 
229 |     async def rgb_to_hex(self, rgb):
230 |         response = await self._http_client.get(self.srapi_url("canvas/hex", {"rgb": rgb}))
231 |         res = response.get("hex")
232 |         return res
233 | 
234 |     async def hex_to_rgb(self, color_hex):
235 |         response = await self._http_client.get(self.srapi_url("canvas/rgb", {"hex": color_hex}))
236 |         return dict(response)
237 |     
238 |     def lolice(self, avatar):
239 |         url = self.srapi_url("canvas/lolice", {"avatar": avatar})
240 |         return Image(self._http_client, url)
241 |     
242 |     def simp_card(self, avatar):
243 |         url = self.srapi_url("canvas/simpcard", {"avatar": avatar})
244 |         return Image(self._http_client, url)
245 |     
246 |     def horny_card(self, avatar):
247 |         url = self.srapi_url("canvas/horny", {"avatar": avatar})
248 |         return Image(self._http_client, url)
249 |     
250 |     def its_stupid(self, avatar, dog):
251 |         url = self.srapi_url("canvas/its-so-stupid", {"avatar": avatar, "dog": dog})
252 |         return Image(self._http_client, url)
253 |     
254 |     async def check_key(self):
255 |         if self.key is None:
256 |             raise PremiumOnly("This endpoint can only be used by premium users.")
257 | 
258 |         response = await self._http_client.get(self.srapi_url("key/check"))
259 |         res = response.get("response")
260 |         
261 |         return res
262 |     
263 |     def welcome(template, background, action_type, avatar, username, discriminator, guild_name, text_color, member_count):
264 |             
265 |         url = self.srapi_url("welcome/img/" + str(template) + '/' + background, {
266 |             "type": action_type,
267 |             "avatar": avatar,
268 |             "username": username,
269 |             "discriminator": discriminator,
270 |             "guildName": guild_name,
271 |             "textcolor": text_color,
272 |             "memberCount": member_count
273 |             })
274 |         
275 |         return Image(self._http_client, url)
276 |     
277 |     def premium_welcome(template, action_type, avatar, username, discriminator, guild_name, text_color, member_count, background_image):
278 |         if self.key is None:
279 |             raise PremiumOnly("This endpoint can only be used by premium users.")
280 |             
281 |         url = self.srapi_url("premium/welcome/" + str(template), {
282 |             "type": action_type,
283 |             "avatar": avatar,
284 |             "username": username,
285 |             "discriminator": discriminator,
286 |             "guildName": guild_name,
287 |             "textcolor": text_color,
288 |             "memberCount": member_count,
289 |             "bg": background_image
290 |             })
291 |         
292 |         return Image(self._http_client, url)
293 |     
294 |     def rank_card(template, username, avatar, discriminator, level, current_xp, needed_xp, rank, background_image, background_color=None, text_color=None, current_xp_bar_color=None, bar_color=None):
295 |         if self.key is None:
296 |             raise PremiumOnly("This endpoint can only be used by premium users.")
297 |             
298 |         q = {
299 |             "username": username,
300 |             "avatar": avatar,
301 |             "discriminator": discriminator,
302 |             "level": level,
303 |             "cxp": current_xp,
304 |             "nxp": needed_xp,
305 |             "rank": rank,
306 |             "bg": background_image
307 |             }
308 |         
309 |         if background_color is not None:
310 |             q += {"cbg": background_color}
311 |         if text_color is not None:
312 |             q += {"ctext": text_color}
313 |         if current_xp_bar_color is not None:
314 |             q += {"ccxp": current_xp_bar_color}
315 |         if bar_color is not None:
316 |             q += {"cbar": bar_color}
317 |             
318 |         url = self.srapi_url("premium/rankcard/" + str(template), q)
319 |             
320 |         return Image(self._http_client, url)
321 | 
322 |     async def close(self):
323 |         await self._http_client.close()
324 | 


--------------------------------------------------------------------------------
/sr_api/definition.py:
--------------------------------------------------------------------------------
1 | class Definition:
2 |     __slots__ = ("word", "definition")
3 |     def __init__(self, data):
4 |         self.word = data.get('word')
5 |         self.definition = data.get('definition')
6 | 


--------------------------------------------------------------------------------
/sr_api/http.py:
--------------------------------------------------------------------------------
 1 | import aiohttp
 2 | 
 3 | 
 4 | class HTTPClient:
 5 |     __slots__ = ("session")
 6 | 
 7 |     def __init__(self, session=None):
 8 |         self.session = session
 9 | 
10 |     # Aiohttp client sessions must be created in async functions
11 |     async def create_session(self):
12 |         self.session = aiohttp.ClientSession()
13 | 
14 |     # Send this request to the SR_API_BASE + path
15 |     # path is what comes after the / in the base url
16 |     # **kwargs is passed to self.session.request along with the full url
17 |     async def get(self, url, **kwargs):
18 |         if self.session is None:
19 |             await self.create_session()
20 | 
21 |         async with self.session.get(url, **kwargs) as response:
22 |             if not (300 > response.status >= 200):
23 |                 # TODO: Seperate exception for statuses raised
24 |                 raise ValueError("Raised " + str(response.status))
25 | 
26 |             try:
27 |                 content = await response.json()
28 |             except aiohttp.ClientResponseError:
29 |                 content = await response.read()
30 | 
31 |             return content
32 | 
33 |     async def close(self):
34 |         if self.session is not None:
35 |             await self.session.close()
36 |             self.session = None


--------------------------------------------------------------------------------
/sr_api/image.py:
--------------------------------------------------------------------------------
 1 | import io
 2 | 
 3 | from sr_api.http import HTTPClient
 4 | 
 5 | 
 6 | # heavily inspired by https://github.com/Rapptz/discord.py/blob/master/discord/asset.py
 7 | class Image:
 8 |     __slots__ = ("url", "_http_client")
 9 | 
10 |     def __init__(self, http_client: HTTPClient, url):
11 |         self.url = url
12 |         self._http_client = http_client
13 | 
14 |     def __str__(self):
15 |         return self.url if self.url is not None else ''
16 | 
17 |     async def read(self):
18 |         return await self._http_client.get(self.url)
19 | 
20 |     async def save(self, fp, seek_start=True):
21 |         data = await self.read()
22 |         if isinstance(fp, io.IOBase) and fp.writable():
23 |             written = fp.write(data)
24 | 
25 |             if seek_start:
26 |                 fp.seek(0)
27 | 
28 |             return written
29 |         else:
30 |             with open(fp, 'wb') as f:
31 |                 return f.write(data)
32 | 


--------------------------------------------------------------------------------
/sr_api/lyrics.py:
--------------------------------------------------------------------------------
 1 | class Lyrics:
 2 |     __slots__ = ("title", "author", "lyrics", "thumbnail", "link")
 3 |     def __init__(self, data):
 4 |         self.title = data.get('title')
 5 |         self.author = data.get('author')
 6 |         self.lyrics = data.get('lyrics')
 7 |         self.thumbnail = data.get('thumbnail').get('genius')
 8 |         self.link = data.get('links').get('genius')
 9 |         
10 |         
11 |     def save(self):
12 |         with open(self.title +  ".txt", 'w') as f:
13 |             return f.write(self.lyrics)
14 | 


--------------------------------------------------------------------------------
/sr_api/meme.py:
--------------------------------------------------------------------------------
 1 | import io
 2 | 
 3 | from sr_api.http import HTTPClient
 4 | 
 5 | class Meme:
 6 |     __slots__ = ("id", "image", "caption", "category", "_http_client")
 7 |     def __init__(self, http_client: HTTPClient, data):
 8 |         self.id = data.get('id')
 9 |         self.image = data.get('image')
10 |         self.caption = data.get('caption')
11 |         self.category = data.get('category')
12 |         self._http_client = http_client
13 | 
14 | 
15 |     async def read(self):
16 |         return await self._http_client.get(self.image)
17 | 
18 |     async def save(self, fp, seek_start=True):
19 |         data = await self.read()
20 |         if isinstance(fp, io.IOBase) and fp.writable():
21 |             written = fp.write(data)
22 | 
23 |             if seek_start:
24 |                 fp.seek(0)
25 | 
26 |             return written
27 |         else:
28 |             with open(fp, 'wb') as f:
29 |                 return f.write(data)
30 | 


--------------------------------------------------------------------------------
/sr_api/minecraft.py:
--------------------------------------------------------------------------------
 1 | class Minecraft:
 2 |     __slots__ = ("name", "uuid", "history")
 3 |     def __init__(self, data):
 4 |         self.name = data.get("username")
 5 |         self.uuid = data.get("uuid")
 6 |         self.history = data.get("name_history")
 7 | 
 8 |     @property
 9 |     def formatted_history(self):
10 |         d = self.history
11 |         
12 |         formatted = ""
13 |         for x in d:
14 |             formatted += f"{x['changedToAt'].replace('Origanal', 'Original')} >> {x['name']}\n"
15 |                 
16 |         return formatted
17 |     
18 |     @property
19 |     def reversed_formatted_history(self):
20 |         d = self.history
21 |         
22 |         formatted = ""
23 |         for x in d[::-1]:
24 |             formatted += f"{x['changedToAt'].replace('Origanal', 'Original')} >> {x['name']}\n"
25 |                 
26 |         return formatted
27 | 


--------------------------------------------------------------------------------
/sr_api/options.py:
--------------------------------------------------------------------------------
 1 | class Animal:
 2 |     cat = "cat"
 3 |     dog = "dog"
 4 |     panda = "panda"
 5 |     koala = "koala"
 6 |     fox = "fox"
 7 |     bird = "bird"
 8 |     racoon = "racoon"
 9 |     kangaroo = "kangaroo"
10 |     elephant = "elephant"
11 |     giraffe = "giraffe"
12 |     whale = "whale"
13 |     birb = "birb"
14 |     raccoon = "raccoon"
15 | 
16 | class Gif:
17 |     wink = "wink"
18 |     pat = "pat"
19 |     hug = "hug"
20 |     facepalm = "face-palm"
21 | 
22 | class Filter:
23 |     greyscale = "greyscale"
24 |     invert = "invert"
25 |     invertgreyscale = "invertgreyscale"
26 |     brightness = "brightness"
27 |     threshold = "threshold"
28 |     sepia = "sepia"
29 |     red = "red"
30 |     green = "green"
31 |     blue = "blue"
32 |     blurple = "blurple"
33 |     pixelate = "pixelate"
34 |     blur = "blur"
35 |     gay = "gay"
36 |     glass = "glass"
37 |     wasted = "wasted"
38 |     triggered = "triggered"
39 |     spin = "spin"
40 | 


--------------------------------------------------------------------------------
/sr_api/pokedex.py:
--------------------------------------------------------------------------------
 1 | class Pokedex:
 2 |     __slots__ = ("name", "id", "type", "species", "abilities", "height", "weight", "base_experience", "gender", "egg_groups", "stats", "family", "sprites", "description", "generation")
 3 |     def __init__(self, data):
 4 |         self.name = data.get('name')
 5 |         self.id = data.get('id')
 6 |         self.type = data.get('type')
 7 |         self.species = data.get('species')
 8 |         self.abilities = data.get('abilities')
 9 |         self.height = data.get('height')
10 |         self.weight = data.get('weight')
11 |         self.base_experience = data.get('base_experience')
12 |         self.gender = data.get('gender')
13 |         self.egg_groups = data.get('egg_groups')
14 |         self.stats = data.get('stats')
15 |         self.family = data.get('family')
16 |         self.sprites = data.get('sprites')
17 |         self.description = data.get('description')
18 |         self.generation = data.get('generation')
19 | 
20 |     @property
21 |     def evolutionStage(self):
22 |         return self.family.get('evolutionStage')
23 | 
24 |     @property
25 |     def evolutionLine(self):
26 |         return self.family.get('evolutionLine')
27 | 
28 |     @property
29 |     def spriteNormal(self):
30 |         return self.sprites.get('normal')
31 | 
32 |     @property
33 |     def spriteAnimated(self):
34 |         return self.sprites.get('animated')
35 | 
36 |     @property
37 |     def attack(self):
38 |         return self.stats.get('attack')
39 | 
40 |     @property
41 |     def hp(self):
42 |         return self.stats.get('hp')
43 | 
44 |     @property
45 |     def defense(self):
46 |         return self.stats.get('defense')
47 | 
48 |     @property
49 |     def sp_atk(self):
50 |         return self.stats.get('sp_atk')
51 | 
52 |     @property
53 |     def sp_def(self):
54 |         return self.stats.get('sp_def')
55 | 
56 |     @property
57 |     def speed(self):
58 |         return self.stats.get('speed')
59 | 
60 |     @property
61 |     def total(self):
62 |         return self.stats.get('total')


--------------------------------------------------------------------------------
/sr_api/quote.py:
--------------------------------------------------------------------------------
1 | class Quote:
2 |     __slots__ = ("quote", "character", "anime")
3 |     def __init__(self, data):
4 |         self.quote = data.get('sentence')
5 |         self.character = data.get('characther')
6 |         self.anime = data.get('anime')
7 | 


--------------------------------------------------------------------------------