Description:
luster 0.1.0a2
luster
Python library for Revolt.chat API.
Documentation • Revolt Server • Source Code
:warning: Acknowledgement
This library is not yet complete and is currently in it's early development stage.
Do not use this for production yet. Expect bugs and other issues. The library is
is in active development and will be complete and production ready soon.
Join our Revolt Server
Features
Modern and easy to use interface
Fully typed and compatible with most type checkers
Supports operations with both bots and users API
Provides maximum control over the low level API
Type definitions for Revolt API
Installation
You can install this library using the Python's traditional package manager, pip.
$ pip install luster
Note that Python 3.8 or higher is required.
The only required dependency for this library is aiohttp. There are certain dependencies
that you can install in order to enhance the speed of the library.
msgpack (Faster websocket packets parsing)
ujson (Faster JSON parsing)
aiohttp[speed] (Speed ups for aiohttp)
These dependencies can be installed by:
$ pip install luster[speed]
Basic Usage
:information_source: Type annotations are not required.
import luster
client = luster.Client(token="...")
@client.listen(luster.WebsocketEvent.AUTHENTICATED)
async def handle_authenticated(event: luster.events.Authenticated):
print("Client has connected!")
client.launch()
Basic operations such as sending messages are not yet supported. You
can use the low level API such as HTTPHandler and WebsocketHandler
to manually interact with Revolt API.
Contributing
This library is still in it's alpha (0.x) phase and is undergoing active development to
provide 100% coverage of Revolt API. Any kind of contribution is welcomed.
See Contribution guidelines for
more information.
License
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
Customer Reviews
There are no reviews.
