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}!", embeds=[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.6a0.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pyrevolt-0.2.6a0.tar.gz
Algorithm Hash digest
SHA256 48bdab775141d27cae25f4ad89f28f49c51869b64b0653801ca811cfb9b8cf42
MD5 4ff1b2f72082e4ee316ff856a8e29733
BLAKE2b-256 5787054fe7c82220bd9c7404925f6383ad89958f09833c332c3546c5896c9e66

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyrevolt-0.2.6a0-py3-none-any.whl
  • Upload date:
  • Size: 19.1 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.2.6a0-py3-none-any.whl
Algorithm Hash digest
SHA256 2b8db64ea3edad4b810de37889549c245209300873081b9fc6eecb1a15a06e5f
MD5 4dc7f3a9d2b998a5fd59bdf299a8924e
BLAKE2b-256 bb2ca35baa9d1c231fb81e354d857ce2f323e20bdaca2cfbd324537b8214a9a5

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