Skip to content
/ PyTwitch Public

A user-friendly tool for easily accessing and watching live streams, videos, and clips from Twitch.

License

Notifications You must be signed in to change notification settings

haaag/PyTwitch

Repository files navigation

Python SQLite Hatch project linting - Ruff code style - Black types - Mypy License - MIT

Twitch Menu

⭐ About

A user-friendly tool for easily accessing and watching live streams, videos, and clips from Twitch, it presents a menu interface for seamless browsing and streaming.

⚡️ Requirements

➕ Dependencies

🔒Credentials

For authentication, you can set environment vars in your shell or use the .env file and put it in the root of the project.

env-template file

# Twitch credentials
TWITCH_CLIENT_ID="xxxxx"
TWITCH_ACCESS_TOKEN="xxx"
TWITCH_USER_ID="123456"

🔓Credentials directions

📦 Installation

# Clone repository
$ git clone "https://github.com/haaag/pytwitch.git"
$ cd pytwitch

# Create virtual environment & source
$ python -m venv .venv
$ source .venv/bin/activate

# Install requirements
(.venv) $ pip install -r requirements.txt

# Install
(.venv) $ pip install .

🛠️ Usage

After installation you can use the command pytwitch

# Use rofi menu by default
(.venv) $ pytwitch

# You can use it with dmenu or rofi
(.venv) $ pytwitch -m dmenu

# or
(.venv) $ pytwitch --menu=fzf

# Help
(.venv) $ pytwitch --help

🖼️ Gifs

demo

🔗 References

🧰 TODO

  • Create/Update requirements/dependencies

  • Complete Usage

  • Update screenshots

  • Better logging

  • Finish tests

  • Update GIFs

  • Update argparse help

    • Display keybinds
  • ignore

Releases

No releases published

Packages

No packages published

Languages