search

nwithan8 / tauticord

A Discord bot that displays live data from Tautulli
GNU General Public License v3.0
114 stars 22 forks source link

[feat] New slash command to generate play count/duration graphs #228

Closed nwithan8 closed 3 months ago

nwithan8 commented 3 months ago

New /graphs slash command to generate the following graphs:

All take in a set number of days, and most can be additioanlly filtered by a specific username

Images are stored in /tmp/charts inside the container, which is wiped on every container start and every hour to avoid bloat.

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough ## Walkthrough The changes involve modifications to various modules and components within the project. Key updates include the introduction of a new `Graphs` feature in the Discord bot, enhancements to data handling and statistics related to media play counts and durations, and improvements to the Docker setup and utility functions. Additionally, several enumerations and utility functions were updated or added to facilitate better data management and representation. ## Changes | File(s) | Change Summary | |-------------------------------------------|----------------------------------------------------------------------------------------------------| | `Dockerfile`, `entrypoint.sh` | Added environment variable and changed CMD to ENTRYPOINT executing a shell script for initialization. | | `documentation/DOCUMENTATION.md` | New section added detailing the `/graphs` command for administrators. | | `legacy/utils.py` | Renamed function from `minutes_to_hhmm` to `seconds_to_hhmm` to reflect input changes. | | `modules/charts.py` | Introduced `ChartMaker` class for creating and customizing charts using Matplotlib. | | `modules/discord/commands/__init__.py`, `modules/discord/commands/graphs.py` | Added import statement for `Graphs` module and created `Graphs` cog to manage graph commands. | | `modules/discord/commands/most.py`, `modules/discord/commands/recently.py` | Updated metric references from `HomeStatMetricType` to `StatMetricType` for statistical commands. | | `modules/tautulli/enums.py` | Renamed `HomeStatMetricType` to `StatMetricType` and added `StatChartType` and `StatChartColors`. | | `modules/tautulli/models/stats.py` | Introduced classes for handling play statistics: `PlayStatsCategoryData`, `PlayStats`, `PlayCountStats`, and `PlayDurationStats`. | | `modules/tautulli/tautulli_connector.py` | Added methods for user identification and retrieving play count/duration chart data. | | `modules/utils.py` | Added various time formatting functions and file management utilities; renamed existing functions. | | `requirements.txt` | Added dependencies for `matplotlib` and `numpy`. | | `modules/statics.py` | Introduced constants `CHART_FOLDER` and `CHART_IMAGE_PATH` for managing chart resources. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant DiscordBot participant GraphsCog participant ChartMaker participant TautulliConnector User->>DiscordBot: Request graph command DiscordBot->>GraphsCog: Handle command GraphsCog->>TautulliConnector: Fetch statistics TautulliConnector-->>GraphsCog: Return data GraphsCog->>ChartMaker: Create chart with data ChartMaker-->>GraphsCog: Return chart GraphsCog->>User: Send chart as response ```

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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.