discordtool

Name	discordtool JSON
Version	0.1 JSON
	download
home_page
Summary	A Python wrapper for the discordtool API
upload_time	2023-07-17 16:10:42
maintainer
docs_url	None
author	Pycord Development
requires_python	>=3.8
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            Pycord
======

.. image:: https://img.shields.io/discord/881207955029110855?label=discord&style=for-the-badge&logo=discord&color=5865F2&logoColor=white
   :target: https://pycord.dev/discord
   :alt: Discord server invite
.. image:: https://img.shields.io/pypi/v/py-cord.svg?style=for-the-badge&logo=pypi&color=yellowgreen&logoColor=white
   :target: https://pypi.python.org/pypi/py-cord
   :alt: PyPI version info
.. image:: https://img.shields.io/pypi/pyversions/py-cord.svg?style=for-the-badge&logo=python&logoColor=white
   :target: https://pypi.python.org/pypi/py-cord
   :alt: PyPI supported Python versions
.. image:: https://img.shields.io/pypi/dm/py-cord?color=blueviolet&logo=pypi&logoColor=white&style=for-the-badge
   :target: https://pypi.python.org/pypi/py-cord
   :alt: PyPI downloads
.. image:: https://img.shields.io/github/v/release/Pycord-Development/pycord?include_prereleases&label=Latest%20Release&logo=github&sort=semver&style=for-the-badge&logoColor=white
   :target: https://github.com/Pycord-Development/pycord/releases
   :alt: Latest release

A fork of discord.py. Pycord 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.
- Full Application Command Support

Installing
----------

**Python 3.8 or higher is required**

To install the library without full voice support, run the following command:

.. code:: sh

    # Linux/macOS
    python3 -m pip install -U py-cord

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

Otherwise, to get full voice support, run the following command:

.. code:: sh

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

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

To install additional packages for speedup, run the following command:

.. code:: sh

    # Linux/macOS
    python3 -m pip install -U "py-cord[speed]"
    # Windows
    py -3 -m pip install -U py-cord[speed]


To install the development version, do the following:

.. code:: sh

    $ git clone https://github.com/Pycord-Development/pycord
    $ cd pycord
    $ python3 -m pip install -U .[voice]

or if you do not want to clone the repository:

.. code:: sh

    # Linux/macOS
    python3 -m pip install git+https://github.com/Pycord-Development/pycord
    # Windows
    py -3 -m pip install git+https://github.com/Pycord-Development/pycord


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

* `PyNaCl <https://pypi.org/project/PyNaCl/>`__ (for voice support)
* `aiodns <https://pypi.org/project/aiodns/>`__, `brotlipy <https://pypi.org/project/brotlipy/>`__, `cchardet <https://pypi.org/project/cchardet/>`__ (for aiohttp speedup)
* `orjson <https://pypi.org/project/orjson/>`__ (for json speedup)

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.10-dev`` for Python 3.10)

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")

Traditional Commands Example
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: py

    import discord
    from discord.ext import commands

    intents = discord.Intents.default()
    intents.message_content = True
    bot = commands.Bot(command_prefix=">", intents=intents)

    @bot.command()
    async def ping(ctx):
        await ctx.send("pong")

    bot.run("token")

You can find more code examples in the ``examples`` directory.

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

Useful Links
------------

