| Name | syncord JSON |
| Version |
0.5.2
JSON |
| download |
| home_page | |
| Summary | An easy-to-use extension for Discord.py and Pycord |
| upload_time | 2023-12-17 05:45:03 |
| maintainer | |
| docs_url | None |
| author | ace |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
discord
pycord
py-cord
discord.py
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
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.
### ✏️ 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 syncord
```
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/sqiuwsqjjsxsajisa/syncord
```
If you need the latest version in your `requirements.txt` file, you can add this line:
```
syncord @ git+https://github.com/sqiuwsqjjsxsajisa/syncord
```
## Useful Links
- [Documentation](https://syncord.readthedocs.io/) | [Getting started](https://syncord.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/syncord/)
## Examples
or the [sample code](https://syncord.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.
syncord can automatically load the token if a `TOKEN` variable is present in the `.env` file.
### Pycord
```py
import syncord
import discord
bot = syncord.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 syncord
class Bot(syncord.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://discord.gg/XPCrxvhSFm) if you find any bugs.
Raw data
{
"_id": null,
"home_page": "",
"name": "syncord",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "discord,pycord,py-cord,discord.py",
"author": "ace",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/93/38/27ce15107e1b8f15dc3311df3aca541754b011f18d1921e3626a9f4e8ba3/syncord-0.5.2.tar.gz",
"platform": null,
"description": "\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### \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 syncord\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/sqiuwsqjjsxsajisa/syncord\r\n```\r\nIf you need the latest version in your `requirements.txt` file, you can add this line:\r\n```\r\nsyncord @ git+https://github.com/sqiuwsqjjsxsajisa/syncord\r\n```\r\n\r\n## Useful Links\r\n- [Documentation](https://syncord.readthedocs.io/) | [Getting started](https://syncord.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/syncord/)\r\n\r\n## Examples\r\nor the [sample code](https://syncord.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\nsyncord 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 syncord\r\nimport discord\r\n\r\nbot = syncord.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 syncord\r\n\r\n\r\nclass Bot(syncord.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://discord.gg/XPCrxvhSFm) 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.2",
"project_urls": {
"GitHub": "https://github.com/sqiuwsqjjsxsajisaj/syncord"
},
"split_keywords": [
"discord",
"pycord",
"py-cord",
"discord.py"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a216d338d72a53d9511d8de9b790c4389af9c8e9a484253a4eaa35ed0b429749",
"md5": "49a420e45d3e2839f37ebf5cefd333c6",
"sha256": "4d7e66aa1f63e4cab2a99d94a27ff032c4a09341830ddbdf8a576bcad9b9295a"
},
"downloads": -1,
"filename": "syncord-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "49a420e45d3e2839f37ebf5cefd333c6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 46811,
"upload_time": "2023-12-17T05:45:00",
"upload_time_iso_8601": "2023-12-17T05:45:00.308790Z",
"url": "https://files.pythonhosted.org/packages/a2/16/d338d72a53d9511d8de9b790c4389af9c8e9a484253a4eaa35ed0b429749/syncord-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "933827ce15107e1b8f15dc3311df3aca541754b011f18d1921e3626a9f4e8ba3",
"md5": "d355bcd85491110891c1fd2ac558be19",
"sha256": "024bcb9ea19fd5400da7c0b7e17cb87acd96883ec77c5fe6239e3ed869aa65ed"
},
"downloads": -1,
"filename": "syncord-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "d355bcd85491110891c1fd2ac558be19",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 40728,
"upload_time": "2023-12-17T05:45:03",
"upload_time_iso_8601": "2023-12-17T05:45:03.255542Z",
"url": "https://files.pythonhosted.org/packages/93/38/27ce15107e1b8f15dc3311df3aca541754b011f18d1921e3626a9f4e8ba3/syncord-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-17 05:45:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sqiuwsqjjsxsajisaj",
"github_project": "syncord",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "syncord"
}
