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

[nwithan8]

New /graphs slash command to generate the following graphs:

• Daily play count
• Daily play duration
• Play count by day of week
• Play duration by day of week
• Play count by hour of day
• Play duration by hour of day
• Play count by top 10 platforms
• Play duration by top 10 platforms
• Play count by top 10 users
• Play duration by top 10 users

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

• New Features

  • Introduced a new Graphs cog in the Discord bot for generating play count and duration statistics graphically.
  • Added commands for daily, weekly, and hourly media play counts and durations.
  • Enhanced chart creation with the new ChartMaker class, allowing customized visual representations.

• Documentation

  • Updated documentation to include details on the new /graphs command for administrators.

• Bug Fixes

  • Improved metric handling by replacing outdated references with updated metric types.

• Chores

  • Added new dependencies for enhanced data visualization and numerical computations.

• Refactor

  • Renamed and enhanced time conversion functions for clarity and utility.

[coderabbitai]

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)

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

Loading

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.