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 Support Server Documentation Status

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 pyrevolt
# 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

bot = pyrevolt.Bot(prefix="!")

@pyrevolt.ReadySimplified()
async def onReady() -> None:
    print("Ready!")

@bot.on(pyrevolt.GatewayEvent.OnMessage)
async def onMessage(message: pyrevolt.Message) -> None:
    print(f"{message.author.username} said: {message.content}")

@bot.commands.Command(name="ping")
async def ping(message: pyrevolt.Message) -> None:
    await message.Send(content=f"Pong {message.author.username}!", embed=pyrevolt.Embed.Create(title="Pong!", description=f"{message.author.mention}!", colour="#0000ff"), replies=[pyrevolt.Reply(message.messageID, True)])

@bot.commands.Command(name="hello", aliases=["hi"])
async def hello(message: pyrevolt.Message, name: str) -> None:
    await message.Send(content=f"Hello {name}!")
@hello.Error
async def helloError(message: pyrevolt.Message, error: Exception) -> None:
    await message.Send(content=f"{str(error)}")

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 documentation and see how to use the library. If you have any questions, please join the support server and ask for help.

Useful Information

Code Quality

CodeFactor CircleCI

Repository Information

License: MIT 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.2.7a0.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

pyrevolt-0.2.7a0-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyrevolt-0.2.7a0.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.2

File hashes

Hashes for pyrevolt-0.2.7a0.tar.gz
Algorithm Hash digest
SHA256 76b53fe759d9b64bf76a66ee4313cd68d9b54abcb97c3253e19c1082970bcced
MD5 5ec839282e7b3f8a310c4956a55b2668
BLAKE2b-256 5a905bc4b59e0844e8edc181d2345621d28a7a3a9c33a2fb5b826d690e02e5f6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyrevolt-0.2.7a0-py3-none-any.whl
  • Upload date:
  • Size: 19.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.2

File hashes

Hashes for pyrevolt-0.2.7a0-py3-none-any.whl
Algorithm Hash digest
SHA256 9c459c6157d2a4b5bceea9efb569ea1fedfa103994670ba18f33bb0c90d4e1fd
MD5 102718479188e4a79ee4dcf9b218b794
BLAKE2b-256 315e5220ff03c585e90e9e883082cacac858448bace5be0683c855cdfa905fbe

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