semvec/pypi-packages huggingface dataset:
cat.py 1.1.3
"The Cat Api" async api wrapper in python.
Keywords: cats,api wrapper,thecatapi

# cat.py
["The ](https://bit.ly/2EqoBMo)[cat ](thecatapi.comthecatapi.com)[api  "](https://bit.ly/2EqoBMohttps://bit.ly/2EqoBMo) async api wrapper in python

## Installation

```pip install -U cat.py```

## Getting Started

### Setting your Client

Set your own client by first getting an apikey at [```thecatapi```](https://thecatapi.com)

```python
import asyncio
from cat import Client

def main():
  neko = Client("my_api_key")
  ...
  
  await neko.close()
  
asyncio.run(main())
```

### Examples

#### Getting cat

Getting five cats in page 1 in ascending order.

```python
  cat = await neko.get_cat(5, 1, "asc")
```

#### Getting cat by breed

Getting cyprus breeded cat.

```python
  cat = await neko.get_cat_breed("Cyprus")
```

#### Getting cat by category

Getting all cats in the category 69. Sadly there is None.

```python
  cat = await neko.get_cat_category(69)
```

#### Getting cat by image type

Getting cat with the gif type image.

```python
  cat = await neko.get_cat_image_type("gif")
```