/luster

Python library for Revolt.chat API.

Primary LanguagePythonMIT LicenseMIT

luster

Python library for Revolt.chat API.

Documentation • Revolt Server • Source Code

⚠️ Acknowledgement

This library is still under active development and incomplete.

Join our Revolt Server for staying tuned with updates.

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

ℹ️ 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.