ezcord.py


Nameezcord.py JSON
Version 0.6.4 PyPI version JSON
download
home_pageNone
SummaryAn easy-to-use extension for Discord.py and Pycord
upload_time2024-06-06 13:27:15
maintainerNone
docs_urlNone
authorcodestantin
requires_python>=3.9
licenseMIT
keywords discord pycord py-cord discord.py
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![EzCord](https://ezcord.readthedocs.io/en/latest/_static/ezcord.png)](https://github.com/tibue99/ezcord)

[![](https://img.shields.io/discord/1010915072694046794?label=discord&style=for-the-badge&logo=discord&color=5865F2&logoColor=white)](https://discord.gg/zfvbjTEzv6)
[![](https://img.shields.io/pypi/v/ezcord.svg?style=for-the-badge&logo=pypi&color=yellow&logoColor=white)](https://pypi.org/project/ezcord/)
[![](https://img.shields.io/pypi/l/ezcord?style=for-the-badge)](https://github.com/tibue99/ezcord/blob/main/LICENSE)
[![](https://aschey.tech/tokei/github/tibue99/ezcord?style=for-the-badge)](https://github.com/tibue99/ezcord)

An easy-to-use extension for [Discord.py](https://github.com/Rapptz/discord.py)
and [Pycord](https://github.com/Pycord-Development/pycord) with some utility functions.

## Features
### ✏️ Reduce boilerplate code
- Easy cog management
- Embed templates
- Datetime and file utilities
- Wrapper for [aiosqlite](https://github.com/omnilib/aiosqlite) and [asyncpg](https://github.com/MagicStack/asyncpg)

### ✨ Error handling
- Automatic error handling for slash commands
- Error webhook reports
- Custom logging

### 📚 i18n
- Slash command translation (groups, options, choices)
- Translate messages, embeds, views, modals and more

### ⚙️ Extensions
- **Help command** - Automatically generate a help command for your bot
- **Status changer** - Change the bot's status in an interval
- **Blacklist** - Block users from using your bot

## Installing
Python 3.9 or higher is required.
```
pip install ezcord
```
You can also install the latest version from GitHub. Note that this version may be unstable
and requires [git](https://git-scm.com/downloads) to be installed.
```
pip install git+https://github.com/tibue99/ezcord
```
If you need the latest version in your `requirements.txt` file, you can add this line:
```
ezcord @ git+https://github.com/tibue99/ezcord
```

## Useful Links
- [Documentation](https://ezcord.readthedocs.io/) | [Getting started](https://ezcord.readthedocs.io/en/latest/pages/getting_started.html)
- [Pycord](https://docs.pycord.dev/) | [Discord.py](https://discordpy.readthedocs.io/en/stable/)
- [PyPi](https://pypi.org/project/ezcord/)

## Examples
- For more examples, see the [example repository](https://github.com/tibue99/ezcord_template)
or the [sample code](https://ezcord.readthedocs.io/en/latest/examples/examples.html).
- **Note:** It's recommended to [load the token](https://guide.pycord.dev/getting-started/creating-your-first-bot#protecting-tokens) from a `.env` file instead of hardcoding it.
EzCord can automatically load the token if a `TOKEN` variable is present in the `.env` file.

### Pycord
```py
import ezcord
import discord

bot = ezcord.Bot(
    intents=discord.Intents.default()
)

if __name__ == "__main__":
    bot.load_cogs("cogs")  # Load all cogs in the "cogs" folder
    bot.run("TOKEN")
```

### Discord.py
```py
import asyncio
import discord
import ezcord


class Bot(ezcord.Bot):
    def __init__(self):
        super().__init__(intents=discord.Intents.default())

    async def setup_hook(self):
        await super().setup_hook()
        await self.tree.sync()


async def main():
    async with Bot() as bot:
        bot.add_help_command()
        bot.load_cogs("cogs")  # Load all cogs in the "cogs" folder
        await bot.start("TOKEN")


if __name__ == "__main__":
    asyncio.run(main())
```

## Contributing
You are welcome to contribute to this repository! Please refer to the full [contribution guide](https://ezcord.readthedocs.io/en/latest/pages/contributing.html).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ezcord.py",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "discord, pycord, py-cord, discord.py",
    "author": "codestantin",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/f8/6b/25fb210a0ad3f8cf0dcf12ae9de1cfb8c57691fea0fdf44aa5d3ae29482b/ezcord_py-0.6.4.tar.gz",
    "platform": null,
    "description": "[![EzCord](https://ezcord.readthedocs.io/en/latest/_static/ezcord.png)](https://github.com/tibue99/ezcord)\r\n\r\n[![](https://img.shields.io/discord/1010915072694046794?label=discord&style=for-the-badge&logo=discord&color=5865F2&logoColor=white)](https://discord.gg/zfvbjTEzv6)\r\n[![](https://img.shields.io/pypi/v/ezcord.svg?style=for-the-badge&logo=pypi&color=yellow&logoColor=white)](https://pypi.org/project/ezcord/)\r\n[![](https://img.shields.io/pypi/l/ezcord?style=for-the-badge)](https://github.com/tibue99/ezcord/blob/main/LICENSE)\r\n[![](https://aschey.tech/tokei/github/tibue99/ezcord?style=for-the-badge)](https://github.com/tibue99/ezcord)\r\n\r\nAn easy-to-use extension for [Discord.py](https://github.com/Rapptz/discord.py)\r\nand [Pycord](https://github.com/Pycord-Development/pycord) with some utility functions.\r\n\r\n## Features\r\n### \u270f\ufe0f Reduce boilerplate code\r\n- Easy cog management\r\n- Embed templates\r\n- Datetime and file utilities\r\n- Wrapper for [aiosqlite](https://github.com/omnilib/aiosqlite) and [asyncpg](https://github.com/MagicStack/asyncpg)\r\n\r\n### \u2728 Error handling\r\n- Automatic error handling for slash commands\r\n- Error webhook reports\r\n- Custom logging\r\n\r\n### \ud83d\udcda i18n\r\n- Slash command translation (groups, options, choices)\r\n- Translate messages, embeds, views, modals and more\r\n\r\n### \u2699\ufe0f Extensions\r\n- **Help command** - Automatically generate a help command for your bot\r\n- **Status changer** - Change the bot's status in an interval\r\n- **Blacklist** - Block users from using your bot\r\n\r\n## Installing\r\nPython 3.9 or higher is required.\r\n```\r\npip install ezcord\r\n```\r\nYou can also install the latest version from GitHub. Note that this version may be unstable\r\nand requires [git](https://git-scm.com/downloads) to be installed.\r\n```\r\npip install git+https://github.com/tibue99/ezcord\r\n```\r\nIf you need the latest version in your `requirements.txt` file, you can add this line:\r\n```\r\nezcord @ git+https://github.com/tibue99/ezcord\r\n```\r\n\r\n## Useful Links\r\n- [Documentation](https://ezcord.readthedocs.io/) | [Getting started](https://ezcord.readthedocs.io/en/latest/pages/getting_started.html)\r\n- [Pycord](https://docs.pycord.dev/) | [Discord.py](https://discordpy.readthedocs.io/en/stable/)\r\n- [PyPi](https://pypi.org/project/ezcord/)\r\n\r\n## Examples\r\n- For more examples, see the [example repository](https://github.com/tibue99/ezcord_template)\r\nor the [sample code](https://ezcord.readthedocs.io/en/latest/examples/examples.html).\r\n- **Note:** It's recommended to [load the token](https://guide.pycord.dev/getting-started/creating-your-first-bot#protecting-tokens) from a `.env` file instead of hardcoding it.\r\nEzCord can automatically load the token if a `TOKEN` variable is present in the `.env` file.\r\n\r\n### Pycord\r\n```py\r\nimport ezcord\r\nimport discord\r\n\r\nbot = ezcord.Bot(\r\n    intents=discord.Intents.default()\r\n)\r\n\r\nif __name__ == \"__main__\":\r\n    bot.load_cogs(\"cogs\")  # Load all cogs in the \"cogs\" folder\r\n    bot.run(\"TOKEN\")\r\n```\r\n\r\n### Discord.py\r\n```py\r\nimport asyncio\r\nimport discord\r\nimport ezcord\r\n\r\n\r\nclass Bot(ezcord.Bot):\r\n    def __init__(self):\r\n        super().__init__(intents=discord.Intents.default())\r\n\r\n    async def setup_hook(self):\r\n        await super().setup_hook()\r\n        await self.tree.sync()\r\n\r\n\r\nasync def main():\r\n    async with Bot() as bot:\r\n        bot.add_help_command()\r\n        bot.load_cogs(\"cogs\")  # Load all cogs in the \"cogs\" folder\r\n        await bot.start(\"TOKEN\")\r\n\r\n\r\nif __name__ == \"__main__\":\r\n    asyncio.run(main())\r\n```\r\n\r\n## Contributing\r\nYou are welcome to contribute to this repository! Please refer to the full [contribution guide](https://ezcord.readthedocs.io/en/latest/pages/contributing.html).\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "An easy-to-use extension for Discord.py and Pycord",
    "version": "0.6.4",
    "project_urls": {
        "Documentation": "https://ezcord.readthedocs.io",
        "GitHub": "https://github.com/tibue99/ezcord"
    },
    "split_keywords": [
        "discord",
        " pycord",
        " py-cord",
        " discord.py"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3eb1f91c60a16a258a8b0069b3c5c118ea7812d8cc80762d9701d50a965b11f6",
                "md5": "8e1d771bb455f6c24c219c5aeef40ec2",
                "sha256": "94369b61e0c5e09f9d83153813ad05ce2fac46884bbb097cbcf7f05c444e0e80"
            },
            "downloads": -1,
            "filename": "ezcord.py-0.6.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8e1d771bb455f6c24c219c5aeef40ec2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 61678,
            "upload_time": "2024-06-06T13:27:13",
            "upload_time_iso_8601": "2024-06-06T13:27:13.730307Z",
            "url": "https://files.pythonhosted.org/packages/3e/b1/f91c60a16a258a8b0069b3c5c118ea7812d8cc80762d9701d50a965b11f6/ezcord.py-0.6.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f86b25fb210a0ad3f8cf0dcf12ae9de1cfb8c57691fea0fdf44aa5d3ae29482b",
                "md5": "8020e090aae099e5e3231c9d1760c96a",
                "sha256": "be2a14116e3570cf7c50427d3747f9dc67a9a2d6019656d4532cfcbfdb8772d1"
            },
            "downloads": -1,
            "filename": "ezcord_py-0.6.4.tar.gz",
            "has_sig": false,
            "md5_digest": "8020e090aae099e5e3231c9d1760c96a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 53981,
            "upload_time": "2024-06-06T13:27:15",
            "upload_time_iso_8601": "2024-06-06T13:27:15.176107Z",
            "url": "https://files.pythonhosted.org/packages/f8/6b/25fb210a0ad3f8cf0dcf12ae9de1cfb8c57691fea0fdf44aa5d3ae29482b/ezcord_py-0.6.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-06 13:27:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tibue99",
    "github_project": "ezcord",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "ezcord.py"
}
        
Elapsed time: 0.77781s