PyXtream - A Python Xtream Loader

PyXtream loads the xtream IPTV content from a provider server. Groups, Channels, Series are all organized in dictionaries. Season and Episodes are retrieved as needed. It includes functions for searching streams and downloading.

This library was originally designed to work with Hypnotix at https://github.com/linuxmint/hypnotix, so its compatibility with Hypnotix takes precedence.

Installing

Installing pyxtream is done using pip3.

pip3 install pyxtream

Optionally, to use the REST Api service, install also Flask via the following command or manually.

pip3 install pyxtream[REST_API]

Quick Start

Your own application

Integrating in your application is simple. Initialization and loading of IPTV channels and groups is done with the following code.

from pyxtream import XTream
xt = XTream(servername, username, password, url)
if xt.authData != {}:
    xt.load_iptv()
else:
    print("Could not connect")

Once completed, all the data can be found in xTream.groups, xTream.channels, xTream.movies, xTream.series. Series do not contains the information for all the Seasons and Episodes. Those are loaded separately when needed by calling the following function using a Series object from xTream.series array of dictionaries.

xt.get_series_info_by_id(series_obj)

At this point, the series_obj will have both Seasons and Episodes populated.

Functional Test

Please modify the functional_test.py file with your provider information, then start the application.

python3 functional_test.py

The functional test will allow you to authenticate on startup, load and search streams. If Flask is installed, a simple website will be available at http://localhost:5000 to allow you to search and play streams.

Applications using PyXtream

Applications using PyXtream PYPI package

• xtreamPOC - https://github.com/sght500/xtreamPOC - Project is a Proof of Concept (POC) that leverages pyxtream, MPV, and NiceGUI to demonstrate the use of Xtream Portal Codes.

Applications using PyXtream files

• Hypnotix - https://github.com/linuxmint/hypnotix - Hypnotix is an IPTV streaming application with support for live TV, movies and series.

API

Classes:

Below are the classes used in the module. They are heavily influenced by the application Hypnotix.

• XTream.Channels
• XTream.Groups
• XTream.Episode
• XTream.Series
• XTream.Season

Dictionaries (Array of dictionaries):

xTream.groups[{},{},...]

xTream.channels[{},{},...]

xTream.series[{},{},...]

xTream.movies[{},{},...]

Functions:

• xTream.authenticate()
• xTream.load_iptv()
• XTream.get_series_info_by_id(get_series: dict)
• xTream.search_stream(keyword: str, ignore_case: bool = True, return_type: str = "LIST")
• xTream.download_video(stream_id: int)
• xTream.vodInfoByID(vod_id)
• xTream.liveEpgByStream(stream_id)
• xTream.liveEpgByStreamAndLimit(stream_id, limit)
• xTream.allLiveEpgByStream(stream_id)
• xTream.allEpg()

Versioning

Follows the Semantic Versioning from https://semver.org/

• Increment the MAJOR version when you make incompatible API changes.
• Increment the MINOR version when you add functionality in a backwards-compatible manner.
• Increment the PATCH version when you make backwards-compatible bug fixes.

Change Log

Interesting content that could be used for future development

So far there is no ready to use Transport Stream library for playing live stream.

• This is the library to convert TS to MP4

  • https://github.com/videojs/mux.js/

• More on above, but same problem. XMLHttpRequest waits until the whole TS file is completely loaded. It does not work for live video streams

  • https://developpaper.com/play-ts-video-directly-on-the-web/

• This below will allow me to process chunks of data

  • https://stackoverflow.com/questions/37402716/handle-xmlhttprequest-response-with-large-data