Skip to content

Latest commit

 

History

History
107 lines (75 loc) · 3.41 KB

README.md

File metadata and controls

107 lines (75 loc) · 3.41 KB
Raw

Trackly Icon Trackly

Music Release Tracker for Discord

GitHub stars GitHub issues Docker Pulls License

A powerful python application that monitors your music library and notifies you about new album releases from your favorite artists through discord. Stay updated with the latest releases from artists in your collection.

✨ Features

  • 🎵 Automatic Artist Tracking: Automatically tracks artists from your music directory
  • 🔍 MusicBrainz Integration: Uses MusicBrainz API for accurate release information
  • 📢 Discord Notifications: Get notified about new releases through Discord webhooks
  • 🎨 Unique Artist Colors: Each artist gets their own vibrant color for easy identification
  • ⏱️ Smart Rate Limiting: Built-in rate limiting for API requests
  • 🔄 Automatic Updates: Regular checks for new releases with configurable intervals
  • 📅 Year-Based Reset: Notification history automatically resets each year
  • 🐳 Docker Support: Easy deployment with Docker and Docker Compose

🚀 Getting Started

Using Docker Compose (Recommended)

  1. Clone the repository:
git clone https://github.com/7eventy7/trackly.git
cd trackly
  1. Configure your environment variables:
cp .env.example .env
# Edit .env with your Discord webhook URL and settings
  1. Start the application:
docker-compose up -d

⚙️ Configuration

Environment Variables

  • UPDATE_INTERVAL: Cron schedule to check for releases (required)
  • DISCORD_WEBHOOK: Your Discord webhook URL (required)
  • DISCORD_ROLE: Discord role ID to mention in notifications (optional)

Volumes

  • /music: Mount your music directory here
  • /config: Persistent storage for application data

🛠️ Technical Stack

  • Python 3
  • MusicBrainz API
  • Discord Webhooks
  • Docker
  • Schedule
  • Requests
  • Logging
  • JSON

👥 Contributing

We love your input! We want to make contributing to Trackly as easy and transparent as possible, whether it's:

  • 💡 Suggesting new features
  • 🐛 Reporting a bug
  • 📝 Improving documentation
  • 🔍 Submitting bug fixes
  • ✨ Proposing new features

Feature Requests

We're always looking for ways to make Trackly better! If you have an idea for a new feature:

  1. Check the GitHub Issues to see if it's already been suggested
  2. If not, create a new issue with the label feature request
  3. Describe your feature idea in detail:
    • What problem does it solve?
    • How would it work?
    • Any technical considerations?
  4. Engage with the community in the discussion

Your feature requests help shape the future of Trackly. No suggestion is too small - we appreciate all input!

📝 License

MIT License - feel free to use this project for any purpose.

Made with ❤️ by 7eventy7