PyXtream

https://pypi.org/project/pyxtream/
Admin
A Python library that loads IPTV content from Xtream provider servers, organizing channels, groups,...
Tokens:3,363
Snippets:46
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install PyXtream

Source: https://pypi.org/project/pyxtream

Install the pyxtream library using pip3. This is the basic installation command.

```bash
pip3 install pyxtream

```

--------------------------------

### Install PyXtream with REST API Support

Source: https://pypi.org/project/pyxtream

Install pyxtream with the REST_API extra to enable the REST API service. This requires Flask to be installed.

```bash
pip3 install pyxtream[REST_API]

```

--------------------------------

### Get Live EPG by Stream

Source: https://pypi.org/project/pyxtream/0.8.0

Retrieves Electronic Program Guide (EPG) data for a live stream using its stream ID.

```APIDOC
## Get Live EPG by Stream

### Description
Retrieves the Electronic Program Guide (EPG) data for a specific live stream.

### Method
```python
epg_data = xt.liveEpgByStream(stream_id=789)
```

### Parameters
- **stream_id** (int): The unique identifier of the live stream.
```

--------------------------------

### Get All EPG

Source: https://pypi.org/project/pyxtream/0.8.0

Retrieves all available EPG data for all live streams.

```APIDOC
## Get All EPG

### Description
Retrieves all available Electronic Program Guide (EPG) data for all live streams managed by the provider.

### Method
```python
all_epg_data_global = xt.allEpg()
```
```

--------------------------------

### Run Functional Test

Source: https://pypi.org/project/pyxtream

Execute the functional test script to authenticate, load streams, and test search functionality. If Flask is installed, a web interface will be available.

```bash
python3 functional_test.py

```

--------------------------------

### Get All Live EPG by Stream

Source: https://pypi.org/project/pyxtream/0.8.0

Retrieves all available EPG data for a live stream using its stream ID.

```APIDOC
## Get All Live EPG by Stream

### Description
Retrieves all available Electronic Program Guide (EPG) data associated with a specific live stream.

### Method
```python
all_epg_data = xt.allLiveEpgByStream(stream_id=789)
```

### Parameters
- **stream_id** (int): The unique identifier of the live stream.
```

--------------------------------

### Get Live EPG by Stream and Limit

Source: https://pypi.org/project/pyxtream/0.8.0

Retrieves a limited number of EPG entries for a live stream using its stream ID.

```APIDOC
## Get Live EPG by Stream and Limit

### Description
Retrieves a specified number of Electronic Program Guide (EPG) entries for a live stream.

### Method
```python
epg_data_limited = xt.liveEpgByStreamAndLimit(stream_id=789, limit=5)
```

### Parameters
- **stream_id** (int): The unique identifier of the live stream.
- **limit** (int): The maximum number of EPG entries to retrieve.
```

--------------------------------

### Get VOD Info by ID

Source: https://pypi.org/project/pyxtream/0.8.0

Retrieves detailed information for a Video on Demand (VOD) item using its ID.

```APIDOC
## Get VOD Info by ID

### Description
Retrieves detailed information for a specific Video on Demand (VOD) item using its unique identifier.

### Method
```python
vod_details = xt.vodInfoByID(vod_id=456)
```

### Parameters
- **vod_id** (int): The unique identifier of the VOD item.
```

--------------------------------

### Get Series Info by ID

Source: https://pypi.org/project/pyxtream/0.8.0

Retrieves detailed information for a specific series, including its seasons and episodes. This function populates the 'Seasons' and 'Episodes' fields within the provided series object.

```APIDOC
## Get Series Info by ID

### Description
Retrieves detailed information for a specific series, including its seasons and episodes. This function modifies the provided series object in-place to include season and episode data.

### Method
```python
# Assuming 'series_obj' is a dictionary representing a series from xTream.series
xt.get_series_info_by_id(series_obj)
# After this call, series_obj will contain 'Seasons' and 'Episodes' keys.
```

### Parameters
- **get_series** (dict): A dictionary representing the series for which to retrieve detailed information. This object will be updated with season and episode data.
```

--------------------------------

### Initialize XTream and Load IPTV Data

Source: https://pypi.org/project/pyxtream

Initialize the XTream class with provider credentials and load IPTV data. Authentication is checked before loading.

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

```

--------------------------------

### XTream Initialization and IPTV Loading

Source: https://pypi.org/project/pyxtream/0.8.0

Initializes the XTream object with provider credentials and loads IPTV data. It checks for successful authentication before proceeding to load groups, channels, movies, and series.

```APIDOC
## Initialize and Load IPTV Data

### Description
Initializes the XTream object with server details and credentials, then loads all IPTV content including groups, channels, movies, and series. Authentication status is checked before loading.

### Method
```python
from pyxtream import XTream

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

### Parameters
- **servername** (str): The server name or IP address of the IPTV provider.
- **username** (str): The username for authentication.
- **password** (str): The password for authentication.
- **url** (str): The base URL for the IPTV provider's API.

### Data Available After Loading
- `xTream.groups`: Dictionary containing IPTV groups.
- `xTream.channels`: Dictionary containing IPTV channels.
- `xTream.movies`: Dictionary containing IPTV movies.
- `xTream.series`: Dictionary containing IPTV series.
```

--------------------------------

### Download Video

Source: https://pypi.org/project/pyxtream/0.8.0

Initiates the download of a video stream using its unique stream ID.

```APIDOC
## Download Video

### Description
Initiates the download of a video stream identified by its unique ID.

### Method
```python
xt.download_video(stream_id=123)
```

### Parameters
- **stream_id** (int): The unique identifier of the video stream to download.
```

--------------------------------

### Load Series Information

Source: https://pypi.org/project/pyxtream

Load detailed information for a specific series, including seasons and episodes, by calling get_series_info_by_id with a series object.

```python
xt.get_series_info_by_id(series_obj)

```

--------------------------------

### Search Stream

Source: https://pypi.org/project/pyxtream/0.8.0

Searches for a stream (channel, movie, or series) based on a keyword. Allows for case-insensitive searching by default and returns results as a list.

```APIDOC
## Search Stream

### Description
Searches for streams (channels, movies, or series) matching a given keyword. The search can be configured to ignore case and the return type can be specified.

### Method
```python
results = xt.search_stream(keyword="example", ignore_case=True, return_type="LIST")
```

### Parameters
- **keyword** (str): The term to search for within stream titles.
- **ignore_case** (bool, optional): If True, the search is case-insensitive. Defaults to True.
- **return_type** (str, optional): The format of the returned results. Defaults to "LIST".
```
Tokens:
Raw