Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lkabuci/Botflix

🎥 Stream your favorite movie from the terminal!
https://github.com/lkabuci/Botflix

cli movie movies mpv nodejs stream streaming streams terminal torrents vlc webtorrent

Last synced: about 2 months ago
JSON representation

🎥 Stream your favorite movie from the terminal!

Host: GitHub
URL: https://github.com/lkabuci/Botflix
Owner: lkabuci
License: mit
Created: 2021-12-30T00:11:36.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-10-21T18:43:40.000Z (11 months ago)
Last Synced: 2024-07-30T11:12:37.943Z (about 2 months ago)
Topics: cli, movie, movies, mpv, nodejs, stream, streaming, streams, terminal, torrents, vlc, webtorrent
Language: Python
Homepage:
Size: 1.08 MB
Stars: 420
Watchers: 7
Forks: 26
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  



 Botflix 






	

![AUR version](https://img.shields.io/aur/version/botflix-git)





Botflix is a Python scrapping CLI that combine [scrapy](https://scrapy.org) and [webtorrent](https://github.com/webtorrent/webtorrent-cli) in one command for streaming movies from your terminal.

## Installation:

#### For ArchLinux or Arch-based distro:

You can install it manually from [AUR repository](https://aur.archlinux.org/packages/botflix-git) or use a aur helper like `yay` or `paru`.

```bash

yay -Syu botflix-git

```

To run

```bash

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"`, which is the final step after installation.

#### For others

> Botflix is written in python, and it depends on [webtorrent](https://github.com/webtorrent/webtorrent-cli), [NodeJS](https://nodejs.org) and [npm](https://www.npmjs.com)

1. install NodeJS on your machine ([read mode](https://nodejs.org/en/download/)).

```bash

node --version

v17.9.0 #or higher

```

2. make sure that you have npm already installed ([read more](https://docs.npmjs.com/cli/v7/configuring-npm/install)).

```bash

npm --version

8.8.0 # or higher

```

3. now let's install webtorrent ([read more](https://github.com/webtorrent/webtorrent-cli)).

```bash

npm install webtorrent-cli -g

webtorrent --version # 4.0.4 (1.8.16)

```

_Note: if not installed try with sudo privileges._

4. clone the repo in your local machine.

```bash

    git clone https://github.com/kaboussi/Botflix && cd Botflix

```

![clone results](.github/clone.png)

5. create a virtual environment.

* Beginner Windows users who couldn't set up the [virtualenv] check this doc.

* Unix Users

```bash

python3 -m venv venv && source venv/bin/activate

```

![creating virtualenv](.github/virtualenv.png)  

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

```bash

sudo apt install python3-venv

```

6. Install necessary packages.

```bash

pip install -r requirements.txt

```

![install packages](.github/pipintsall.png)

## Usage:

* First you need to set up a default player.

> Note that only [vlc](https://www.videolan.org/vlc/) and [mpv](https://mpv.io/) are supported. 


> If you are a Windows user make sure that you add your player to the PATH. [read more](https://www.vlchelp.com/add-vlc-command-prompt-windows/)

```bash

python3 main.py config "vlc"

```

![config](.github/config.png)

* If you want to get top movies:

```bash

python3 main.py top

```

* If you want to watch a TV Series:

```bash

python3 main.py serie

```

* If you want to search for a specific movie (_"[red notice](https://www.imdb.com/title/tt7991608/)"_ for example):

```bash

python3 main.py search

What movie are you looking for? red notice

```

![table of search](.github/table_of_movies.png "table of search")

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

## Contributing:

Contributions are what make 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](https://mit-license.org/)


[DISCLAIMER](https://www.disclaimertemplate.net/live.php?token=xyytrgo4QtkLMNCB6LEIO6Q39YDFyhu2)

[virtualenv]: https://github.com/kaboussi/Botflix/blob/main/docs/windowsVenv.md