Metadata-Version: 2.1
Name: diskord
Version: 2.5.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'

<div align="center">
    <img src="docs/images/diskord-banner.PNG">
    <h1>Diskord</h1>
    <img src="https://pepy.tech/badge/diskord">
    <img src="https://img.shields.io/static/v1?label=maintained?&message=Yes&color=brightgreen">
    <img src="https://canary.discord.com/api/guilds/887217168276656188/embed.png">
    <img src="https://readthedocs.org/projects/diskord/badge">
    <hr>
    <sup>This library is a maintained fork of the popular and now archived library, <a href="https://github.com/Rapptz/discord.py">discord.py</a>.</sup>
    <p>
        A modern, easy to use, feature-rich, and async ready API wrapper around Discord API written in Python.
        <br><br>
    </p>
</div>

## Key features
* Modern Pythonic API using `async` / `await`.
* Proper and sane rate limit handling.
* Optimised in both speed and memory.
* Provides full coverage of Discord API including Interactions i.e Slash Commands.
* Prebuilt Commands building framework to aid in bot development
* Easy-to-use object oriented design
* Actively maintained & updated

## Installation

**Python 3.8 or higher** is required to use this library.

### Basic Installation
To install the library **without** full voice support, you can just run the following command:
```sh
python -m pip install diskord
```

### Voice Support
Optionally, To interact with discord's voice API, You would require voice support of this library which you can install like so:
```sh
python -m pip install diskord[voice]
```

### Development Version
**Please beware that development version is not guaranteed to be stable. There can be breaking changes and potentially critical bugs. Use with cautions.**

You must have git installed to install development version. Otherwise, you can download the code.
```sh
$ git clone https://github.com/nerdguyahmad/diskord
$ cd diskord
$ python3 -m pip install -U .[voice]
```

### Optional Packages
* PyNaCl (for voice support, This is usually handled by pip when [installing voice support](#voice-support))

### Linux Installation

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
Here are some quick examples to give you a quickstart and show off the basic features of the library.

### Application (Slash) Commands
```py
import diskord

client = diskord.Client()

@client.slash_command(description='Ping-Pong!')
async def ping(ctx):
    await ctx.send('Pong!')

client.run('token')
```

### Legacy (Prefixed) Commands
```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)
* [Developer Portal](https://developer.discord.com/applications)


