Skip to main content

A Python library to wrap the Revolt API, made to be easy-to-use but powerful and feature rich.

Project description

pyrevolt

A Python library to wrap the Revolt API, made to be easy-to-use but powerful and feature rich.

Version Stability

Installing pyrevolt

Python 3.10 or greater is required

To install pyrevolt, you can run the following command:

# Linux/macOS command
python3 -m pip install py   revolt
# Windows
py -m pip install pyrevolt

Using pyrevolt

This shows a very quick example of how to use pyrevolt. As a note, pyrevolt is still under heavy development and this example and the library as a whole may change.

import pyrevolt

@pyrevolt.Ready()
async def onReady(users: dict[pyrevolt.User], channels: dict[pyrevolt.Channel], servers: dict[pyrevolt.Server]) -> None:
    print("Ready!")

@pyrevolt.OnMessage()
async def onMessage(message: pyrevolt.Message) -> None:
    print(f"{message.author.username} said: {message.content}")
    if message.content == "!ping":
        await message.Send(content=f"Pong {message.author.username}!", embeds=[pyrevolt.Embed.Create(title="Pong!", description=f"<@{message.author.userID}>!", colour="#0000ff")])

bot = pyrevolt.Bot()
bot.run(token="TOKEN")

As the library expands, more examples will be added, but we expect users during the very initial development phases to read through the source in order to find how to develop (this will of course change over the development of the library).

Useful Information

Code Quality

CodeFactor CircleCI StyleCI

Repository Information

License: GPL v3 Percentage of issues still open

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyrevolt-0.1.3a0.tar.gz (22.2 kB view details)

Uploaded Source

Built Distribution

pyrevolt-0.1.3a0-py3-none-any.whl (25.0 kB view details)

Uploaded Python 3

File details

Details for the file pyrevolt-0.1.3a0.tar.gz.

File metadata

  • Download URL: pyrevolt-0.1.3a0.tar.gz
  • Upload date:
  • Size: 22.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for pyrevolt-0.1.3a0.tar.gz
Algorithm Hash digest
SHA256 fd7796159dd1399f6852ad9f9b04f89fccea09b8beb6ab7f45510ff303ff4b4e
MD5 1454429da3c9e05a7ae10a988ac7975f
BLAKE2b-256 ed2572e9433422c67678140a65263c005b2f8c4b85513bfd8e3ab443cde60873

See more details on using hashes here.

File details

Details for the file pyrevolt-0.1.3a0-py3-none-any.whl.

File metadata

  • Download URL: pyrevolt-0.1.3a0-py3-none-any.whl
  • Upload date:
  • Size: 25.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for pyrevolt-0.1.3a0-py3-none-any.whl
Algorithm Hash digest
SHA256 29da16034f5620b28fdb7096eb03d61670dac486320b03517a999fe9c5dd0294
MD5 21c049828dc9a8f6e40dd21e685ff4ed
BLAKE2b-256 6c974d69d2d2ca84767d3de5fa6908366ede33af5f871e460cf8705e826ed173

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page