Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tibue99/ezcord

An easy-to-use extension for Discord.py and Pycord
https://github.com/tibue99/ezcord

bot discord discord-bot discord-py ezcord py-cord pycord python

Last synced: 11 days ago
JSON representation

An easy-to-use extension for Discord.py and Pycord

Host: GitHub
URL: https://github.com/tibue99/ezcord
Owner: tibue99
License: mit
Created: 2023-01-11T00:33:36.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-10-13T11:19:14.000Z (27 days ago)
Last Synced: 2024-10-13T14:14:06.671Z (26 days ago)
Topics: bot, discord, discord-bot, discord-py, ezcord, py-cord, pycord, python
Language: Python
Homepage: https://ezcord.readthedocs.io
Size: 324 KB
Stars: 90
Watchers: 3
Forks: 18
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-discordpy - tibue99/ezcord - An easy-to-use extension for Discord.py and Pycord. (Forks and Wrappers / Miscellaneous)

README

        [![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).