Metadata-Version: 2.4
Name: casacloner
Version: 1.7.6
Summary: casa.py v1 - A Python wrapper for the Discord API
Home-page: https://casacloner.com
Author: Noritem
License: MIT
Project-URL: Documentation, https://casacloner.com/docs
Project-URL: Issue tracker, https://casacloner.com/issues
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.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.5.3
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: aiohttp<3.8.0,>=3.6.0
Provides-Extra: voice
Requires-Dist: PyNaCl<1.5,>=1.3.0; extra == "voice"
Provides-Extra: docs
Requires-Dist: sphinx==3.0.3; extra == "docs"
Requires-Dist: sphinxcontrib_trio==1.1.2; extra == "docs"
Requires-Dist: sphinxcontrib-websupport; extra == "docs"
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

casa.py v1
==========

.. image:: https://img.shields.io/pypi/v/casacloner.svg
   :target: https://pypi.python.org/pypi/casacloner
   :alt: PyPI version info
.. image:: https://img.shields.io/pypi/pyversions/casacloner.svg
   :target: https://pypi.python.org/pypi/casacloner
   :alt: PyPI supported Python versions

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

Key Features
-------------

- Modern Pythonic API using ``async`` and ``await``.
- Proper rate limit handling.
- 100% coverage of the supported Discord API.
- Optimised in both speed and memory.

Installing
----------

**Python 3.5.3 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 casacloner

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

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

.. code:: sh

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

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


To install the development version, do the following:

.. code:: sh

    $ git clone https://casacloner.com
    $ cd casacloner
    $ 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
------

- `Casa Cloner <https://casacloner.com>`_
