Description

The proposed project structure has been implemented, bot/, cogs/, ui/, and utils/ has been moved inside src/. The database/ has been renamed to data/ and moved inside src/. Also, files in each directory has been group by related feature.

The cogs/ no longer uses GuildInfo like a constant as it has been passed as a dependency in the Progphil class in the main.py file.

Decorators now don't depend on GuildInfo to get the staff_roles, instead it fetches the staff_roles via interaction.client.config.guild or ctx.client.config.guild since config was passed as dependency in the Progphil instance from the start.

Config class from config.py has been refactored to use pydantic module to parse config file instead of using a metaclass.

Database pool creation, and database migration has been moved to main().

Lint workflow has been updated to crawl the src/ directory.

Github deploy workflow has been for the new project structure.

Dockerfile has been updated to properly build the project.

Project config file(pyproject.toml) has been updated to include the src directory during packaging, I also added a script poetry run progphil which invokes the run() function in the main file.

Testing

An attempt on testing the discord API has failed, there are limitations to the dpytest library, prefix command can be tested but struggles on embed response. Also struggles when the command depends on a third-party library, I hit the monthly limit of currency API and after that the bot won't start(because the Converter cog calls the currency api at init to get currency data and crashes because reponse is 403) lmao.

Dependency updates:

bump: discord-py@0.29.0
bump: yoyo-migrations@8.2.0
bump: asyncpg@0.29.0
bump: python-levenshtein@0.25.1
added: setuptools@70.1.0
added: pydantic@2.8.0

Resolves #162

Type of change

Please delete options that are not relevant.

[x] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

[x] Commands are tested manually.

Test Configuration:

Firmware version:
Hardware:
Toolchain:
SDK:

Checklist:

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my code
[x] I have commented my code, particularly in hard-to-understand areas
[ ] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes
[ ] Any dependent changes have been merged and published in downstream modules

ProgrammingPhilippines / progphil-bot

[CHORE] codebase cleanup #237

Description

Testing

Dependency updates:

Type of change

How Has This Been Tested?

Checklist:

Testing commands on dev server.

Prefix commands

Slash commands