/imdb-to-overseerr

The IMDB to Overseerr Sync Tool effortlessly automates the import of your IMDB movie lists into Overseerr, simplifying your movie management with advanced features like real-time progress updates, sleek UI, and robust error handling.

Primary LanguagePython

🎬 IMDB to Overseerr Sync Tool

IMDB to Overseerr Logo Website LinkedIn Python License Dependencies

Welcome to the IMDB to Overseerr Sync Tool! 🎉 This amazing tool automates importing your carefully curated IMDB lists into Overseerr, transforming movie management into a breeze. Whether you're a movie buff, a librarian for multiple collections, or someone enchanted by the magic of automation, this tool is here to simplify your experience.

📜 Table of Contents

  1. Demo
  2. Features
  3. How it Works
  4. Getting Started
  5. Troubleshooting
  6. Roadmap
  7. Notes
  8. Contact
  9. Contributing
  10. License
  11. Fun Zone: Get to Know Your Tool!

🎬 Demo

Bot In Action

🌟 Features

  • Automatic IMDB Import: Easily fetch and import movies from IMDB lists into Overseerr with a few clicks.
  • Real-time Progress Updates: Get instant feedback and updates on the status of your movie requests.
  • Refined and Colorful UI: Enjoy a sleek interface with eye-catching elements and helpful messages.
  • Advanced Error Handling: Comprehensive logging and error messages to help you troubleshoot anything.
  • One-time Configuration: Save and reuse configuration profiles, simplifying future imports.
  • Seamless Exit: Gracefully stop the import process without losing your place.
  • Encryption for Configuration: Securely store your Overseerr URL and API key with encryption.
  • Detailed Logging: Separate logs for main processes and successfully added items.

🔎 How it Works

The IMDB to Overseerr Sync Tool utilizes a mix of Python and powerful libraries like requests, BeautifulSoup, and Halo. Here’s a brief breakdown:

  1. Authentication: Input your Overseerr URL and API key to securely access your movie library.
  2. IMDB List Fetching: Fetch and parse movies from your specified IMDB list ID.
  3. Configuration Management: Tailor the tool to your preferences, and save these settings for future use.
  4. Processing: The tool processes each movie, importing it into Overseerr, while handling any errors that come up.
  5. Status Updates: Receive real-time updates on the status of each movie (e.g., already available, requested, not found).
  6. Encryption: Securely encrypt your configuration data to ensure your credentials are protected.

🚀 Getting Started

Prerequisites

  • Python 3.7 or higher
  • Basic command line knowledge
  • Compatible with most operating systems, best on Ubuntu

Installation Steps

Start up your terminal and follow these steps:

# Clone the repository
git clone https://github.com/woahai321/imdb-to-overseerr.git
cd imdb-to-overseerr

# Install dependencies
pip install -r requirements.txt

# Run the script
python add.py

Configuration

  1. Run the script and fill in the required details when prompted:

    • Overseerr URL: Your Overseerr instance's base URL.
    • API Key: The API key from your Overseerr account.
    • IMDB List ID: The ID of the IMDB list you want to import.

  2. Saving Configuration:

    • The script will prompt you to enter a password to encrypt your configuration.
    • This encrypted configuration will be saved and reused for future imports.

🛠 Troubleshooting

Common Issues

  1. Invalid API Credentials

    • Solution: Ensure your API key is correctly entered and matches Overseerr's credentials.

  2. Unexpected Script Behavior

    • Solution: Check the overseerr_sync.log file for detailed error messages and resolve the issue based on these logs.

  3. Failed to Fetch IMDB List

    • Solution: Ensure the IMDB list ID is correct and the list is publicly accessible.

  4. Decryption Error

    • Solution: Ensure you enter the correct password for decrypting the configuration. If the password is lost, delete the config.enc file and reconfigure.

🛤️ Roadmap

Completed Actions

  1. Enhanced Error Messages: Improve error descriptions for easier troubleshooting.
  2. Secure User Profiles: Ability to save and load Overseerr details from an encrypted configuration file.
  3. Color Gradient UI: Added color gradients to various UI components for better readability and aesthetics.
  4. Dynamic Status Updates: Combined processing message and status update in one line with dynamic color changes.
  5. Emoji Updates: Updated emojis to better reflect the status (e.g., ✅ for success, ❌ for errors, ☑️ for already available).

Next Steps

  1. Support for TV Shows: Extend functionality to import TV shows from IMDB lists.

Future Enhancements

  1. Web Dashboard: Create a web-based interface for more user-friendly interaction.
  2. Batch Processing: Enable batch processing for multiple IMDB lists simultaneously.

Long-term Goals

  1. Automated Syncing: Schedule automatic syncing between IMDB and Overseerr.
  2. Customization Options: Allow users to fully customize the UI and behavior of the tool.

📋 Notes

  • Security Best Practices: Please read scripts you find online before running them.
  • Security Best Practices Cont.: Always keep your API credentials secure.
  • Rate Limiting Awareness: Be mindful of Overseerr's rate limiting policies during imports.
  • Permission Compliance: Only import and manage media you have the rights to handle.

📞 Contact

Need help or have questions? Don't hesitate to raise an issue on this repo; we're here to help!

🤝 Contributing

We appreciate your contributions! Here’s how to get involved:

  1. Fork the repository on GitHub.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with descriptive messages.
  4. Submit a pull request for review.

📄 License

This project is licensed under the MIT License. Review the LICENSE file for more details.

🎉 Fun Zone: Get to Know Your Tool!

Buckle up for some fun insights and interesting facts! Your IMDB to Overseerr Sync Tool is more than just software; it’s your new best friend in movie management.

🤓 Fun Facts

  • Cinema History: The first drive-in theater opened in 1933 in New Jersey. 🚗🎥 Source
  • Legendary Cameo: Alfred Hitchcock made cameo appearances in 39 of his 52 surviving major films! 🎭 Source
  • Oscar Records: Walt Disney holds the record for the most Oscars with 22 wins and 59 nominations. 🏆 Source
  • Expensive Set: "Pirates of the Caribbean: On Stranger Tides" is one of the most expensive movies ever made, with a budget of $379 million. 🏴‍☠️ Source
  • Film Length: The longest movie ever made is the experimental film "Modern Times Forever," which runs for 240 hours (10 days). 🎬 Source
  • Box Office King: "Avengers: Endgame" surpassed "Avatar" to become the highest-grossing film of all time. 💰 Source

🛡️ Legal Disclaimer

Using the IMDB to Overseerr Sync Tool responsibly and in accordance with Overseerr's and IMDB's Terms of Service (ToS) and policies is crucial. Here are some key points:

  1. Compliance with Overseerr and IMDB:

    • Users must adhere to the ToS of both Overseerr and IMDB. Review IMDB's Terms of Service to ensure compliance.

  2. No Spamming or Abuse:

    • This tool should not be used for spam or unauthorized import activities. Respect the guidelines and policies of the platforms.

  3. Managing Rate Limits:

    • Use the tool thoughtfully to avoid hitting rate limits set by Overseerr. Excessive usage can lead to rate limiting or bans.

  4. User Consent:

    • Ensure you have the necessary permissions to import and manage media from IMDB lists.

  5. Security:

    • Protect your API credentials and never share them publicly.

  6. Responsibility:

    • Users are responsible for their actions while using this tool. The creators of the IMDB to Overseerr Sync Tool are not liable for any misuse or legal consequences arising from its use.