skadogg / personal-tv-guide

Python-based JustWatch scraper
GNU General Public License v3.0
6 stars 7 forks source link
accessible-colours gitmoji justwatch movies nord public python scraper scraping selenium-webdriver tv

Personal TV Guide

Personal TV Guide logo

Scrape your JustWatch watchlist data and turn it into HTML to serve as your own Personal TV Guide!

Introduction

Remember the weekly TV guide that came with the newspaper? It was the only useful thing in there - aside from the comic section. Personal TV Guide creates a custom TV guide using the shows and movies from your watchlist. It also provides an easy way to see how much time you have left in a show.

Installation

To install Personal TV Guide, follow these steps:

  1. Clone the repository: git clone https://github.com/skadogg/personal-tv-guide.git
  2. Navigate to the project directory: cd personal-tv-guide
  3. Install dependencies: pip install -r requirements.txt
  4. Create a my_data folder for your private data: mkdir my_data
  5. Copy the sample .env file to your main folder: cp ./sample_files/.env-sample ./.env
  6. Start the project: python run.py

Usage

To use Personal TV Guide, follow these steps:

  1. Open the project in your favorite code editor.
  2. Modify the .env file to fit your needs.
  3. Start the project: python run.py.
  4. Use the project as desired.
  5. Open ./my_data/out.html to view your Personal TV Guide.

screenshot

Contributing

If you'd like to contribute to Personal TV Guide, here are some guidelines:

  1. Fork the repository.
  2. Create a new branch for your changes.
  3. Make your changes.
  4. Write tests to cover your changes.
  5. Run the tests to ensure they pass.
  6. Commit your changes.
  7. Push your changes to your forked repository.
  8. Submit a pull request.

License

Personal TV Guide is released under the GPL-3.0 license. See the LICENSE file for details.

Authors and Acknowledgment

Personal TV Guide was created by Wes Anderson.

Additional contributors include:

Thank you to all the contributors for their hard work and dedication to the project!

FAQ

Q: What is Personal TV Guide?

A: Personal TV Guide creates a custom TV guide using the shows and movies from your JustWatch watchlist. It also provides an easy way to see how much time you have left in a show.

Q: How do I install Personal TV Guide?

A: Follow the installation steps in the README file.

Q: How does Personal TV Guide read my JustWatch watchlists?

A: The first time you run the program, you will be prompted to enter your JustWatch credentials. These get stored in a local file in your private my_data folder.

Q: How do I customize my Personal TV Guide?

A: Update the .env file you created in Step #5 during Installation. Here's what each value does:

Variable Required? Description
WHEN_TO_START Y The first hour in your guide's timeline
HOURS_TO_PRINT Y How many hours worth of data to include in timeline
STYLESHEET_PATH Y Where to find the CSS stylesheet
OUTFILE Y The name of the HTML file you want to generate
USE_KEYWORD_LIST N set to True to enable keyword lists.
genre_KEYWORDS N If creating custom rows in the table, enter a comma-separated list of strings to match. This is currently case-sensitive.
DEV_MODE N Set to False for normal use. When developing and testing, set to True to limit the number of titles read from the source.

Q: How do I use Personal TV Guide?

A: Follow the usage steps in the README file.

Q: How do I contribute to Personal TV Guide?

A: Follow the contributing guidelines in the README file.

Q: What license is Personal TV Guide released under?

A: Personal TV Guide is released under the GPL-3.0 license. See the LICENSE file for details.