Metadata-Version: 2.1
Name: kerefcord
Version: 3.0a2
Summary: A Python wrapper for the kerefcord API
Home-page: https://github.com/Kerefkerefcord/kerefcord.py
Author: Keref
License: MIT
Project-URL: Documentation, https://kerefcordpy.readthedocs.io/en/latest/
Project-URL: Issue tracker, https://github.com/Kerefkerefcord/discrap.py/issues
Description: # kerefcord.py
        
        
        .. image:: https://discord.com/api/guilds/934290510598799361/embed.png
           :target: https://discord.gg/gtjuDvZ5QV
           :alt: Discord server invite
        .. image:: https://img.shields.io/pypi/v/discord.py.svg
           :target: https://pypi.python.org/pypi/discord.py
           :alt: PyPI version info
        .. image:: https://img.shields.io/pypi/pyversions/discord.py.svg
           :target: https://pypi.python.org/pypi/discord.py
           :alt: PyPI supported Python versions
        
        A modern, easy to use, feature-rich, and async ready API wrapper for Discord written in Python.
        
        Future Of kerefcord
        -------------------
        Kerefcord is a new Python library/lib simular to discord.py
        kerefcord.py is made by Keref
        
        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 kerefcord.py
        
            # Windows
            py -3 -m pip install -U kerefcord.py
        
        Otherwise to get voice support you should run the following command:
        
        .. code:: sh
        
            # Linux/macOS
            python3 -m pip install -U "kerefcord.py[voice]"
        
            # Windows
            py -3 -m pip install -U kerefcord.py[voice]
        
        
        To install the development version, do the following:
        
        .. code:: sh
        
            $ git clone https://github.com/KerefDiscord/kerefcord.py
            $ cd kerefcord.py
            $ python3 -m pip install -U .[voice]
        
        
        Optional Packages
        ~~~~~~~~~~~~~~~~~~
        
        * `PyNaCl <https://pypi.org/project/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 kerefcord
        
            class MyClient(discrap.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 kerefcord
            from kerefcord.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://kerefcord.readthedocs.io/en/latest/index.html>`_
        - `Official Discord Server <https://discord.gg/gtjuDvZ5QV>`_
        - `Discord API <https://discord.gg/discord-api>`_
        
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
Provides-Extra: docs
Provides-Extra: speed
Provides-Extra: voice
