updates for pterodactyl and issuecards will come later, as they're both much more complicated |
||
|---|---|---|
| .docs | ||
| .forgejo | ||
| .typings | ||
| .vscode | ||
| aurora | ||
| backup | ||
| bible | ||
| emojiinfo | ||
| hotreload | ||
| issuecards | ||
| LICENSES | ||
| nerdify | ||
| pterodactyl | ||
| seautils | ||
| tickchanger | ||
| .editorconfig | ||
| .envrc | ||
| .gitignore | ||
| .readthedocs.yml | ||
| flake.lock | ||
| flake.nix | ||
| info.json | ||
| mkdocs.yml | ||
| pyproject.toml | ||
| README.md | ||
| renovate.json | ||
| REUSE.toml | ||
| uv.lock | ||
SeaCogs
My assorted cogs for Red-DiscordBot.
Developing
You'll need some prerequisites before you can start working on my cogs.
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/SeaCogs.git --recurse-submodules
Then, you can use uv to install the Python dependencies required for development.
uv sync --frozen