dis

disnake

An API wrapper for Discord written in Python.

Showing:

Popularity

Downloads/wk

0

GitHub Stars

103

Maintenance

Last Commit

2d ago

Contributors

336

Package

Dependencies

9

License

MIT

Categories

Readme

disnake

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

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

Warning

The library is still in development and isn't usable yet. We hope to publish a stable release before the 10th of september.

About disnake

All the contributors and developers, associated with disnake, are trying their best to add new features to the library as soon as possible. We strive to revive the greatest Python wrapper for Discord API and keep it up to date.

Key Features

  • Modern Pythonic API using async and await.
  • Added features for ease of coding
  • 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 disnake

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

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

.. code:: sh

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

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

To install the development version, do the following:

.. code:: sh

$ git clone https://github.com/EQUENOS/disnake
$ cd disnake
$ 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.6-dev`` for Python 3.6)

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

.. code:: py

    import disnake

    class MyClient(disnake.Client):
        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 disnake
    from disnake.ext import commands

    bot = commands.Bot(command_prefix='>')

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

    bot.run('token')

Slash Commands Example

.. code:: py

import disnake
from disnake.ext import commands

bot = commands.Bot(command_prefix='>', test_guilds=[12345])

@bot.slash_command()
async def ping(inter):
    await inter.response.send_message('pong')

bot.run('token')

You can find more examples in the examples directory.

Making your application more efficient

As your application scales, you may need to adjust some things to keep it performing nicely.

Python optimisation flags


CPython provides two optimisation flags that remove internal safety
checks that are useful for development, and change other internal
settings in the interpreter.

-  ``python bot.py`` - no optimisation - this is the default.
-  ``python -O bot.py`` - first level optimisation - features such as
   internal assertions will be disabled.
-  ``python -OO bot.py`` - second level optimisation - more features
   (**including all docstrings**) will be removed from the loaded code
   at runtime.

**A minimum of first level of optimizations** is recommended when
running bots in a production environment.

``disnake[speed]``
~~~~~~~~~~~~~~~~~~

If you have a C compiler (Microsoft VC++ Redistributable 14.0 or newer,
or a modern copy of GCC/G++, Clang, etc), you can install Disnake using
``pip install -U disnake[speed]``. This will install ``aiodns``,
``cchardet`` & ``Brotli`` which will provide you with a small
performance boost.

``uvloop``
~~~~~~~~~~

If you use a UNIX-like system, you will get additional performance
benefits from using a library called ``uvloop``. This replaces the
default ``asyncio`` event loop with one that uses ``libuv`` internally.
You can run ``pip install uvloop`` and then amend your script to be
something similar to the following example to utilise it in your
application:

.. code:: py

    import os
    from disnake.ext import commands

    if os.name != "nt":
        import uvloop
        uvloop.install()

    bot = commands.Bot(...)

    ...

Links
------

- `Documentation <http://disnake.rtfd.io/>`_
- `Official Discord Server <https://discord.gg/gJDbCw8aQy>`_
- `Discord API <https://discord.gg/discord-api>`_

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100