Skip to content

Latest commit

 

History

History
46 lines (36 loc) · 1.99 KB

README.md

File metadata and controls

46 lines (36 loc) · 1.99 KB

YFeed

is a cli python application that fetches recent video data using YouTube Data API and RSS feeds.

CI codecov 332shots_so

Installation

Warning

Make sure you have Python 3.12 or newer, FFmpeg and mpv installed. If you are using Windows, Windows Terminal is also recommended. If you are using Linux you should have venv module. If YouTube is not available in your country, you may need a Proxy/VPN to use the application.

Tip

To simplify installation and startup you can use run scripts for automation, choose them depending on your system.

Step-by-Step Manual Setup:

  1. Clone the repository or download YFeed.zip from the latest release.
  2. Install required libraries:
pip install -r requirements.txt
  1. Run YFeed:
python src/main.py

Obtaining YouTube API Key:

  1. Visit the Google Cloud Console.
  2. Create a new project or select an existing one.
  3. Enable the YouTube Data API v3 for your project.
  4. Generate an API Key from the Credentials section.

Data Structure

File Stores
settings.json User-configurable settings
names.json Channel names
channels.yfe Subscribed channels
watched.json Watched videos
cache.json Cached data

Contributing is encouraged 🤗