- `Documentation <https://docs.pycord.dev/en/master/index.html>`_
- `Learn how to create Discord bots with Pycord <https://guide.pycord.dev>`_
- `Our Official Discord Server <https://pycord.dev/discord>`_
- `Official Discord Developers Server <https://discord.gg/discord-developers>`_

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "discordtool",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Pycord Development",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/0d/7e/17057f59d7d48c357a984a7abdb3d7e6c5f78dd7d90cdcf508fb9afad394/discordtool-0.1.tar.gz",
    "platform": null,
    "description": "Pycord\r\n======\r\n\r\n.. image:: https://img.shields.io/discord/881207955029110855?label=discord&style=for-the-badge&logo=discord&color=5865F2&logoColor=white\r\n   :target: https://pycord.dev/discord\r\n   :alt: Discord server invite\r\n.. image:: https://img.shields.io/pypi/v/py-cord.svg?style=for-the-badge&logo=pypi&color=yellowgreen&logoColor=white\r\n   :target: https://pypi.python.org/pypi/py-cord\r\n   :alt: PyPI version info\r\n.. image:: https://img.shields.io/pypi/pyversions/py-cord.svg?style=for-the-badge&logo=python&logoColor=white\r\n   :target: https://pypi.python.org/pypi/py-cord\r\n   :alt: PyPI supported Python versions\r\n.. image:: https://img.shields.io/pypi/dm/py-cord?color=blueviolet&logo=pypi&logoColor=white&style=for-the-badge\r\n   :target: https://pypi.python.org/pypi/py-cord\r\n   :alt: PyPI downloads\r\n.. image:: https://img.shields.io/github/v/release/Pycord-Development/pycord?include_prereleases&label=Latest%20Release&logo=github&sort=semver&style=for-the-badge&logoColor=white\r\n   :target: https://github.com/Pycord-Development/pycord/releases\r\n   :alt: Latest release\r\n\r\nA fork of discord.py. Pycord is a modern, easy to use, feature-rich, and async ready API wrapper for Discord written in Python.\r\n\r\nKey Features\r\n------------\r\n\r\n- Modern Pythonic API using ``async`` and ``await``.\r\n- Proper rate limit handling.\r\n- Optimised for both speed and memory usage.\r\n- Full Application Command Support\r\n\r\nInstalling\r\n----------\r\n\r\n**Python 3.8 or higher is required**\r\n\r\nTo install the library without full voice support, run the following command:\r\n\r\n.. code:: sh\r\n\r\n    # Linux/macOS\r\n    python3 -m pip install -U py-cord\r\n\r\n    # Windows\r\n    py -3 -m pip install -U py-cord\r\n\r\nOtherwise, to get full voice support, run the following command:\r\n\r\n.. code:: sh\r\n\r\n    # Linux/macOS\r\n    python3 -m pip install -U \"py-cord[voice]\"\r\n\r\n    # Windows\r\n    py -3 -m pip install -U py-cord[voice]\r\n\r\nTo install additional packages for speedup, run the following command:\r\n\r\n.. code:: sh\r\n\r\n    # Linux/macOS\r\n    python3 -m pip install -U \"py-cord[speed]\"\r\n    # Windows\r\n    py -3 -m pip install -U py-cord[speed]\r\n\r\n\r\nTo install the development version, do the following:\r\n\r\n.. code:: sh\r\n\r\n    $ git clone https://github.com/Pycord-Development/pycord\r\n    $ cd pycord\r\n    $ python3 -m pip install -U .[voice]\r\n\r\nor if you do not want to clone the repository:\r\n\r\n.. code:: sh\r\n\r\n    # Linux/macOS\r\n    python3 -m pip install git+https://github.com/Pycord-Development/pycord\r\n    # Windows\r\n    py -3 -m pip install git+https://github.com/Pycord-Development/pycord\r\n\r\n\r\nOptional Packages\r\n~~~~~~~~~~~~~~~~~\r\n\r\n* `PyNaCl <https://pypi.org/project/PyNaCl/>`__ (for voice support)\r\n* `aiodns <https://pypi.org/project/aiodns/>`__, `brotlipy <https://pypi.org/project/brotlipy/>`__, `cchardet <https://pypi.org/project/cchardet/>`__ (for aiohttp speedup)\r\n* `orjson <https://pypi.org/project/orjson/>`__ (for json speedup)\r\n\r\nPlease 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:\r\n\r\n* libffi-dev (or ``libffi-devel`` on some systems)\r\n* python-dev (e.g. ``python3.10-dev`` for Python 3.10)\r\n\r\nQuick Example\r\n-------------\r\n\r\n.. code:: py\r\n\r\n    import discord\r\n\r\n    bot = discord.Bot()\r\n\r\n    @bot.slash_command()\r\n    async def hello(ctx, name: str = None):\r\n        name = name or ctx.author.name\r\n        await ctx.respond(f\"Hello {name}!\")\r\n\r\n    @bot.user_command(name=\"Say Hello\")\r\n    async def hi(ctx, user):\r\n        await ctx.respond(f\"{ctx.author.mention} says hello to {user.name}!\")\r\n\r\n    bot.run(\"token\")\r\n\r\nTraditional Commands Example\r\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\n\r\n.. code:: py\r\n\r\n    import discord\r\n    from discord.ext import commands\r\n\r\n    intents = discord.Intents.default()\r\n    intents.message_content = True\r\n    bot = commands.Bot(command_prefix=\">\", intents=intents)\r\n\r\n    @bot.command()\r\n    async def ping(ctx):\r\n        await ctx.send(\"pong\")\r\n\r\n    bot.run(\"token\")\r\n\r\nYou can find more code examples in the ``examples`` directory.\r\n\r\nNote: Make sure you do not reveal your bot token to anyone, as it can grant access to your bot.\r\n\r\nUseful Links\r\n------------\r\n\r\n- `Documentation <https://docs.pycord.dev/en/master/index.html>`_\r\n- `Learn how to create Discord bots with Pycord <https://guide.pycord.dev>`_\r\n- `Our Official Discord Server <https://pycord.dev/discord>`_\r\n- `Official Discord Developers Server <https://discord.gg/discord-developers>`_\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Python wrapper for the discordtool API",
    "version": "0.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0d7e17057f59d7d48c357a984a7abdb3d7e6c5f78dd7d90cdcf508fb9afad394",
                "md5": "1dabcaf3dc6faa3a3ac9b1205d0a330c",
                "sha256": "a27cf4be4155362cdcbdb29679e6e0a83ad6f4129f235d85e717f755ec987f0a"
            },
            "downloads": -1,
            "filename": "discordtool-0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "1dabcaf3dc6faa3a3ac9b1205d0a330c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 940695,
            "upload_time": "2023-07-17T16:10:42",
            "upload_time_iso_8601": "2023-07-17T16:10:42.272573Z",
            "url": "https://files.pythonhosted.org/packages/0d/7e/17057f59d7d48c357a984a7abdb3d7e6c5f78dd7d90cdcf508fb9afad394/discordtool-0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-17 16:10:42",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "discordtool"
}