https://github.com/Voxel-Fox-Ltd/Novus

An asyncio Python wrapper around the Discord API, forked off of Rapptz's Discord.py.
https://github.com/Voxel-Fox-Ltd/Novus

discord discord-bot discord-py hacktoberfest novus

Last synced: about 1 month ago
JSON representation

An asyncio Python wrapper around the Discord API, forked off of Rapptz's Discord.py.

• Host: GitHub
• URL: https://github.com/Voxel-Fox-Ltd/Novus
• Owner: Voxel-Fox-Ltd
• License: mit
• Created: 2021-08-30T05:54:34.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-22T17:45:55.000Z (about 2 months ago)
• Last Synced: 2024-07-23T19:08:16.613Z (about 2 months ago)
• Topics: discord, discord-bot, discord-py, hacktoberfest, novus
• Language: Python
• Homepage:
• Size: 12.2 MB
• Stars: 62
• Watchers: 4
• Forks: 13
• Open Issues: 17
• Metadata Files:
  • Readme: README.rst
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-discordpy - Novus - An asyncio Python wrapper around the Discord API, forked off of Rapptz's Discord.py. (Forks and Wrappers / Miscellaneous)

README

        
Novus

==========

.. image:: https://discord.com/api/guilds/208895639164026880/embed.png

   :target: https://discord.gg/vfl

   :alt: Discord server invite

.. image:: https://img.shields.io/pypi/v/novus.svg

   :target: https://pypi.python.org/pypi/novus

   :alt: PyPI version info

.. image:: https://img.shields.io/pypi/pyversions/novus.svg

   :target: https://pypi.python.org/pypi/novus

   :alt: PyPI supported Python versions

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

A full fork of Rapptz's Discord.py library, with new features added on top.

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 novus

    # Windows

    py -3 -m pip install -U novus

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

.. code:: sh

    # Linux/macOS

    python3 -m pip install -U "novus[voice]"

    # Windows

    py -3 -m pip install -U novus[voice]

To install the development version, do the following:

.. code:: sh

    $ git clone https://github.com/Voxel-Fox-Ltd/novus

    $ cd novus

    $ python3 -m pip install -U .[voice]

Optional Packages

~~~~~~~~~~~~~~~~~~

* `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 discord

    class MyClient(discord.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 discord

    from discord.ext import commands

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

    @bot.command()

    async def ping(ctx):

        await ctx.send('pong')

    bot.run('token')

You can find more examples in the examples directory.

Links

------

- `Documentation `_

- `Official Discord Server `_