red-tidegear (1.9.0)
Installation
pip install --index-url About this package
A small collection of utilities for cog creation with Red-DiscordBot.
Tidegear
A collection of utilities for use with Red-DiscordBot, made for SeaCogs.
Metadata File
The cog class provided by tidegear.Cog requires consuming cogs to have a meta.json file in your cog's bundled data directory. The meta.json file must match the schema provided in schema/meta/meta.json. An example file is located at scheme/meta/meta.example.json. Additional keys are disallowed by the schema but will not cause errors.
Developing
You'll need some prerequisites before you can start working on Tidegear.
git - uv
Additionally, I recommend a code editor of some variety. Visual Studio Code is a good, beginner-friendly option.
Installing Prerequisites
This section of the guide only applies to Windows systems. If you're on Linux, refer to the documentation of the projects listed above. I also offer a Nix Flake that contains all of the required prerequisites, if you're a Nix user.
git
You can download git from the git download page.
Alternatively, you can use winget:
winget install --id=Git.Git -e --source=winget
uv
You can install uv with the following Powershell command:
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
Alternatively, you can use winget:
winget install --id=astral-sh.uv -e
Getting the Source Code
Once you have git installed, you can use the git clone command to get a copy of the repository on your system.
git clone https://c.csw.im/cswimr/tidegear.git
Then, you can use uv to install the Python dependencies required for development.
uv sync --all-groups --all-extras --frozen