semvec/pypi-packages huggingface dataset:
frankerfacez 1.3.1
A Python wrapper for FrankerFaceZ API.
Requires Python: >=3.6

FrankerFaceZ
============
[![pypi version](https://img.shields.io/pypi/v/frankerfacez "Version") ![python version](https://img.shields.io/pypi/pyversions/frankerfacez "Support")](https://pypi.org/project/frankerfacez) [![Tests state](https://github.com/uKaigo/frankerfacez/workflows/Tests/badge.svg) ![license](https://img.shields.io/pypi/l/frankerfacez "License")](https://github.com/uKaigo/frankerfacez)

An async API wrapper for [FrankerFaceZ](https://frankerfacez.com) written in Python.

Installing
----------
**Python 3.6+ is required.**

To install this library, you can run the following command:
```sh
python -m pip install -U frankerfacez
```

To install the development version, run:
```sh
git clone https://github.com/uKaigo/frankerfacez
cd frankerfacez
python -m pip install -U .
```

Examples
--------
Gets the emote with ID 1:
```python
>>> import ffz
>>> import asyncio

>>> client = ffz.Client() # Creation inside async function is recommended.

>>> emote = await client.get_emote(1)

<ffz.Emote name="ZreknarF" id=1 owner=<ffz.models.User name="dansalvato" id=2 display_name="dansalvato" twitch_id=None donator=None>>
```
(This is just an example, that's not how you run async code)

Documentation
-------------
_Under developing_

What's new
----------
* Model is now an ABC.
* Added logging.
* Now you can compare any model with **==**, it checks the model's id and type.
* Removed `exceptions.InvalidContent`.
* Client.search_emote's "limit" and "sort" parameters are now kwargs.
* Added `ffz.version_info`, similar to [sys.version_info](https://docs.python.org/3/library/sys.html#sys.version_info).