Metadata-Version: 2.1
Name: diskord
Version: 2.0.0
Summary: A Python wrapper for the Discord API
Home-page: https://github.com/nerdguyahmad/diskord
Author: NerdGuyAhmad
License: MIT
Project-URL: Documentation, https://diskord.readthedocs.io/en/latest/
Project-URL: Issue tracker, https://github.com/nerdguyahmad/diskord/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/markdown
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'

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

This library is a maintained and work-in-progress fork of the popular library, [discord.py](https://github.com/Rapptz/discord.py) which was discontinued on August 28th, 2021. You can see more [here](https://gist.github.com/Rapptz/4a2f62751b9600a31a0d3c78100287f1).

## Key features
* Modern Pythonic API using `async` and `await`.
* Proper rate limit handling.
* Optimised in both speed and memory.
* Actively maintained
* Implements the entire Discord API

## Installation
**Python 3.8 or higher** is required

To install the library **without** full voice support, you can just run the following command:
```sh
# Linux/macOS
python3 -m pip install -U diskord

# Windows
py -3 -m pip install -U diskord
```
Otherwise to get voice support you should run the following command:

```sh
# Linux/macOS
python3 -m pip install -U "diskord[voice]"

# Windows
py -3 -m pip install -U diskord[voice]
```
To install the development version, do the following:

```sh
$ git clone https://github.com/nerdguyahmad/diskord
$ cd discord.py
$ 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
```py
import diskord

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
```py
import diskord
from diskord.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://diskord.readthedocs.io/en/latest/index.html)
* [Official Discord Server](https://dsc.gg/diskord-dev)
* [Discord API](https://discord.gg/discord-api)


