Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
/ Botflix Public archive

🎥 Stream your favorite movie from the terminal!

License

Notifications You must be signed in to change notification settings

lkabuci/Botflix

Repository files navigation

⚠️ REPOSITORY ARCHIVED ⚠️

This repository is no longer actively maintained.
It has been archived for historical reference.
Thank you to all contributors and users of this project.
Last updated: Oct 21, 2023


Botflix

Botflix is a Python scrapping CLI that combines scrapy and webtorrent in one command for streaming movies from your terminal.

Installation:

For ArchLinux or Arch-based distro:

You can install it manually from AUR repository or use a aur helper like yay or paru.

yay -Syu botflix-git

To run

botflix

botflix is the replacement for the command prefix python3 main.py in this readme. for example python3 main.py config "vlc" will be botflix config "vlc", the final step after installation.

For others

Botflix is written in Python, and it depends on webtorrent, NodeJS and npm

  1. install NodeJS on your machine (read mode).
node --version
v17.9.0 #or higher
  1. make sure that you have npm already installed (read more).
npm --version
8.8.0 # or higher
  1. now let's install webtorrent (read more).
npm install webtorrent-cli -g
webtorrent --version # 4.0.4 (1.8.16)

Note: if not installed try with sudo privileges.

  1. clone the repo in your local machine.
    git clone https://github.com/kaboussi/Botflix && cd Botflix

clone results

  1. create a virtual environment.
  • Beginner Windows users who couldn't set up the virtualenv check this doc.
  • Unix Users
python3 -m venv venv && source venv/bin/activate

creating virtualenv
Note: on Debian/Ubuntu systems you will first need to install venv using

sudo apt install python3-venv
  1. Install necessary packages.
pip install -r requirements.txt

install packages

Usage:

  • First you need to set up a default player.

Note that only vlc and mpv are supported.
If you are a Windows user, make sure you add your player to the PATH. read more

python3 main.py config "vlc"

config

  • If you want to get top movies:
python3 main.py top
  • If you want to watch a TV Series:
python3 main.py serie
  • If you want to search for a specific movie ("red notice" for example):
python3 main.py search
What movie are you looking for? red notice

table of search

  • To start watching you can just type the number of the movie in the table.

Contributing:

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch git checkout -b feature/AmazingFeature
  3. Commit your Changes git commit -m 'Add some AmazingFeature
  4. Push to the Branch git push origin feature/AmazingFeature Open a Pull Request.

Contributors❤:

License:

MIT
DISCLAIMER