bavera

Bavera

.. image:: https://discord.com/api/guilds/908591684428918785/embed.png :target: https://discord.gg/8vrHAqWgYR :alt: Discord server invite .. image:: https://img.shields.io/pypi/v/bavera.svg :target: https://pypi.python.org/pypi/bavera :alt: PyPI version info .. image:: https://img.shields.io/pypi/pyversions/bavera.svg :target: https://pypi.python.org/pypi/bavera :alt: PyPI supported Python versions

A modern, easy to use, feature-rich, and async ready API wrapper for Discord written in Python.

Key Features

• Modern Pythonic API using async and await.
• Proper rate limit handling.
• Optimised in both speed and memory.

Installing

Python 3.8 or higher is required

To install the library without full voice support, you can just run the following command:

.. code:: sh

# Linux/macOS
python3 -m pip install -U bavera

# Windows
py -3 -m pip install -U bavera

Otherwise to get voice support you should run the following command:

.. code:: sh

# Linux/macOS
python3 -m pip install -U "bavera[voice]"

# Windows
py -3 -m pip install -U bavera[voice]

To install the speed version with additional speedups run the following command:

.. code:: sh

# Linux/MacOS
python3 -m pip install -U bavera[speed]

# Windows
py -3 -m pip install -U bavera[speed]

To install the development version, do the following:

.. code:: sh

$ git clone https://github.com/bavera/bavera
$ cd bavera
$ python3 -m pip install -U .[voice]

Optional Packages

* `PyNaCl <https://pypi.org/project/PyNaCl/>`__ (for voice support)

Please note that on Linux installing voice you must install the following packages via your favourite package manager (e.g. ``apt``, ``dnf``, etc) before running the above commands:

* libffi-dev (or ``libffi-devel`` on some systems)
* python-dev (e.g. ``python3.8-dev`` for Python 3.8)

Quick Example
--------------

.. code:: py

    import bavera

    class MyClient(bavera.Plugin):
        async def on_ready(self):
            print('Logged on as', self.user)

        async def on_message(self, message):
            # don't respond to ourselves
            if message.author == self.user:
                return

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

    client = MyClient()
    client.run('token')

Bot Example
~~~~~~~~~~~~~

.. code:: py

    import bavera
    import plugins
    from plugins import commands

    Plugger = commands.Plugger(command_prefix='>')

    @Plugger.command()
    async def ping(ctx):
        await ctx.send('pong')

    Plugger.run('token')

You can find more examples in the examples directory.

Links
------

- `Documentation <https://bavera.readthedocs.io/en/latest/index.html>`_
- `Official Discord Server <https://discord.gg/8vrHAqWgYR>`_
- `Discord API <https://discord.gg/discord-api>`_