├── run_tests.sh ├── pyxtream ├── version.py ├── __init__.py ├── progress.py ├── rest_api.py ├── schemaValidator.py └── html │ └── index.html ├── docs ├── index.html ├── pyxtream │ ├── version.html │ └── progress.html └── pyxtream.html ├── .gitignore ├── test ├── requirements.txt └── test_pyxtream.py ├── pyproject.toml ├── PYPI.md ├── .github └── workflows │ └── run_pytest.yml ├── functional_test.py ├── README.md └── LICENSE /run_tests.sh: -------------------------------------------------------------------------------- 1 | poetry run pytest --cov=pyxtream test/test_pyxtream.py -------------------------------------------------------------------------------- /pyxtream/version.py: -------------------------------------------------------------------------------- 1 | 2 | __version__ = '0.7.3' 3 | __author__ = 'Claudio Olmi' 4 | __author_email__ = 'superolmo2@gmail.com' 5 | -------------------------------------------------------------------------------- /docs/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /pyxtream/__init__.py: -------------------------------------------------------------------------------- 1 | 2 | from .progress import progress 3 | from .pyxtream import XTream, Channel, Group, Serie, Episode 4 | 5 | try: 6 | from .rest_api import FlaskWrap 7 | USE_FLASK = True 8 | except ImportError: 9 | USE_FLASK = False 10 | from .version import __author__, __author_email__, __version__ 11 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | 3 | # Packages 4 | /dist/* 5 | 6 | # Unit test / coverage reports 7 | .coverage 8 | .pytest_cache 9 | 10 | .DS_Store 11 | .idea/* 12 | .python-version 13 | .vscode/* 14 | 15 | /docs/site/* 16 | .mypy_cache 17 | 18 | .venv 19 | /poetry.toml 20 | 21 | # Distribution / packaging 22 | build/ 23 | dist/ 24 | *.egg-info/ 25 | tmp/ -------------------------------------------------------------------------------- /test/requirements.txt: -------------------------------------------------------------------------------- 1 | attrs==25.1.0 ; python_version >= "3.9" 2 | certifi==2025.1.31 ; python_version >= "3.9" 3 | charset-normalizer==3.4.1 ; python_version >= "3.9" 4 | idna==3.10 ; python_version >= "3.9" 5 | jsonschema-specifications==2024.10.1 ; python_version >= "3.9" 6 | jsonschema==4.23.0 ; python_version >= "3.9" 7 | referencing==0.36.2 ; python_version >= "3.9" 8 | requests==2.32.3 ; python_version >= "3.9" 9 | rpds-py==0.22.3 ; python_version >= "3.9" 10 | typing-extensions==4.12.2 ; python_version < "3.13" and python_version >= "3.9" 11 | urllib3==2.3.0 ; python_version >= "3.9" 12 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [project] 2 | name = "pyxtream" 3 | version = "0.7.3" 4 | requires-python = ">=3.9" 5 | description = "xtream IPTV loader" 6 | authors = [{name = "Claudio Olmi", email = ""}] 7 | license = "GPL3" 8 | readme = "README.md" 9 | homepage = "https://github.com/superolmo/pyxtream" 10 | classifiers = [ 11 | "Development Status :: 4 - Beta", 12 | "Environment :: Console", 13 | "Intended Audience :: Developers", 14 | "Programming Language :: Python :: 3 :: Only", 15 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 16 | "Operating System :: OS Independent", 17 | "Natural Language :: English" 18 | ] 19 | dependencies = [ 20 | "requests (>=2.32.3,<3.0.0)", 21 | "jsonschema (>=4.23.0,<5.0.0)", 22 | ] 23 | 24 | [project.optional-dependencies] 25 | flask = ["flask>=3.1.0,<4.0.0"] 26 | 27 | [tool.poetry.group.dev.dependencies] 28 | pdoc = "^15.0.1" 29 | pytest = "^8.3.4" 30 | pytest-cov = "^6.0.0" 31 | 32 | [build-system] 33 | requires = ["poetry-core"] 34 | build-backend = "poetry.core.masonry.api" 35 | -------------------------------------------------------------------------------- /PYPI.md: -------------------------------------------------------------------------------- 1 | # Update Poetry 2 | 3 | ```shell 4 | poetry lock 5 | poetry sync 6 | poetry debug resolve 7 | ``` 8 | 9 | # Build docs 10 | 11 | ```shell 12 | rm -rf docs 13 | poetry run pdoc -n -o docs pyxtream 14 | ``` 15 | 16 | # Generate requirements.txt 17 | 18 | ```shell 19 | poetry export --without-hashes > requirements.txt 20 | ``` 21 | 22 | # Build PIP Module 23 | 24 | ```shell 25 | poetry build 26 | ``` 27 | 28 | # Configure PYPI Token 29 | 30 | ```shell 31 | poetry config pypi-token.pypi 32 | ``` 33 | ```shell 34 | poetry publish -u __token__ -p 35 | ``` 36 | 37 | # Upload to PYPI 38 | 39 | References: https://www.digitalocean.com/community/tutorials/how-to-publish-python-packages-to-pypi-using-poetry-on-ubuntu-22-04 40 | 41 | ```shell 42 | poetry publish 43 | ``` 44 | 45 | # Optional Local Install 46 | 47 | python3 -m pip install dist/pyxtream-0.7 48 | 49 | # Record TS Video 50 | 51 | ffmpeg -y -i "(iptv url)" -c:v copy -c:a copy -map 0:v -map 0:a -t 00:00:30 "myrecording.ts" >"mylog.log" 2>&1 52 | 53 | # Versioning 54 | 55 | - Increment the MAJOR version when you make incompatible API changes. 56 | - Increment the MINOR version when you add functionality in a backwards-compatible manner. 57 | - Increment the PATCH version when you make backwards-compatible bug fixes. 58 | -------------------------------------------------------------------------------- /.github/workflows/run_pytest.yml: -------------------------------------------------------------------------------- 1 | # This workflow will install Python dependencies, run tests and lint with a single version of Python 2 | # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python 3 | 4 | name: Python application 5 | 6 | on: 7 | push: 8 | branches: [ "main" ] 9 | pull_request: 10 | branches: [ "main" ] 11 | 12 | permissions: 13 | contents: read 14 | 15 | jobs: 16 | build: 17 | 18 | runs-on: ubuntu-latest 19 | strategy: 20 | matrix: 21 | python-version: ["3.9", "3.10", "3.11", "3.12"] 22 | 23 | steps: 24 | - uses: actions/checkout@v4 25 | - name: Set up Python ${{ matrix.python-version }} 26 | uses: actions/setup-python@v3 27 | with: 28 | python-version: ${{ matrix.python-version }} 29 | - name: Install dependencies 30 | run: | 31 | python -m pip install --upgrade pip 32 | pip install flake8 pytest pytest-cov pdoc 33 | if [ -f test/requirements.txt ]; then pip install -r test/requirements.txt; fi 34 | - name: Check Syntax with flake8 35 | run: | 36 | flake8 --extend-ignore=E501 pyxtream/pyxtream.py pyxtream/rest_api.py pyxtream/schemaValidator.py pyxtream/version.py pyxtream/progress.py 37 | - name: Test with pytest 38 | run: | 39 | python3 -m pytest --cov=pyxtream test/test_pyxtream.py 40 | -------------------------------------------------------------------------------- /pyxtream/progress.py: -------------------------------------------------------------------------------- 1 | # The MIT License (MIT) 2 | # Copyright (c) 2016 Vladimir Ignatev 3 | # 4 | # Permission is hereby granted, free of charge, to any person obtaining 5 | # a copy of this software and associated documentation files (the "Software"), 6 | # to deal in the Software without restriction, including without limitation 7 | # the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | # and/or sell copies of the Software, and to permit persons to whom the Software 9 | # is furnished to do so, subject to the following conditions: 10 | # 11 | # The above copyright notice and this permission notice shall be included 12 | # in all copies or substantial portions of the Software. 13 | # 14 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 15 | # INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR 16 | # PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE 17 | # FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT 18 | # OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 19 | # OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 20 | import sys 21 | 22 | 23 | def progress(count, total, status=''): 24 | bar_len = 60 25 | filled_len = int(round(bar_len * count / float(total))) 26 | 27 | percents = round(100.0 * count / float(total), 1) 28 | bar_filled = '=' * filled_len + '-' * (bar_len - filled_len) 29 | 30 | sys.stdout.write(f'[{bar_filled}] {percents}% ...{status}\r') 31 | sys.stdout.flush() # As suggested by Rom Ruben (see: http://stackoverflow.com/questions/3173320/text-progress-bar-in-the-console/27871113#comment50529068_27871113) 32 | -------------------------------------------------------------------------------- /pyxtream/rest_api.py: -------------------------------------------------------------------------------- 1 | 2 | # Import Flask to control IPTV via REST API 3 | from threading import Thread 4 | import logging 5 | from os import path 6 | from flask import Flask 7 | from flask import Response as FlaskResponse 8 | 9 | 10 | class EndpointAction(object): 11 | 12 | response: FlaskResponse 13 | 14 | def __init__(self, action, function_name): 15 | self.function_name = function_name 16 | self.action = action 17 | 18 | def __call__(self, **args): 19 | content_types = { 20 | 'html': "text/html; charset=utf-8", 21 | 'json': "text/json; charset=utf-8" 22 | } 23 | 24 | handlers = { 25 | # Add handlers here 26 | "stream_search_generic": lambda: self._handle_search(args['term']), 27 | "stream_search_with_type": lambda: self._handle_search(args['term'], args.get('type')), 28 | "download_stream": lambda: self.action(int(args['stream_id'])), 29 | "get_download_progress": lambda: self.action(int(args['stream_id'])), 30 | "get_last_7days": lambda: self.action(), 31 | "home": lambda: self.action, 32 | "get_series": lambda: self.action(int(args['series_id']), "JSON") 33 | } 34 | 35 | answer = handlers[self.function_name]() 36 | content_type = content_types['json'] if self.function_name not in ('home') else content_types['html'] 37 | 38 | self.response = FlaskResponse(answer, status=200, headers={"Content-Type": content_type}) 39 | return self.response 40 | 41 | def _handle_search(self, term, stream_type=None): 42 | regex_term = r"^.*{}.*$".format(term) 43 | if stream_type: 44 | stream_type = [stream_type] if stream_type else ("series", "movies", "channels") 45 | return self.action(regex_term, return_type='JSON', stream_type=stream_type) 46 | return self.action(regex_term, return_type='JSON') 47 | 48 | 49 | class FlaskWrap(Thread): 50 | 51 | home_template = """ 52 | pyxtream API 53 | """ 54 | 55 | host: str = "" 56 | port: int = 0 57 | 58 | def __init__(self, name, xtream: object, html_template_folder: str = None, 59 | host: str = "0.0.0.0", port: int = 5000, debug: bool = True 60 | ): 61 | 62 | log = logging.getLogger('werkzeug') 63 | log.setLevel(logging.ERROR) 64 | 65 | self.host = host 66 | self.port = port 67 | self.debug = debug 68 | 69 | self.app = Flask(name) 70 | self.xt = xtream 71 | Thread.__init__(self) 72 | 73 | # Configure Thread 74 | self.name = "pyxtream REST API" 75 | self.daemon = True 76 | 77 | # Load HTML Home Template if any 78 | if html_template_folder is not None: 79 | self.home_template_file_name = path.join(html_template_folder, "index.html") 80 | if path.isfile(self.home_template_file_name): 81 | with open(self.home_template_file_name, 'r', encoding="utf-8") as home_html: 82 | self.home_template = home_html.read() 83 | 84 | # Add all endpoints 85 | self.add_endpoint(endpoint='/', endpoint_name='home', handler=[self.home_template, "home"]) 86 | self.add_endpoint(endpoint='/stream_search/', 87 | endpoint_name='stream_search_generic', 88 | handler=[self.xt.search_stream, 'stream_search_generic'] 89 | ) 90 | self.add_endpoint(endpoint='/stream_search//', 91 | endpoint_name='stream_search_with_type', 92 | handler=[self.xt.search_stream, 'stream_search_with_type'] 93 | ) 94 | self.add_endpoint(endpoint='/download_stream//', 95 | endpoint_name='download_stream', 96 | handler=[self.xt.download_video, "download_stream"] 97 | ) 98 | self.add_endpoint(endpoint='/get_download_progress//', 99 | endpoint_name='get_download_progress', 100 | handler=[self.xt.get_download_progress, "get_download_progress"] 101 | ) 102 | self.add_endpoint(endpoint='/get_last_7days', 103 | endpoint_name='get_last_7days', 104 | handler=[self.xt.get_last_7days, "get_last_7days"] 105 | ) 106 | self.add_endpoint(endpoint='/get_series/', 107 | endpoint_name='get_series', 108 | handler=[self.xt._load_series_info_by_id_from_provider, "get_series"] 109 | ) 110 | 111 | def run(self): 112 | self.app.run(debug=self.debug, use_reloader=False, host=self.host, port=self.port) 113 | 114 | def add_endpoint(self, endpoint=None, endpoint_name=None, handler=None): 115 | self.app.add_url_rule(endpoint, endpoint_name, EndpointAction(*handler)) 116 | -------------------------------------------------------------------------------- /functional_test.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | """ 3 | Test application to validate provider account access 4 | """ 5 | 6 | import sys 7 | from time import sleep 8 | 9 | from pyxtream import XTream, __version__ 10 | 11 | PROVIDER_NAME = "" 12 | PROVIDER_URL = "" 13 | PROVIDER_USERNAME = "" 14 | PROVIDER_PASSWORD = "" 15 | 16 | if PROVIDER_URL == "" or PROVIDER_USERNAME == "" or PROVIDER_PASSWORD == "": 17 | print("Please edit this file with the provider credentials") 18 | sys.exit() 19 | 20 | 21 | def str2list(input_string: str) -> list: 22 | 23 | """Convert a string with comma delimited numbers into a python list of integers 24 | 25 | Args: 26 | input_string (str): A list of commands comma delimited 27 | 28 | Returns: 29 | list: list of integers containing the commands 30 | """ 31 | # convert to list 32 | output_list = input_string.split(",") 33 | 34 | # convert each element as integers 35 | li = [] 36 | for list_index in output_list: 37 | try: 38 | li.append(int(list_index)) 39 | except ValueError: 40 | pass 41 | 42 | return li 43 | 44 | 45 | print(f"pyxtream version {__version__}") 46 | 47 | xt = XTream( 48 | PROVIDER_NAME, 49 | PROVIDER_USERNAME, 50 | PROVIDER_PASSWORD, 51 | PROVIDER_URL, 52 | reload_time_sec=60*60*8, 53 | debug_flask=True, 54 | enable_flask=True 55 | ) 56 | 57 | sleep(0.5) 58 | 59 | # If we could not connect, exit 60 | if xt.auth_data == {}: 61 | print("Authentication failed") 62 | sleep(0.5) 63 | sys.exit(0) 64 | 65 | while True: 66 | print( 67 | """ 68 | ** Menu ** 69 | ---------- 70 | (1) Load IPTV 71 | (2) Search Streams Regex 72 | (3) Search Streams Text 73 | (4) Download Video (stream_id) 74 | (5) Download Video Impl (URL, filename) 75 | (6) Show how many movies added in past 30 days 76 | (7) Show how many movies added in past 7 days 77 | (8) Get Series Info By ID (series_id) 78 | (9) Get Live EPG by Stream ID 79 | ---------- 80 | (0) Quit 81 | """ 82 | ) 83 | sleep(0.1) 84 | # Get user input 85 | commands = input(">>> ").lower().rstrip() 86 | # Convert string of commands to list of integers 87 | command_list = str2list(commands) 88 | 89 | for choice in command_list: 90 | print(f"\t[{choice}]: ") 91 | 92 | if choice == 0: 93 | sys.exit(0) 94 | 95 | elif choice == 1: 96 | if not xt.load_iptv(): 97 | print("Something wrong") 98 | 99 | elif choice == 2: 100 | search_string = input("Search for REGEX (ex. '^Destiny.*$'): ") 101 | search_result_obj = xt.search_stream(search_string, stream_type=("movies", "series")) 102 | result_number = len(search_result_obj) 103 | print(f"\tFound {result_number} results") 104 | if result_number < 10: 105 | for stream in search_result_obj: 106 | if 'url' in stream: 107 | print(f"Found `{stream['name']}` at URL: {stream['url']}") 108 | else: 109 | print(stream) 110 | 111 | elif choice == 3: 112 | search_string = input("Search for text: ") 113 | search_result_obj = xt.search_stream( 114 | rf"^.*{search_string}.*$", stream_type=("movies", "series") 115 | ) 116 | result_number = len(search_result_obj) 117 | print(f"\tFound {result_number} results") 118 | if result_number < 10: 119 | for stream in search_result_obj: 120 | if 'url' in stream: 121 | print(f"Found {stream['name']} at URL: {stream['url']}") 122 | else: 123 | print(stream) 124 | 125 | elif choice == 4: 126 | stream_id = input("Stream ID: ") 127 | stream_id_number = int(stream_id) 128 | 129 | if stream_id_number > 0: 130 | print(f"\n\tFile saved at `{xt.download_video(int(stream_id))}`") 131 | else: 132 | print("\n\tInvalid number") 133 | 134 | elif choice == 5: 135 | url = input("Enter URL to download: ") 136 | filename = input("Enter Fullpath Filename: ") 137 | xt._download_video_impl(url, filename) 138 | 139 | elif choice == 6: 140 | NUM_MOVIES = len(xt.movies_30days) 141 | print(f"Found {NUM_MOVIES} new movies in the past 30 days") 142 | if NUM_MOVIES < 20: 143 | for i in range(0, NUM_MOVIES): 144 | print(xt.movies_30days[i].title) 145 | 146 | elif choice == 7: 147 | NUM_MOVIES = len(xt.movies_7days) 148 | print(f"Found {NUM_MOVIES} new movies in the past 7 days") 149 | if NUM_MOVIES < 20: 150 | for i in range(0, NUM_MOVIES): 151 | print(xt.movies_7days[i].title) 152 | 153 | elif choice == 8: 154 | series_id = input("Series ID: ") 155 | # Load series seasons and episodes 156 | data = xt._load_series_info_by_id_from_provider(series_id, "JSON") 157 | if data is not None: 158 | print(data) 159 | else: 160 | print("No series found for that ID") 161 | 162 | elif choice == 9: 163 | stream_id = input("Stream ID: ") 164 | data = xt.liveEpgByStream(stream_id) 165 | print(data) 166 | -------------------------------------------------------------------------------- /test/test_pyxtream.py: -------------------------------------------------------------------------------- 1 | # test_pyxtream.py 2 | import os 3 | from datetime import datetime, timedelta 4 | from unittest.mock import Mock, patch 5 | 6 | import pytest 7 | 8 | import sys 9 | sys.path.insert(0, '../pyxtream') 10 | from pyxtream import Channel, Episode, Group, Serie, XTream 11 | 12 | # Mock data for provider connection 13 | mock_provider_name = "Test Provider" 14 | mock_provider_username = "test_user" # Must be the same as in the MOCK_AUTH_DATA 15 | mock_provider_password = "test_pass" # Must be the same as in the MOCK_AUTH_DATA 16 | mock_provider_url = "http://test.server.com" # Must be the same as in the MOCK_AUTH_DATA 17 | 18 | 19 | # Mock data for testing 20 | MOCK_AUTH_DATA = { 21 | "user_info": { 22 | "username": mock_provider_username, 23 | "password": mock_provider_password, 24 | "exp_date": str(int((datetime.now() + timedelta(days=30)).timestamp())) 25 | }, 26 | "server_info": { 27 | "url": "test.server.com", 28 | "https_port": "443" 29 | } 30 | } 31 | 32 | MOCK_CATEGORIES = [ 33 | {"category_id": 1, "category_name": "Live TV"}, 34 | {"category_id": 2, "category_name": "Movies"} 35 | ] 36 | 37 | MOCK_STREAMS = [ 38 | {"stream_id": 1, "name": "Channel 1", "stream_type": "live", "category_id": 1, 39 | "stream_icon": f"{mock_provider_url}/icon1.png", "added": "1638316800"}, 40 | {"stream_id": 2, "name": "Movie 1", "stream_type": "movie", "category_id": 2, 41 | "stream_icon": f"{mock_provider_url}/icon2.png", "added": "1638316800"} 42 | ] 43 | 44 | MOCK_SERIES_INFO = { 45 | "seasons": [ 46 | {"season_number": 1, "name": "Season 1", "cover": f"{mock_provider_url}/cover1.jpg"} 47 | ], 48 | "episodes": { 49 | "1": [ 50 | {"id": 1, "title": "Episode 1", "container_extension": "mp4", "info": {}} 51 | ] 52 | } 53 | } 54 | 55 | # Fixture for environment setup 56 | @pytest.fixture(autouse=True) 57 | def setup_environment(monkeypatch): 58 | """Setup environment before each test.""" 59 | # Mock the cache directory 60 | monkeypatch.setattr("pyxtream.XTream.cache_path", "/tmp/pyxtream_cache") 61 | # Ensure the cache directory exists 62 | os.makedirs("/tmp/pyxtream_cache", exist_ok=True) 63 | 64 | 65 | @pytest.fixture(scope="module") 66 | def mock_xtream(): 67 | with patch('requests.get') as mock_get: 68 | mock_get.return_value.ok = True 69 | mock_get.return_value.json.return_value = MOCK_AUTH_DATA 70 | USE_FLASK=False 71 | xtream = XTream( 72 | provider_name=mock_provider_name, 73 | provider_username=mock_provider_username, 74 | provider_password=mock_provider_password, 75 | provider_url=mock_provider_url 76 | ) 77 | return xtream 78 | 79 | def test_authentication(mock_xtream): 80 | assert mock_xtream.state["authenticated"] is True 81 | assert mock_xtream.authorization["username"] == mock_provider_username 82 | assert mock_xtream.authorization["password"] == mock_provider_password 83 | 84 | def test_channel_initialization(mock_xtream): 85 | stream_info = { 86 | "stream_id": "123", 87 | "name": "Test Channel", 88 | "stream_icon": f"{mock_provider_url}/icon.png", 89 | "stream_type": "live", 90 | "category_id": "1", 91 | "added": "1638316800", 92 | "container_extension": "ts" 93 | } 94 | channel = Channel(mock_xtream, "Test Group", stream_info) 95 | assert channel.id == "123" 96 | assert channel.name == "Test Channel" 97 | assert channel.logo == f"{mock_provider_url}/icon.png" 98 | assert channel.group_title == "Test Group" 99 | assert channel.url.startswith( 100 | f"{mock_provider_url}/live/{mock_provider_username}/{mock_provider_password}/123.ts" 101 | ) 102 | 103 | def test_group_initialization(): 104 | group_info = {"category_id": 1, "category_name": "Live TV"} 105 | group = Group(group_info, "Live") 106 | assert group.group_id == 1 107 | assert group.name == "Live TV" 108 | assert group.group_type == 0 # TV_GROUP 109 | 110 | def test_serie_initialization(mock_xtream): 111 | series_info = { 112 | "series_id": 1, 113 | "name": "Test Series", 114 | "cover": f"{mock_provider_url}/cover.jpg", 115 | "last_modified": "1638316800", 116 | "plot": "Test plot", 117 | "youtube_trailer": "http://youtube.com/trailer", 118 | "genre": "Action" 119 | } 120 | serie = Serie(mock_xtream, series_info) 121 | assert serie.series_id == 1 122 | assert serie.name == "Test Series" 123 | assert serie.logo == f"{mock_provider_url}/cover.jpg" 124 | assert serie.url.startswith( 125 | f"{mock_provider_url}/series/{mock_provider_username}/{mock_provider_password}/1/" 126 | ) 127 | assert serie.plot == "Test plot" 128 | assert serie.youtube_trailer == "http://youtube.com/trailer" 129 | assert serie.genre == "Action" 130 | assert isinstance(serie.seasons, dict) 131 | assert isinstance(serie.episodes, dict) 132 | 133 | def test_episode_initialization(mock_xtream): 134 | series_info = {"cover": f"{mock_provider_url}/cover.jpg"} 135 | episode_info = { 136 | "id": 1, 137 | "title": "Episode 1", 138 | "container_extension": "mp4", 139 | "info": {}, 140 | "episode_num": 1 141 | } 142 | episode = Episode(mock_xtream, series_info, "Test Group", episode_info) 143 | assert episode.id == 1 144 | assert episode.title == "Episode 1" 145 | 146 | def test_load_categories(mock_xtream): 147 | with patch.object(mock_xtream, '_get_request', return_value=MOCK_CATEGORIES) as mock_get: 148 | # Test live categories 149 | categories = mock_xtream._load_categories_from_provider(mock_xtream.live_type) 150 | assert len(categories) == 2 151 | assert categories[0]["category_name"] == "Live TV" 152 | 153 | def test_load_streams(mock_xtream): 154 | with patch.object(mock_xtream, '_get_request', return_value=MOCK_STREAMS) as mock_get: 155 | 156 | # Test live streams 157 | streams = mock_xtream._load_streams_from_provider(mock_xtream.live_type) 158 | assert len(streams) == 2 159 | assert streams[0]["name"] == "Channel 1" 160 | 161 | def test_validate_url(mock_xtream): 162 | assert mock_xtream._validate_url("http://valid.url") is True 163 | assert mock_xtream._validate_url("invalid.url") is False 164 | 165 | def test_slugify(mock_xtream): 166 | assert mock_xtream._slugify("Test String!") == "test string!" 167 | assert mock_xtream._slugify("123ABC") == "123abc" 168 | 169 | def test_get_logo_local_path(mock_xtream): 170 | logo_url = f"{mock_provider_url}/logo.png" 171 | expected_path = os.path.join( 172 | mock_xtream.cache_path, 173 | "test provider-logo.png" 174 | ) 175 | assert mock_xtream._get_logo_local_path(logo_url) == expected_path 176 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PyXtream - A Python Xtream Loader 2 | 3 | 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. 4 | 5 | This library was originally designed to work with Hypnotix at https://github.com/linuxmint/hypnotix, so its compatibility with Hypnotix takes precedence. 6 | 7 | # Installing 8 | 9 | Installing pyxtream is done using pip3. 10 | 11 | ```shell 12 | pip3 install pyxtream 13 | ``` 14 | 15 | Optionally, to use the REST Api service, install also Flask via the following command or manually. 16 | 17 | ```shell 18 | pip3 install pyxtream[REST_API] 19 | ``` 20 | 21 | 22 | # Quick Start 23 | 24 | ## Your own application 25 | 26 | Integrating in your application is simple. Initialization and loading of IPTV channels and groups is done with the following code. 27 | 28 | ```python 29 | from pyxtream import XTream 30 | xt = XTream(servername, username, password, url) 31 | if xt.authData != {}: 32 | xt.load_iptv() 33 | else: 34 | print("Could not connect") 35 | ``` 36 | 37 | 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. 38 | 39 | ```python 40 | xt.get_series_info_by_id(series_obj) 41 | ``` 42 | 43 | At this point, the `series_obj` will have both Seasons and Episodes populated. 44 | 45 | ## Functional Test 46 | 47 | Please modify the `functional_test.py` file with your provider information, then start the application. 48 | 49 | ```shell 50 | python3 functional_test.py 51 | ``` 52 | 53 | 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. 54 | 55 | ## Applications using PyXtream 56 | 57 | Applications using PyXtream PYPI package 58 | 59 | - 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. 60 | 61 | Applications using PyXtream files 62 | 63 | - Hypnotix - https://github.com/linuxmint/hypnotix - Hypnotix is an IPTV streaming application with support for live TV, movies and series. 64 | 65 | # API 66 | 67 | ## Classes: 68 | 69 | Below are the classes used in the module. They are heavily influenced by the application Hypnotix. 70 | 71 | - XTream.Channels 72 | - XTream.Groups 73 | - XTream.Episode 74 | - XTream.Series 75 | - XTream.Season 76 | 77 | ## Dictionaries (Array of dictionaries): 78 | 79 | xTream.groups[{},{},...] 80 | 81 | xTream.channels[{},{},...] 82 | 83 | xTream.series[{},{},...] 84 | 85 | xTream.movies[{},{},...] 86 | 87 | ## Functions: 88 | 89 | - xTream.authenticate() 90 | - xTream.load_iptv() 91 | - XTream.get_series_info_by_id(get_series: dict) 92 | - xTream.search_stream(keyword: str, ignore_case: bool = True, return_type: str = "LIST") 93 | - xTream.download_video(stream_id: int) 94 | - xTream.vodInfoByID(vod_id) 95 | - xTream.liveEpgByStream(stream_id) 96 | - xTream.liveEpgByStreamAndLimit(stream_id, limit) 97 | - xTream.allLiveEpgByStream(stream_id) 98 | - xTream.allEpg() 99 | 100 | # Versioning 101 | Follows the Semantic Versioning from https://semver.org/ 102 | - Increment the MAJOR version when you make incompatible API changes. 103 | - Increment the MINOR version when you add functionality in a backwards-compatible manner. 104 | - Increment the PATCH version when you make backwards-compatible bug fixes. 105 | 106 | # Change Log 107 | 108 | | Date | Version | Description | 109 | | ----------- | -----| ----------- | 110 | | 2025-02-17 | 0.7.3 | - Added Initial PyTest and Coverage
- Added timestamp field "added" to Series to match channels "added" field
- Added string field "url" to Series to quickly get the series download address
- Added new API "get_last_7days()" returns the last added streams in the last 7 days in JSON format
- Added new API "get_download_progress()" returns information on the current download stream in JSON format
- Changed internal function _load_series_info_by_id_from_provider to allow returned value to change to JSON
- Changed search_stream function to only search in specific collections
- Refactored "rest_api.py" to make it easier to extend in the future
- Added new rest API
- Changed to Poetry environment
- Changed Functional Test to test loading series information
- Changed sample index.html to test more features| 111 | | 2024-09-02 | 0.7.2 | - Added missing request package to setup.py
- Refactored the search stream function and now, it can search for a specific stream type
- Refactored the download stream function
- Refactored the _get_request function and removed the call to the sleep function
- Added functional test to get series json output from a series_id
- Added functional test to get EPG for a specific stream ID
- Added xtream account expiration date printed on the console during authentication
- Improved results with the Flask HTML page and differentiating between movies and series
- Improved code readability| 112 | | 2024-05-21 | 0.7.1 | - Fixed missing jsonschema package
- Fixed provider name in functional_test
- Improved print out of connection attempts
- Added method to read latest changes in functional_test 113 | | 2023-11-08 | 0.7.0 | - Added Schema Validator
- Added Channel Age
- Added list of movies added in the last 30 and 7 days
- Updated code based on PyLint
- Fixed Flask package to be optional [richard-de-vos](https://github.com/richard-de-vos)| 114 | | 2023-02-06 | 0.6.0 | - Added methods to change connection header, to turn off reload timer, and to enable/disable Flask debug mode
- Added a loop when attempting to connect to the provider
- Cleaned up some print lines| 115 | | 2021-08-19 | 0.5.0 | - Added method to gracefully handle connection errors
- Added setting to not load adult content
- Added sorting by stream name
- Changed the handling of special characters in streams
- Changed print formatting
- Changed index.html webpage to HTML5 and Bootstrap 5| 116 | | 2021-06-19 | 0.4.0 | - Updated to follow PEP8
- Updated Docstrings | 117 | | 2021-06-19 | 0.3.0 | - Added enhanced Home Page with Search Button and Player
- Added case insensitive search
- Improved handling of provider missing fields | 118 | | 2021-06-11 | 0.2.1 | - Fixed bug in the way it reload from cache | 119 | | 2021-06-08 | 0.2.0 | - Added searching
- Added video download
- Added REST Api
- Fixed cache-path issue | 120 | | 2021-06-05 | 0.1.2 | - Fixed Server Name | 121 | | 2021-06-04 | 0.1.1 | - Updated README.md | 122 | | 2021-06-04 | 0.1.0 | - Initial Release | 123 | 124 | ## Interesting content that could be used for future development 125 | 126 | So far there is no ready to use Transport Stream library for playing live stream. 127 | 128 | - This is the library to convert TS to MP4 129 | - https://github.com/videojs/mux.js/ 130 | 131 | - More on above, but same problem. XMLHttpRequest waits until the whole TS file is completely loaded. It does not work for live video streams 132 | - https://developpaper.com/play-ts-video-directly-on-the-web/ 133 | 134 | - This below will allow me to process chunks of data 135 | - https://stackoverflow.com/questions/37402716/handle-xmlhttprequest-response-with-large-data 136 | -------------------------------------------------------------------------------- /pyxtream/schemaValidator.py: -------------------------------------------------------------------------------- 1 | 2 | from enum import Enum 3 | 4 | from jsonschema import exceptions, validate 5 | 6 | 7 | # class syntax 8 | class SchemaType(Enum): 9 | SERIES = 1 10 | SERIES_INFO = 2 11 | LIVE = 3 12 | VOD = 4 13 | CHANNEL = 5 14 | GROUP = 6 15 | 16 | 17 | series_schema = { 18 | "$schema": "https://json-schema.org/draft/2020-12/schema", 19 | "$id": "https://example.com/product.schema.json", 20 | "title": "Series", 21 | "description": "xtream API Series Schema", 22 | "type": "object", 23 | "properties": { 24 | "seasons": { 25 | "type": "array", 26 | "items": { 27 | "properties": { 28 | "air_date": { 29 | "type": "string", 30 | "format": "date" 31 | }, 32 | "episode_count": {"type": "integer"}, 33 | "id": {"type": "integer"}, 34 | "name": {"type": "string"}, 35 | "overview": {"type": "string"}, 36 | "season_number": {"type": "integer"}, 37 | "cover": { 38 | "type": "string", 39 | "format": "uri", 40 | "qt-uri-protocols": [ 41 | "http", 42 | "https" 43 | ] 44 | }, 45 | "cover_big": { 46 | "type": "string", 47 | "format": "uri", 48 | "qt-uri-protocols": [ 49 | "http", 50 | "https" 51 | ] 52 | }, 53 | }, 54 | "required": [ 55 | "id" 56 | ], 57 | "title": "Season" 58 | } 59 | }, 60 | "info": { 61 | "properties": { 62 | "name": {"type": "string"}, 63 | "cover": { 64 | "type": "string", 65 | "format": "uri", 66 | "qt-uri-protocols": [ 67 | "http", 68 | "https" 69 | ] 70 | }, 71 | "plot": {"type": "string"}, 72 | "cast": {"type": "string"}, 73 | "director": {"type": "string"}, 74 | "genre": {"type": "string"}, 75 | "releaseDate": {"type": "string", "format": "date"}, 76 | "last_modified": {"type": "string", "format": "integer"}, 77 | "rating": {"type": "string", "format": "integer"}, 78 | "rating_5based": {"type": "number"}, 79 | "backdrop_path": { 80 | "type": "array", 81 | "items": { 82 | "type": "string", 83 | "format": "uri", 84 | "qt-uri-protocols": [ 85 | "http", 86 | "https" 87 | ] 88 | } 89 | }, 90 | "youtube_trailed": {"type": "string"}, 91 | "episode_run_time": {"type": "string", "format": "integer"}, 92 | "category_id": {"type": "string", "format": "integer"} 93 | }, 94 | "required": [ 95 | "name" 96 | ], 97 | "title": "Info" 98 | }, 99 | "episodes": { 100 | "patternProperties": { 101 | r"^\d+$": { 102 | "type": "array", 103 | "items": { 104 | "properties": { 105 | "id": {"type": "string", "format": "integer"}, 106 | "episode_num": {"type": "integer"}, 107 | "title": {"type": "string"}, 108 | "container_extension": {"type": "string"}, 109 | "info": { 110 | "type": "object", 111 | "items": { 112 | "plot": {"type": "string"} 113 | } 114 | }, 115 | "customer_sid": {"type": "string"}, 116 | "added": {"type": "string", "format": "integer"}, 117 | "season": {"type": "integer"}, 118 | "direct_source": {"type": "string"} 119 | } 120 | } 121 | }, 122 | } 123 | } 124 | }, 125 | "required": [ 126 | "info", 127 | "seasons", 128 | "episodes" 129 | ] 130 | } 131 | series_info_schema = { 132 | "$schema": "https://json-schema.org/draft/2020-12/schema", 133 | "$id": "https://example.com/product.schema.json", 134 | "title": "Series", 135 | "description": "xtream API Series Info Schema", 136 | "type": "object", 137 | "properties": { 138 | "name": {"type": "string"}, 139 | "cover": { 140 | "type": "string", 141 | "format": "uri", 142 | "qt-uri-protocols": [ 143 | "http", 144 | "https" 145 | ] 146 | }, 147 | "plot": {"type": "string"}, 148 | "cast": {"type": "string"}, 149 | "director": {"type": "string"}, 150 | "genre": {"type": "string"}, 151 | "releaseDate": {"type": "string", "format": "date"}, 152 | "last_modified": {"type": "string", "format": "integer"}, 153 | "rating": {"type": "string", "format": "integer"}, 154 | "rating_5based": {"type": "number"}, 155 | "backdrop_path": { 156 | "anyOf": [ 157 | { 158 | "type": "array", 159 | "items": { 160 | "type": "string", 161 | "format": "uri", 162 | "qt-uri-protocols": [ 163 | "http", 164 | "https" 165 | ] 166 | } 167 | }, 168 | {"type": "string"} 169 | ] 170 | }, 171 | "youtube_trailed": {"type": "string"}, 172 | "episode_run_time": {"type": "string", "format": "integer"}, 173 | "category_id": {"type": "string", "format": "integer"} 174 | }, 175 | "required": [ 176 | "name", 177 | "category_id" 178 | ] 179 | } 180 | live_schema = { 181 | "$schema": "https://json-schema.org/draft/2020-12/schema", 182 | "$id": "https://example.com/product.schema.json", 183 | "title": "Live", 184 | "description": "xtream API Live Schema", 185 | "type": "object", 186 | "properties": { 187 | "num": {"type": "integer"}, 188 | "name": {"type": "string"}, 189 | "stream_type": {"type": "string"}, 190 | "stream_id": {"type": "integer"}, 191 | "stream_icon": { 192 | "anyOf": [ 193 | { 194 | "type": "string", 195 | "format": "uri", 196 | "qt-uri-protocols": [ 197 | "http", 198 | "https" 199 | ] 200 | }, 201 | {"type": "null"} 202 | ] 203 | }, 204 | "epg_channel_id": { 205 | "anyOf": [ 206 | {"type": "null"}, 207 | {"type": "string"} 208 | ] 209 | }, 210 | "added": {"type": "string", "format": "integer"}, 211 | "is_adult": {"type": "string", "format": "number"}, 212 | "category_id": {"type": "string"}, 213 | "custom_sid": {"type": "string"}, 214 | "tv_archive": {"type": "number"}, 215 | "direct_source": {"type": "string"}, 216 | "tv_archive_duration": { 217 | "anyOf": [ 218 | {"type": "number"}, 219 | {"type": "string", "format": "integer"} 220 | ] 221 | } 222 | } 223 | } 224 | vod_schema = { 225 | "$schema": "https://json-schema.org/draft/2020-12/schema", 226 | "$id": "https://example.com/product.schema.json", 227 | "title": "VOD", 228 | "description": "xtream API VOD Schema", 229 | "type": "object", 230 | "properties": { 231 | "num": {"type": "integer"}, 232 | "name": {"type": "string"}, 233 | "stream_type": {"type": "string"}, 234 | "stream_id": {"type": "integer"}, 235 | "stream_icon": { 236 | "anyOf": [ 237 | { 238 | "type": "string", 239 | "format": "uri", 240 | "qt-uri-protocols": [ 241 | "http", 242 | "https" 243 | ] 244 | }, 245 | {"type": "null"} 246 | ] 247 | }, 248 | "rating": { 249 | "anyOf": [ 250 | {"type": "null"}, 251 | {"type": "string", "format": "integer"}, 252 | {"type": "number"} 253 | ] 254 | }, 255 | "rating_5based": {"type": "number"}, 256 | "added": {"type": "string", "format": "integer"}, 257 | "is_adult": {"type": "string", "format": "number"}, 258 | "category_id": {"type": "string"}, 259 | "container_extension": {"type": "string"}, 260 | "custom_sid": {"type": "string"}, 261 | "direct_source": {"type": "string"} 262 | } 263 | } 264 | channel_schema = {} 265 | group_schema = { 266 | "$schema": "https://json-schema.org/draft/2020-12/schema", 267 | "$id": "https://example.com/product.schema.json", 268 | "title": "Group", 269 | "description": "xtream API Group Schema", 270 | "type": "object", 271 | "properties": { 272 | "category_id": {"type": "string"}, 273 | "category_name": {"type": "string"}, 274 | "parent_id": {"type": "integer"} 275 | } 276 | } 277 | 278 | 279 | def schemaValidator(jsonData: str, schemaType: SchemaType) -> bool: 280 | 281 | if (schemaType == SchemaType.SERIES): 282 | json_schema = series_schema 283 | elif (schemaType == SchemaType.SERIES_INFO): 284 | json_schema = series_info_schema 285 | elif (schemaType == SchemaType.LIVE): 286 | json_schema = live_schema 287 | elif (schemaType == SchemaType.VOD): 288 | json_schema = vod_schema 289 | elif (schemaType == SchemaType.CHANNEL): 290 | json_schema = channel_schema 291 | elif (schemaType == SchemaType.GROUP): 292 | json_schema = group_schema 293 | else: 294 | json_schema = "{}" 295 | 296 | try: 297 | validate(instance=jsonData, schema=json_schema) 298 | except exceptions.ValidationError as err: 299 | print(err) 300 | return False 301 | return True 302 | -------------------------------------------------------------------------------- /pyxtream/html/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | PyXtream Viewer 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 80 | 81 | 82 | 83 |

84 |

85 | 86 | 92 |

93 | 95 | 101 | 102 | 103 |

104 |

105 |

106 |

107 |

108 |

109 | 110 |

111 |

112 | 121 | 126 |

127 | 128 | 129 | 130 | -------------------------------------------------------------------------------- /docs/pyxtream/version.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | pyxtream.version API documentation 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 44 |

45 |

46 |

47 | pyxtream.version

48 | 49 | 50 | 51 | 52 | View Source 53 | 54 |

1__version__ = '0.7.3'
 55 | 2__author__ = 'Claudio Olmi'
 56 | 3__author_email__ = 'superolmo2@gmail.com'
 57 |

58 | 59 | 60 |

61 |

62 | 244 | -------------------------------------------------------------------------------- /docs/pyxtream.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | pyxtream API documentation 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 43 |

44 |

45 |

46 | pyxtream

47 | 48 | 49 | 50 | 51 | View Source 52 | 53 |

1from .progress import progress
 54 | 2from .pyxtream import XTream, Channel, Group, Serie, Episode
 55 | 3
 56 | 4try:
 57 | 5    from .rest_api import FlaskWrap
 58 | 6    USE_FLASK = True
 59 | 7except ImportError:
 60 | 8    USE_FLASK = False
 61 | 9from .version import __author__, __author_email__, __version__
 62 |

63 | 64 | 65 |

66 |

67 | 249 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /docs/pyxtream/progress.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | pyxtream.progress API documentation 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 47 |

48 |

49 |

50 | pyxtream.progress

51 | 52 | 53 | 54 | 55 | View Source 56 | 57 |

 1# The MIT License (MIT)
 58 |  2# Copyright (c) 2016 Vladimir Ignatev
 59 |  3#
 60 |  4# Permission is hereby granted, free of charge, to any person obtaining
 61 |  5# a copy of this software and associated documentation files (the "Software"),
 62 |  6# to deal in the Software without restriction, including without limitation
 63 |  7# the rights to use, copy, modify, merge, publish, distribute, sublicense,
 64 |  8# and/or sell copies of the Software, and to permit persons to whom the Software
 65 |  9# is furnished to do so, subject to the following conditions:
 66 | 10#
 67 | 11# The above copyright notice and this permission notice shall be included
 68 | 12# in all copies or substantial portions of the Software.
 69 | 13#
 70 | 14# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 71 | 15# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 72 | 16# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
 73 | 17# FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
 74 | 18# OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
 75 | 19# OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 76 | 20import sys
 77 | 21
 78 | 22
 79 | 23def progress(count, total, status=''):
 80 | 24    bar_len = 60
 81 | 25    filled_len = int(round(bar_len * count / float(total)))
 82 | 26
 83 | 27    percents = round(100.0 * count / float(total), 1)
 84 | 28    bar_filled = '=' * filled_len + '-' * (bar_len - filled_len)
 85 | 29
 86 | 30    sys.stdout.write(f'[{bar_filled}] {percents}% ...{status}\r')
 87 | 31    sys.stdout.flush()  # As suggested by Rom Ruben (see: http://stackoverflow.com/questions/3173320/text-progress-bar-in-the-console/27871113#comment50529068_27871113)
 88 |

89 | 90 | 91 |

92 |

93 | 94 |

95 | 96 | def 97 | progress(count, total, status=''): 98 | 99 | View Source 100 | 101 |

102 | 103 |

24def progress(count, total, status=''):
104 | 25    bar_len = 60
105 | 26    filled_len = int(round(bar_len * count / float(total)))
106 | 27
107 | 28    percents = round(100.0 * count / float(total), 1)
108 | 29    bar_filled = '=' * filled_len + '-' * (bar_len - filled_len)
109 | 30
110 | 31    sys.stdout.write(f'[{bar_filled}] {percents}% ...{status}\r')
111 | 32    sys.stdout.flush()  # As suggested by Rom Ruben (see: http://stackoverflow.com/questions/3173320/text-progress-bar-in-the-console/27871113#comment50529068_27871113)
112 |

113 | 114 | 115 | 116 | 117 |

118 |

119 | 301 | --------------------------------------------------------------------------------