Metadata-Version: 2.1
Name: revolt.py
Version: 0.1.7
Summary: Python wrapper for the revolt.chat API
Home-page: https://github.com/revoltchat/revolt.py
License: MIT
Keywords: wrapper,async,api,websockets,http
Author: Zomatee
Author-email: me@zomatree.live
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: docs
Provides-Extra: speedups
Requires-Dist: Sphinx (==4.3.2); extra == "docs"
Requires-Dist: aenum (==3.1.8)
Requires-Dist: aiohttp (==3.7.4)
Requires-Dist: msgpack; extra == "speedups"
Requires-Dist: sphinx-nameko-theme (==0.0.3); extra == "docs"
Requires-Dist: sphinx-toolbox (==2.15.2); extra == "docs"
Requires-Dist: typing-extensions (==4.1.1)
Requires-Dist: ujson (==5.1.0); extra == "speedups"
Requires-Dist: ulid-py (==1.1.0)
Project-URL: Bug Tracker, https://github.com/revoltchat/revolt.py/issues
Project-URL: Documentation, https://revoltpy.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/revoltchat/revolt.py/
Description-Content-Type: text/markdown

# Revolt.py

An async library to interact with the https://revolt.chat API.

You can join the support server [here](https://rvlt.gg/FDXER6hr) and find the library's documentation [here](https://revoltpy.readthedocs.io/en/latest/).

## Installing

You can use `pip` to install revolt.py. It differs slightly depending on what OS/Distro you use.

On Windows
```
py -m pip install -U revolt.py # -U to update
```

On macOS and Linux
```
python3 -m pip install -U revolt.py
```

## Example

More examples can be found in the [examples folder](https://github.com/revoltchat/revolt.py/blob/master/examples).

```py
import revolt
import asyncio
import aiohttp

class Client(revolt.Client):
    async def on_message(self, message: revolt.Message):
        if message.content == "hello":
            await message.channel.send("hi how are you")

async def main():
    async with aiohttp.ClientSession() as session:
        client = Client(session, "BOT TOKEN HERE")
        await client.start()

asyncio.run(main())
```

