Add README.md

This commit is contained in:
samedamci 2021-09-19 14:19:39 +02:00
parent 3436d2d15b
commit 4aecb23215
No known key found for this signature in database
GPG Key ID: FCB4A9A20D00E894

35
README.md Normal file
View File

@ -0,0 +1,35 @@
# python-mattebox
Unofficial Python library for MatteBOX IPTV.
<!-- ## Installing
```shell
$ python -m pip install python-mattebox
``` -->
## Usage
```python
>>> from mattebox import MatteBOX
>>> mbox = MatteBOX(USERNAME, PASSWORD, DEVICE_ID, SUBSCRIPTION_CODE)
```
### Examples
```python
>>> # get list of TV channels
>>> channels = mbox.channels
>>> # get list of programs on specified channel
>>> programs = mbox.get_programs(channels[0])
>>> # get recordings
>>> recordings = mbox.recordings
>>> # get stream URL for specified program/recording
>>> stream = mbox.get_stream(programs[0])
>>> # search for TV program
>>> results = mbox.search("Masza i niedźwiedź")
```