Metadata-Version: 2.1
Name: discord.py-fork
Version: 2.0.0a0
Summary: A fork of an Python wrapper for the Discord API
Home-page: https://github.com/veni-vidi-code/discord.py
Author: veni-vidi-code
License: MIT
Project-URL: Documentation, https://discordpy-fork.readthedocs.io
Project-URL: Issue tracker, https://github.com/veni-vidi-code/discord.py/issues
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.8.0
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: aiohttp (<3.8.0,>=3.6.0)
Provides-Extra: docs
Requires-Dist: sphinx (==4.0.2) ; extra == 'docs'
Requires-Dist: sphinxcontrib-trio (==1.1.2) ; extra == 'docs'
Requires-Dist: sphinxcontrib-websupport ; extra == 'docs'
Provides-Extra: speed
Requires-Dist: orjson (>=3.5.4) ; extra == 'speed'
Provides-Extra: voice
Requires-Dist: PyNaCl (<1.5,>=1.3.0) ; extra == 'voice'

discord.py-fork
===============


.. image:: https://img.shields.io/pypi/v/discord.py-fork-vvc.svg
   :target: https://pypi.org/project/discord.py-fork-vvc/
   :alt: PyPI version info
.. image:: https://img.shields.io/pypi/pyversions/discord.py-fork-vvc.svg
   :target: https://pypi.org/project/discord.py-fork-vvc/
   :alt: PyPI supported Python versions

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

The Future of discord.py
--------------------------

Please read the `gist <https://gist.github.com/Rapptz/4a2f62751b9600a31a0d3c78100287f1>`_ for the future of the original project. This is just a fork of it. feel free to contribute in order of keeping it alife!

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 discord.py-fork-vvc

    # Windows
    py -3 -m pip install -U discord.py-fork-vvc

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

.. code:: sh

    # Linux/macOS
    python3 -m pip install -U "discord.py-fork-vvc[voice]"

    # Windows
    py -3 -m pip install -U discord.py-fork-vvc[voice]


To install the development version, do the following:

.. code:: sh

    $ git clone https://github.com/veni-vidi-code/discord.py
    $ cd discord.py
    $ python3 -m pip install -U .[voice]


Optional Packages
~~~~~~~~~~~~~~~~~~

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

Please note that i will not fork this package and do not plan on doing so.
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 <https://discordpy-fork.readthedocs.io>`_
- `Discord API <https://discord.gg/discord-api>`_


