Skip to main content

A Python wrapper for the Revolt API

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

A simple, flexible API wrapper for Revolt.

Key Features

  • Built on asyncio.

  • Sane rate limit handling that prevents 429s

  • Fast. Really faster than Revolt.py and voltage.

  • Low memory usage.

  • Customizable architecture. Build object parser in Rust to achieve high speeds.

  • Focuses on supporting both, bot and user accounts.

Installing

Python 3.10 or higher is required

To install the library, you can just run the following command:

# Linux/macOS
python3 -m pip install -U pyvolt-re

# Windows
py -3 -m pip install -U pyvolt-re

Or to install alpha master (with all new features):

# Linux/macOS
python3 -m pip install -U git+https://github.com/MCausc78/pyvolt@master

# Windows
py -3 -m pip install -U git+https://github.com/MCausc78/pyvolt@master

Quick Example

from pyvolt import Client

class MyClient(Client):
    async def on_ready(self, _, /):
        print('Logged on as', self.me)

    async def on_message(self, message, /):
        # don't respond to ourselves
        if message.author_id == self.me.id:
            return

        if message.content == 'ping':
            await message.channel.send('pong')

# You can pass `bot=False` to run as user account
client = MyClient(token='token')
client.run()

Bot Example

from pyvolt.ext import commands

# Pass `self_bot=True` to make your bot listen only to you
bot = commands.Bot(command_prefix='!')

@bot.command()
async def ping(ctx):
    await ctx.send('Pong!')

token = 'token'

# That's also allowed, just like in `discord.py`. Pass `bot=False` keyword argument if you want to run as user account.
bot.run(token)

Why Not

  • pyrevolt - Doesn’t follow PEP8 and does a ton of requests on startup (not member list).

  • voltage - Slow and simply copypasta from revolt.py.

  • revolt.py - Slow and unable to disable member list loading.

  • luster - Unmaintained library.

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

pyvolt_re-1.1.0.tar.gz (315.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyvolt_re-1.1.0-py3-none-any.whl (357.3 kB view details)

Uploaded Python 3

File details

Details for the file pyvolt_re-1.1.0.tar.gz.

File metadata

  • Download URL: pyvolt_re-1.1.0.tar.gz
  • Upload date:
  • Size: 315.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for pyvolt_re-1.1.0.tar.gz
Algorithm Hash digest
SHA256 293e42e7272fb939fb9effc7715ee25d441af4e96e66961cc308628bff46751b
MD5 af5f38bbe5c0727f13db7d2e747352b2
BLAKE2b-256 f06a67c7aa049bb41aca905fcbdb0db95ec65e98855dc0d0c0e92bbfc5eee5e3

See more details on using hashes here.

File details

Details for the file pyvolt_re-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: pyvolt_re-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 357.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for pyvolt_re-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 02adc09a973c496d200d4291ef240507a39a323f940921a9c8fb1da1e22ecabc
MD5 5e321dad29533f977d779a2d3d04910b
BLAKE2b-256 ac3f02903b6330ec38205f11de1dc7adb4d267e7f2291aa6d8ed3fe218462678

See more details on using hashes here.

Supported by

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