fxstcloud


Namefxstcloud JSON
Version 0.5.2 PyPI version JSON
download
home_page
SummaryAn easy-to-use extension for Discord.py and Pycord
upload_time2024-01-05 02:32:31
maintainer
docs_urlNone
authorChill_Fabo
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.
            [![fxstcloud]( https://raw.githubusercontent.com/fxstlist/FXSTCLOUD/main/docs/_static/fxstcloud.png)](https://github.com/fxstlist/FXSTCLOUD)

[![](https://img.shields.io/pypi/v/fxstcloud.svg?style=for-the-badge&logo=pypi&color=yellow&logoColor=white)](https://pypi.org/project/fxstcloud/)
[![](https://img.shields.io/pypi/l/fxstcloud?style=for-the-badge)](https://github.com/fxstlist/FXSTCLOUD/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 fxstcloud
```
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/fxstlist/FXSTCLOUD
```
If you need the latest version in your `requirements.txt` file, you can add this line:
```
fxstcloud @ git+https://github.com/fxstlist/FXSTCLOUD
```

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

- **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.
fxstcloud can automatically load the token if a `TOKEN` variable is present in the `.env` file.

### Pycord
```py
import fxstcloud
import discord

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


class Bot(fxstcloud.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/fxstlist/FXSTCLOUD/issues/new) if you find any bugs.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "fxstcloud",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "discord,pycord,py-cord,discord.py",
    "author": "Chill_Fabo",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/00/92/10b552d8d0037cc9cbb1bbfd6ac1d2585728605a08d14f11f74863d015e8/fxstcloud-0.5.2.tar.gz",
    "platform": null,
    "description": "[![fxstcloud]( https://raw.githubusercontent.com/fxstlist/FXSTCLOUD/main/docs/_static/fxstcloud.png)](https://github.com/fxstlist/FXSTCLOUD)\r\n\r\n[![](https://img.shields.io/pypi/v/fxstcloud.svg?style=for-the-badge&logo=pypi&color=yellow&logoColor=white)](https://pypi.org/project/fxstcloud/)\r\n[![](https://img.shields.io/pypi/l/fxstcloud?style=for-the-badge)](https://github.com/fxstlist/FXSTCLOUD/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 fxstcloud\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/fxstlist/FXSTCLOUD\r\n```\r\nIf you need the latest version in your `requirements.txt` file, you can add this line:\r\n```\r\nfxstcloud @ git+https://github.com/fxstlist/FXSTCLOUD\r\n```\r\n\r\n## Useful Links\r\n- [Documentation](https://fxstcloud.readthedocs.io/) | [Getting started](https://fxstcloud.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/fxstcloud/)\r\n\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\nfxstcloud 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 fxstcloud\r\nimport discord\r\n\r\nbot = fxstcloud.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 fxstcloud\r\n\r\n\r\nclass Bot(fxstcloud.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/fxstlist/FXSTCLOUD/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.2",
    "project_urls": {
        "Documentation": "https://fxstcloud.readthedocs.io",
        "GitHub": "https://github.com/fxstlist/FXSTCLOUD"
    },
    "split_keywords": [
        "discord",
        "pycord",
        "py-cord",
        "discord.py"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e356248d3761a2e9dad6414cb46bd196e0920702ed71421491df42955af731d5",
                "md5": "3d839d9cb187d489d7b834a12a91129a",
                "sha256": "a2348deac0d0ab1611f354e7376dee1bf4451137164159c4e2b55913f45c0174"
            },
            "downloads": -1,
            "filename": "fxstcloud-0.5.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3d839d9cb187d489d7b834a12a91129a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 49202,
            "upload_time": "2024-01-05T02:32:29",
            "upload_time_iso_8601": "2024-01-05T02:32:29.904112Z",
            "url": "https://files.pythonhosted.org/packages/e3/56/248d3761a2e9dad6414cb46bd196e0920702ed71421491df42955af731d5/fxstcloud-0.5.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "009210b552d8d0037cc9cbb1bbfd6ac1d2585728605a08d14f11f74863d015e8",
                "md5": "5c889afc3ed8a383b814eeb0195520bc",
                "sha256": "afc13c2ef7c57da4330908ef2a5538606a730545ba9a9c9f116438d46e819c5a"
            },
            "downloads": -1,
            "filename": "fxstcloud-0.5.2.tar.gz",
            "has_sig": false,
            "md5_digest": "5c889afc3ed8a383b814eeb0195520bc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 43436,
            "upload_time": "2024-01-05T02:32:31",
            "upload_time_iso_8601": "2024-01-05T02:32:31.733834Z",
            "url": "https://files.pythonhosted.org/packages/00/92/10b552d8d0037cc9cbb1bbfd6ac1d2585728605a08d14f11f74863d015e8/fxstcloud-0.5.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-05 02:32:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fxstlist",
    "github_project": "FXSTCLOUD",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "fxstcloud"
}
        
Elapsed time: 0.16610s