Feat: Project Restructure

engels74 commented 2 weeks ago

Improvements in:

Error handling
Config.yml management
Code modularity
Slash Commands and cogs setup
Log spamming fixed
Permission checker fixes

Summary by CodeRabbit

New Features
- Introduced a comprehensive configuration management system with YAML support.
- Added new command functionalities for user-specific graph generation and management.
- Enhanced translation management with support for additional languages.
- Implemented a robust system for managing and posting graphs to Discord channels.
Bug Fixes
- Improved error handling across various components, including command execution and configuration loading.
- Enhanced logging for better traceability of errors and command executions.
Documentation
- Updated README and localization files to include new commands and features.
Chores
- Removed outdated bug and feature request templates.
- Updated dependencies in requirements.txt.
Refactor
- Streamlined command handling and cooldown management with new mixins.
- Reorganized graph generation logic for better maintainability.
- Improved structure and error handling in the bot's initialization process.

coderabbitai[bot] commented 2 weeks ago

[!IMPORTANT]

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

[!NOTE]

Reviews paused

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.

@coderabbitai review to trigger a single review.

Walkthrough

This pull request includes the removal of the bug report and feature request templates from the .github/ISSUE_TEMPLATE directory, which previously guided users in reporting bugs and suggesting features for the TGraph Bot. Additionally, the README.md file has been updated to reflect new repository links. The bot/commands.py file has been deleted, and a new structure for command handling has been introduced with multiple new files for specific commands. Other changes involve the addition of a configuration management system, utility functions, and enhancements to error handling and logging throughout the codebase.

Changes

File Path	Change Summary
`.github/ISSUE_TEMPLATE/bug_report.md`	Removed bug report template.
`.github/ISSUE_TEMPLATE/feature_request.md`	Removed feature request template.
`README.md`	Updated links to point to the new repository location.
`bot/commands.py`	Deleted file containing command handler.
`bot/commands/__init__.py`	New file to organize Discord slash commands into separate Cogs.
`bot/commands/about.py`	New "About" command implementation.
`bot/commands/config.py`	New configuration management command implementation.
`bot/commands/my_stats.py`	New command for retrieving personal Plex statistics.
`bot/commands/update_graphs.py`	New command for manually updating server-wide graphs.
`bot/commands/uptime.py`	New command for tracking and displaying bot uptime.
`bot/extensions.py`	New utilities for managing command extensions.
`bot/permission_checker.py`	Enhanced command permissions and error handling.
`bot/update_tracker.py`	Improved type safety and error handling in the UpdateTracker class.
`config/__init__.py`	New configuration management system with a ConfigManager class.
`config/config.py`	Refactored configuration loading and validation system.
`config/config.yml.sample`	Added new configuration options and renamed sections.
`config/modules/*.py`	New modules for loader, validator, sanitizer, defaults, and options for configuration management.
`graphs/*.py`	Introduced new graph management classes and removed older graph generation files.
`i18n/*.yml`	Added Danish localization and updated English translations.
`main.py`	Refactored initialization and error handling in the TGraphBot class.
`requirements.txt`	Added new dependencies and removed `pyyaml`.
`utils/command_utils.py`	New mixin classes for error handling and command cooldown management.

Possibly related PRs

#21: The permission checker feature may relate to the removal of the bug report template, as both involve user interactions with the bot and how users report issues or manage permissions.
#26: The introduction of the FIXED_UPDATE_TIME variable could be relevant as it may affect how users configure their bot settings, similar to how the bug report template structured user input.
#27: Refactoring in the Commands class, particularly around configuration management, may relate to the changes in the bug report template as both involve user input and command handling.
#28: Fixing slash command descriptions enhances user experience, which aligns with the goal of improving how users report bugs and interact with the bot.
#29: The changes to logging and update functions may relate to the overall user experience and error reporting, which ties back to how users might report issues without the bug report template.

"In the garden of code, we dig and we sow,
Templates removed, new paths we bestow.
Commands now flourish, with structure anew,
A bot that grows smarter, just for you! 🐇✨
With graphs and with stats, our data will flow,
Join us on this journey, let creativity glow!"

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

engels74 commented 2 weeks ago

@coderabbitai full review

coderabbitai[bot] commented 2 weeks ago

:white_check_mark: Actions performed

Full review triggered.

engels74 commented 1 week ago

@coderabbitai pause

coderabbitai[bot] commented 1 week ago

:white_check_mark: Actions performed

Reviews paused.

engels74 commented 1 week ago

@coderabbitai resolve

coderabbitai[bot] commented 1 week ago

:white_check_mark: Actions performed

Comments resolved.

engels74 commented 1 week ago

@coderabbitai full review

coderabbitai[bot] commented 1 week ago

:white_check_mark: Actions performed

Full review triggered.

engels74 / tgraph-bot-source