texus 2.2.0rc1
A Python wrapper for the Discord API
License: MIT
Requires Python: >=3.8.0

texus
==========

.. image:: https://discord.com/api/guilds/910843156231249990/embed.png
   :target: https://discord.gg/54f7UWNsAJ
   :alt: Discord server invite
.. image:: https://img.shields.io/pypi/v/texus.svg
   :target: https://pypi.python.org/pypi/texus
   :alt: PyPI version info
.. image:: https://img.shields.io/pypi/pyversions/texus.svg
   :target: https://pypi.python.org/pypi/texus
   :alt: PyPI supported Python versions
.. image:: https://img.shields.io/pypi/dm/texus?color=blue
   :target: https://pypi.python.org/pypi/texus
   :alt: PyPI downloads

A fork of discord.py. texus is 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.
- Optimised for both speed and memory usage.
- Supports Slash Commands, Context Menus and Message Components.

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 texus

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

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

.. code:: sh

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

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

To get our speed version With aiohttp speedup run the following command:

.. code:: sh
   
   pip install texus[speed]

To install the development version, do the following:

.. code:: sh

    $ git clone https://github.com/TexusDev/texus
    $ cd texus
    $ python3 -m pip install -U .[voice]


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

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

Please note that while installing voice support on Linux, you must install the following packages via your preferred 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

    bot = discord.Bot()
    
    @bot.slash_command()
    async def hello(ctx, name: str = None):
        name = name or ctx.author.name
        await ctx.respond(f"Hello {name}!")
        
    @bot.user_command(name="Say Hello")
    async def hi(ctx, user):
        await ctx.respond(f"{ctx.author.mention} says hello to {user.name}!")
        
    bot.run("token")

Normal Commands 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.

Note: Make sure you do not reveal your bot token to anyone, it can grant access to your bot.

Links
------

- `Documentation <https://docs.texus.dev/en/master/index.html>`_
- `Official Discord Server <https://discord.gg/54f7UWNsAJ>`_
- `Discord Developers <https://discord.gg/discord-developers>`_
- `Discord API <https://discord.gg/discord-api>`_