Metadata-Version: 2.4
Name: cataas
Version: 0.1.0
Summary: A unofficial Python wrapper for the CataaS REST API.
Author-email: happycappa <280617573+happycappa@users.noreply.github.com>
License: MIT
Project-URL: Homepage, https://github.com/happycappa/cataas
Project-URL: Source, https://github.com/happycappa/cataas/tree/main/src/cataas
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.34.2
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Dynamic: license-file

# Unofficial CataaS Python Wrapper
This is an unofficial Python wrapper for the CataaS _(Cat as a Service)_ REST API.  
Here is it's offical website: https://cataas.com/

I created this since i'm pretty bored and I don't wanna keep having to use the python [requests](https://github.com/psf/requests) package everytime I want to use the CataaS API!

## Why would I want to use this?
You can use this, like me, to have a shortcut on using the CataaS API in Python without needing to  
import the [requests](https://github.com/psf/requests) library everytime, which i'd say is a better upgrade than the harder way.

# Usage
Here's some examples on how to use this package:

1. Getting a cat image
```python
import cataas

cat = cataas.cat()
print(cat)

# Returns a normal cat image by URL

cat = cataas.catsays('Hello world!')
print(cat)

# Returns a cat image that has text by URL
# Filters are supported too!

cat = cataas.cat(width=500, height=700) # Kwargs are included
print(cat)

# Returns a cat image thats (probably) exactly 500 by 700 pixels!
```

2. Getting a cat gif
```python
import cataas

cat = cataas.catgif()
print(cat)

# Returns a normal cat gif by URL
# Note: The normal catgif function doesn't support filters, but the says version does!

cat = cataas.catgif_says('Hello world!')
print(cat)

# Returns a cat gif that has text by URL
```

Other functions are included too but i'm too lazy to explain them.

# Credits

1. me (happycappa)  
2. no one else (this is a solo package)
