Name | py-cord JSON |
Version |
2.6.1
JSON |
| download |
home_page | None |
Summary | A Python wrapper for the Discord API |
upload_time | 2024-09-15 19:36:39 |
maintainer | None |
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 API 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)
* `msgspec <https://pypi.org/project/msgspec/>`__ (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": null,
"name": "py-cord",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Pycord Development",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/27/c7/c539d69d5cfa1ea5891d596212f73d619e40c7fc9f02ae906f4147993b94/py_cord-2.6.1.tar.gz",
"platform": null,
"description": "Pycord\n======\n\n.. image:: https://img.shields.io/discord/881207955029110855?label=discord&style=for-the-badge&logo=discord&color=5865F2&logoColor=white\n :target: https://pycord.dev/discord\n :alt: Discord server invite\n.. image:: https://img.shields.io/pypi/v/py-cord.svg?style=for-the-badge&logo=pypi&color=yellowgreen&logoColor=white\n :target: https://pypi.python.org/pypi/py-cord\n :alt: PyPI version info\n.. image:: https://img.shields.io/pypi/pyversions/py-cord.svg?style=for-the-badge&logo=python&logoColor=white\n :target: https://pypi.python.org/pypi/py-cord\n :alt: PyPI supported Python versions\n.. image:: https://img.shields.io/pypi/dm/py-cord?color=blueviolet&logo=pypi&logoColor=white&style=for-the-badge\n :target: https://pypi.python.org/pypi/py-cord\n :alt: PyPI downloads\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\n :target: https://github.com/Pycord-Development/pycord/releases\n :alt: Latest release\n\nA fork of discord.py. Pycord is a modern, easy to use, feature-rich, and async ready API wrapper for Discord written in Python.\n\nKey Features\n------------\n\n- Modern Pythonic API using ``async`` and ``await``.\n- Proper rate limit handling.\n- Optimised for both speed and memory usage.\n- Full application API support.\n\nInstalling\n----------\n\n**Python 3.8 or higher is required**\n\nTo install the library without full voice support, run the following command:\n\n.. code:: sh\n\n # Linux/macOS\n python3 -m pip install -U py-cord\n\n # Windows\n py -3 -m pip install -U py-cord\n\nOtherwise, to get full voice support, run the following command:\n\n.. code:: sh\n\n # Linux/macOS\n python3 -m pip install -U \"py-cord[voice]\"\n\n # Windows\n py -3 -m pip install -U py-cord[voice]\n\nTo install additional packages for speedup, run the following command:\n\n.. code:: sh\n\n # Linux/macOS\n python3 -m pip install -U \"py-cord[speed]\"\n # Windows\n py -3 -m pip install -U py-cord[speed]\n\n\nTo install the development version, do the following:\n\n.. code:: sh\n\n $ git clone https://github.com/Pycord-Development/pycord\n $ cd pycord\n $ python3 -m pip install -U .[voice]\n\nor if you do not want to clone the repository:\n\n.. code:: sh\n\n # Linux/macOS\n python3 -m pip install git+https://github.com/Pycord-Development/pycord\n # Windows\n py -3 -m pip install git+https://github.com/Pycord-Development/pycord\n\n\nOptional Packages\n~~~~~~~~~~~~~~~~~\n\n* `PyNaCl <https://pypi.org/project/PyNaCl/>`__ (for voice support)\n* `aiodns <https://pypi.org/project/aiodns/>`__, `brotlipy <https://pypi.org/project/brotlipy/>`__, `cchardet <https://pypi.org/project/cchardet/>`__ (for aiohttp speedup)\n* `msgspec <https://pypi.org/project/msgspec/>`__ (for json speedup)\n\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:\n\n* libffi-dev (or ``libffi-devel`` on some systems)\n* python-dev (e.g. ``python3.10-dev`` for Python 3.10)\n\nQuick Example\n-------------\n\n.. code:: py\n\n import discord\n\n bot = discord.Bot()\n\n @bot.slash_command()\n async def hello(ctx, name: str = None):\n name = name or ctx.author.name\n await ctx.respond(f\"Hello {name}!\")\n\n @bot.user_command(name=\"Say Hello\")\n async def hi(ctx, user):\n await ctx.respond(f\"{ctx.author.mention} says hello to {user.name}!\")\n\n bot.run(\"token\")\n\nTraditional Commands Example\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: py\n\n import discord\n from discord.ext import commands\n\n intents = discord.Intents.default()\n intents.message_content = True\n bot = commands.Bot(command_prefix=\">\", intents=intents)\n\n @bot.command()\n async def ping(ctx):\n await ctx.send(\"pong\")\n\n bot.run(\"token\")\n\nYou can find more code examples in the ``examples`` directory.\n\nNote: Make sure you do not reveal your bot token to anyone, as it can grant access to your bot.\n\nUseful Links\n------------\n\n- `Documentation <https://docs.pycord.dev/en/master/index.html>`_\n- `Learn how to create Discord bots with Pycord <https://guide.pycord.dev>`_\n- `Our Official Discord Server <https://pycord.dev/discord>`_\n- `Official Discord Developers Server <https://discord.gg/discord-developers>`_\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python wrapper for the Discord API",
"version": "2.6.1",
"project_urls": {
"Changelog": "https://docs.pycord.dev/en/master/changelog.html",
"Documentation": "https://docs.pycord.dev",
"Funding": "https://patreon.com/pycord",
"Homepage": "https://pycord.dev",
"Source": "https://github.com/Pycord-Development/pycord",
"Tracker": "https://github.com/Pycord-Development/pycord/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e7902690ded84e34b15ca2619932a358c1b7dc6d28fe845dfbd01929fc33c9da",
"md5": "4148999dd714672facf41fa484eb2407",
"sha256": "e3d3b528c5e37b0e0825f5b884cbb9267860976c1e4878e28b55da8fd3af834b"
},
"downloads": -1,
"filename": "py_cord-2.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4148999dd714672facf41fa484eb2407",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1089154,
"upload_time": "2024-09-15T19:36:35",
"upload_time_iso_8601": "2024-09-15T19:36:35.340277Z",
"url": "https://files.pythonhosted.org/packages/e7/90/2690ded84e34b15ca2619932a358c1b7dc6d28fe845dfbd01929fc33c9da/py_cord-2.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "27c7c539d69d5cfa1ea5891d596212f73d619e40c7fc9f02ae906f4147993b94",
"md5": "f81a057663feeaa122f8506d9961d8dc",
"sha256": "36064f225f2c7bbddfe542d5ed581f2a5744f618e039093cf7cd2659a58bc79b"
},
"downloads": -1,
"filename": "py_cord-2.6.1.tar.gz",
"has_sig": false,
"md5_digest": "f81a057663feeaa122f8506d9961d8dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 965087,
"upload_time": "2024-09-15T19:36:39",
"upload_time_iso_8601": "2024-09-15T19:36:39.245941Z",
"url": "https://files.pythonhosted.org/packages/27/c7/c539d69d5cfa1ea5891d596212f73d619e40c7fc9f02ae906f4147993b94/py_cord-2.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-15 19:36:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Pycord-Development",
"github_project": "pycord",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "py-cord"
}