devcord


Namedevcord JSON
Version 0.5.1 PyPI version JSON
download
home_page
SummaryAn easy-to-use extension for Discord.py and Pycord
upload_time2023-12-23 21:57:36
maintainer
docs_urlNone
authortimoodev
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.
            [![devcord]( https://raw.githubusercontent.com/Timoo12/devcord/main/docs/_static/devcord.png)](https://github.com/Timoo12/devcord)

[![](https://img.shields.io/pypi/v/devcord.svg?style=for-the-badge&logo=pypi&color=yellow&logoColor=white)](https://pypi.org/project/devcord/)
[![](https://img.shields.io/pypi/l/devcord?style=for-the-badge)](https://github.com/Timoo12/devcord/blob/main/LICENSE)

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)

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

### ⚙️ 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 devcord
```
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/Timoo12/devcord
```
If you need the latest version in your `requirements.txt` file, you can add this line:
```
devcord @ git+https://github.com/Timoo12/devcord
```

## Useful Links
- [Documentation](https://devcord.readthedocs.io/) | [Getting started](https://devcord.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/devcord/)

## Examples
- For more examples, see the [example repository](https://github.com/Timoo12/devcord-template)
or the [sample code](https://devcord.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.
devcord can automatically load the token if a `TOKEN` variable is present in the `.env` file.

### Pycord
```py
import devcord
import discord

bot = devcord.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 devcord


class Bot(devcord.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
I am always happy to receive contributions. Here is how to do it:
1. Fork this repository
2. Make changes
3. Create a pull request

You can also [create an issue](https://github.com/Timoo12/devcord/issues/new) if you find any bugs.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "devcord",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "discord,pycord,py-cord,discord.py",
    "author": "timoodev",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/ec/6d/c3dcf2fb95593ebcc452899c220dde7a15e80a4621f997ec97a4c97683f6/devcord-0.5.1.tar.gz",
    "platform": null,
    "description": "[![devcord]( https://raw.githubusercontent.com/Timoo12/devcord/main/docs/_static/devcord.png)](https://github.com/Timoo12/devcord)\r\n\r\n[![](https://img.shields.io/pypi/v/devcord.svg?style=for-the-badge&logo=pypi&color=yellow&logoColor=white)](https://pypi.org/project/devcord/)\r\n[![](https://img.shields.io/pypi/l/devcord?style=for-the-badge)](https://github.com/Timoo12/devcord/blob/main/LICENSE)\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)\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### \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 devcord\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/Timoo12/devcord\r\n```\r\nIf you need the latest version in your `requirements.txt` file, you can add this line:\r\n```\r\ndevcord @ git+https://github.com/Timoo12/devcord\r\n```\r\n\r\n## Useful Links\r\n- [Documentation](https://devcord.readthedocs.io/) | [Getting started](https://devcord.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/devcord/)\r\n\r\n## Examples\r\n- For more examples, see the [example repository](https://github.com/Timoo12/devcord-template)\r\nor the [sample code](https://devcord.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\ndevcord 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 devcord\r\nimport discord\r\n\r\nbot = devcord.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 devcord\r\n\r\n\r\nclass Bot(devcord.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\nI am always happy to receive contributions. Here is how to do it:\r\n1. Fork this repository\r\n2. Make changes\r\n3. Create a pull request\r\n\r\nYou can also [create an issue](https://github.com/Timoo12/devcord/issues/new) if you find any bugs.\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "An easy-to-use extension for Discord.py and Pycord",
    "version": "0.5.1",
    "project_urls": {
        "Documentation": "https://devcord.readthedocs.io",
        "GitHub": "https://github.com/Timoo12/devcord"
    },
    "split_keywords": [
        "discord",
        "pycord",
        "py-cord",
        "discord.py"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "20250bd310e593c837e510856ad0f127970dd555ffd2c1c1cbe56078879c232d",
                "md5": "6cd27f59ae57d61a4352eb9e3c5c6dbb",
                "sha256": "402b7b8e5e69c618d05130f34749db78f6de919b0596f73cad0f82f5bbd633f2"
            },
            "downloads": -1,
            "filename": "devcord-0.5.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6cd27f59ae57d61a4352eb9e3c5c6dbb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 46772,
            "upload_time": "2023-12-23T21:57:34",
            "upload_time_iso_8601": "2023-12-23T21:57:34.816858Z",
            "url": "https://files.pythonhosted.org/packages/20/25/0bd310e593c837e510856ad0f127970dd555ffd2c1c1cbe56078879c232d/devcord-0.5.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ec6dc3dcf2fb95593ebcc452899c220dde7a15e80a4621f997ec97a4c97683f6",
                "md5": "c3c6f2e57409ef39f823454022befb57",
                "sha256": "4ec1f256dde3b0e4a46e6e5c4e9fd76637b6a5ba5beb6950b105a91716338521"
            },
            "downloads": -1,
            "filename": "devcord-0.5.1.tar.gz",
            "has_sig": false,
            "md5_digest": "c3c6f2e57409ef39f823454022befb57",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 41238,
            "upload_time": "2023-12-23T21:57:36",
            "upload_time_iso_8601": "2023-12-23T21:57:36.489915Z",
            "url": "https://files.pythonhosted.org/packages/ec/6d/c3dcf2fb95593ebcc452899c220dde7a15e80a4621f997ec97a4c97683f6/devcord-0.5.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-23 21:57:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Timoo12",
    "github_project": "devcord",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "devcord"
}
        
Elapsed time: 0.15226s