Metadata-Version: 2.1
Name: JellySport
Version: 1.0.7
Summary: Scrapes popular streaming sites and compiles m3u/xml files for viewing.
Home-page: http://pypi.python.org/pypi/sportyfin/
Author: Axel Mierczuk
Author-email: axelmierczuk@gmail.com
License: LICENSE.txt
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown

# *`NO LONGER MAINTAINED`*

# Sportyfin

### **For Educational Purposes Only**

## Description

Stream sports events straight from your Jellyfin server. Sportyfin allows users to scrape for live
streamed events and watch straight from Jellyfin. Sportyfin also generates meta-data that is used
in Jellyfin to provide a great viewing experience.

Currently, Sportyfin supports NBA, NHL, NFL and Premier League livestreams, but we plan to support other leagues in the future.


## Installation

### Pip

To install Sportyfin with pip, follow the steps bellow:


```bash
pip install sportyfin --no-binary=sportyfin
```


### Docker

To install Sportyfin with Docker, follow the steps bellow:

```bash
git clone https://github.com/axelmierczuk/sportyfin.git
cd sportyfin
docker build --tag sportyfin .
docker run -v <Path Where You Want Output>:/sportyfin/output sportyfin 

# For example: docker run -v ~/Desktop:/sportyfin/output sportyfin 
# You can edit the paramaters that sportyfin runs with from the Dockerfile
```

_OR_ you may pull the container with the following:

```bash
docker pull sportyfin/sportyfin:latest 
docker run -v <Path Where You Want Output>:/sportyfin/output sportyfin/sportyfin:latest

# You CANNOT edit the paramaters that sportyfin runs with when pulling the image
```

## Usage

We highly recommend running Sportyfin in combination with [tmux](https://man7.org/linux/man-pages/man1/tmux.1.html), or something similar.

Example usage:

```bash
python3 -m sportyfin <arguments>
```

Start the sportyfin server as follows:
```bash
# -nba specifies finding streams for the NBA
# -s allows sportyfin to use Selenium to scrape
# -v enables verbose mode
# -o enables selecting output location

python3 -m sportyfin -nba -s -v -o ~/Desktop
```

```bash
# -vv specifies silent mode (no output will be produced)
# -a specifies all leagues supported by sportyfin

python3 -m sportyfin -a -vv
```

**See the full list of arguments [here](https://sportyfin-doc.readthedocs.io/en/latest/usage.html#installation).**

Once you have run the program, make sure to link to the .m3u's in the Jellyfin dashboard:

`Dashboard > Live TV > Tuner Devices (+) > Tuner Type (M3U Tuner) > File or URL (enter path)`

!['Dashboard'](https://i.ibb.co/7Vxvqkp/Screen-Shot-2022-01-11-at-10-47-26-AM.png)

!['Dashboard'](https://i.ibb.co/VH6b0Hc/Screen-Shot-2022-01-11-at-10-47-42-AM.png)

Additionally, make sure to change the "Refresh Guide" setting under:

`Dashboard > Scheduled Tasks > Live TV > Refresh Guide > Task Triggers`


!['Dashboard'](https://i.ibb.co/q7mhTMt/Screen-Shot-2022-01-11-at-10-58-57-AM.png)

!['Dashboard'](https://i.ibb.co/JxcdXC3/Screen-Shot-2022-01-11-at-10-59-11-AM.png)

Once the path has been defined and the settings have been updated, you can check out your streams under:

`Home > Live TV > Channels (at the top)`

!['Dashboard'](https://i.ibb.co/yS5ycS6/Screen-Shot-2022-01-11-at-11-08-08-AM.png)

## Documentation

Find all the documentation [here](https://sportyfin-doc.readthedocs.io/en/latest/index.html).

## Future Improvement

Add server functionality, aka, ability to access streams (m3u files) from HTTP server.
