From f05da4110d4dd1dc23accf12addcff0c19feea80 Mon Sep 17 00:00:00 2001 From: back-to Date: Sun, 17 Jan 2021 09:37:38 +0100 Subject: [PATCH] Remove docs use README.md --- README.md | 128 ++++++++++++++++++++++++++- docs/Makefile | 20 ----- docs/conf.py | 180 -------------------------------------- docs/index.rst | 17 ---- docs/install.rst | 38 -------- docs/url.rst | 196 ------------------------------------------ requirements-docs.txt | 2 - 7 files changed, 124 insertions(+), 457 deletions(-) delete mode 100644 docs/Makefile delete mode 100644 docs/conf.py delete mode 100644 docs/index.rst delete mode 100644 docs/install.rst delete mode 100644 docs/url.rst delete mode 100644 requirements-docs.txt diff --git a/README.md b/README.md index 736e1e2..650ead4 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,130 @@ LiveProxy can redirect Livestreams to your favorite player on a lot of devices. - Issue Tracker: https://github.com/back-to/liveproxy/issues - Github: https://github.com/back-to/liveproxy -# Guide +# INSTALLATION -- https://liveproxy.github.io/ +## pip as user -# Install +```sh +# Latest pip version: +python3 -m pip install --upgrade liveproxy -- https://liveproxy.github.io/install.html +# Latest dev version: +python3 -m pip install --upgrade git+https://github.com/back-to/liveproxy.git +``` + +## pip as root + +```sh +# Latest pip version: +sudo -H python3 -m pip install --upgrade liveproxy + +# Latest dev version: +sudo -H python3 -m pip install --upgrade git+https://github.com/back-to/liveproxy.git +``` + +## source + +```text +git clone https://github.com/back-to/liveproxy.git +cd liveproxy +python3 setup.py install +``` + +# URL-GUIDE + +## Tutorial + +First, start LiveProxy on your system. + +```text +$ liveproxy +[main][INFO] For LiveProxy support visit https://github.com/back-to/liveproxy +[main][INFO] Starting server: 127.0.0.1 on port 53422 +``` + +host and port can be changed with `--host` / `--port` + +```text +$ liveproxy --host 0.0.0.0 --port 12345 +[main][INFO] For LiveProxy support visit https://github.com/back-to/liveproxy +[main][INFO] Starting server: 0.0.0.0 on port 12345 +``` + +Now that LiveProxy is running, you will have to create a valid URL. + +For the examples here, ``53422`` is used as **default port**. + +## Base64 + +You will need to base64 encode your used commands. + +#### Streamlink + +```text +http://127.0.0.1:53422/base64/STREAMLINK-COMMANDS/ +``` + +Example for `streamlink https://www.youtube.com/user/france24 best` + +```text +http://127.0.0.1:53422/base64/c3RyZWFtbGluayBodHRwczovL3d3dy55b3V0dWJlLmNvbS91c2VyL2ZyYW5jZTI0IGJlc3Q=/ +``` + +#### Youtube-DL + +```text +http://127.0.0.1:53422/base64/YOUTUBE-DL-COMMANDS/ +``` + +Example for `youtube-dl https://www.youtube.com/user/france24/live` + +```text +http://127.0.0.1:53422/base64/eW91dHViZS1kbCBodHRwczovL3d3dy55b3V0dWJlLmNvbS91c2VyL2ZyYW5jZTI0L2xpdmU=/ +``` + +### LiveProxy-Command + +LiveProxy can create this URL automatically. + +Create a new file with your commands. + +```text +#EXTM3U +#EXTINF:-1,Arte FR +streamlink https://www.arte.tv/fr/direct/ 720p,720p_alt,best +#EXTINF:-1,France24 +streamlink https://www.youtube.com/user/france24 best +#EXTINF:-1 tvg-id="EuroNews" tvg-name="EuroNews",Euronews +streamlink https://www.euronews.com/live best +#EXTINF:-1,France24 +youtube-dl https://www.youtube.com/user/france24/live +``` + +For this example the filename is `example.m3u` + +```text +liveproxy --file example.m3u +``` + +It will create a new file `example.m3u.new` with valid URLs, +only lines with `streamlink`, `youtube-dl` or `youtube_dl` at the start will be changed. + +```text +#EXTM3U +#EXTINF:-1,Arte FR +http://127.0.0.1:53422/base64/c3RyZWFtbGluayBodHRwczovL3d3dy5hcnRlLnR2L2ZyL2RpcmVjdC8gNzIwcCw3MjBwX2FsdCxiZXN0/ +#EXTINF:-1,France24 +http://127.0.0.1:53422/base64/c3RyZWFtbGluayBodHRwczovL3d3dy55b3V0dWJlLmNvbS91c2VyL2ZyYW5jZTI0IGJlc3Q=/ +#EXTINF:-1 tvg-id="EuroNews" tvg-name="EuroNews",Euronews +http://127.0.0.1:53422/base64/c3RyZWFtbGluayBodHRwczovL3d3dy5ldXJvbmV3cy5jb20vbGl2ZSBiZXN0/ +#EXTINF:-1,France24 +http://127.0.0.1:53422/base64/eW91dHViZS1kbCBodHRwczovL3d3dy55b3V0dWJlLmNvbS91c2VyL2ZyYW5jZTI0L2xpdmU=/ +``` + +You can also use ``--file-output`` for a specified new file, +but be careful don't overwrite any important files. + +```text +liveproxy --file example.m3u --file-output my_file.m3u +``` diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 79ea722..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SPHINXPROJ = LiveProxy -SOURCEDIR = . -BUILDDIR = _build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 3983d57..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,180 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Configuration file for the Sphinx documentation builder. -# -# This file does only contain a selection of the most common options. For a -# full list see the documentation: -# http://www.sphinx-doc.org/en/master/config - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -import os -import sys -sys.path.insert(0, os.path.abspath('.')) -sys.path.insert(1, os.path.abspath('..')) - -from liveproxy import __version__ as liveproxy_version - -# -- Project information ----------------------------------------------------- - -project = 'LiveProxy' -copyright = '2018, LiveProxy' -author = 'LiveProxy' - -# The short X.Y version -version = liveproxy_version -# The full version, including alpha/beta/rc tags -release = liveproxy_version - - -# -- General configuration --------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.doctest', - 'sphinx.ext.githubpages', -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The master toctree document. -master_doc = 'index' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path . -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'sphinx_rtd_theme' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -html_theme_options = { - 'canonical_url': 'https://liveproxy.github.io/', - 'analytics_id': '', - 'logo_only': False, - 'display_version': True, - 'prev_next_buttons_location': 'None', - 'style_external_links': False, - # Toc options - 'collapse_navigation': False, - 'sticky_navigation': True, - 'navigation_depth': 4, - 'includehidden': True, - 'titles_only': False -} - - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# The default sidebars (for documents that don't match any pattern) are -# defined by theme itself. Builtin themes are using these templates by -# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', -# 'searchbox.html']``. -# -html_sidebars = {} - -html_show_sourcelink = False -html_show_sphinx = False -html_show_copyright = False - - -# -- Options for HTMLHelp output --------------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = 'LiveProxydoc' - - -# -- Options for LaTeX output ------------------------------------------------ -""" -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'LiveProxy.tex', 'LiveProxy Documentation', - 'manual'), -] -""" - -# -- Options for manual page output ------------------------------------------ - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('url', 'liveproxy', 'LiveProxy Documentation', - [author], 1) -] - -""" -# -- Options for Texinfo output ---------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'LiveProxy', 'LiveProxy Documentation', - author, 'LiveProxy', 'One line description of project.', - 'Miscellaneous'), -] -""" - -# -- Extension configuration ------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 7b60390..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -Welcome to LiveProxy's documentation! -===================================== - -LiveProxy can redirect Livestreams to your favorite player on a lot of devices. - - -LiveProxy -^^^^^^^^^ - -- Issue Tracker: https://github.com/back-to/liveproxy/issues -- Github: https://github.com/back-to/liveproxy - -.. toctree:: - :maxdepth: 2 - - install - url diff --git a/docs/install.rst b/docs/install.rst deleted file mode 100644 index ffc38a0..0000000 --- a/docs/install.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. _install: - -.. |PATH| raw:: html - - https://raw.githubusercontent.com/back-to/ipk/master/build/ - -.. |br| raw:: html - -
- -Installation -============ - -Source code ------------ - -.. rst-class:: table-custom-layout - -==================================== =========================================== -Version Installing -==================================== =========================================== -`Latest release (pip)`_ .. code-block:: console - - # python3 -m pip install -U liveproxy -`Development version (pip)`_ .. code-block:: console - - # python3 -m pip install -U git+https://github.com/back-to/liveproxy.git - -`Development version (git)`_ .. code-block:: console - - $ git clone git://github.com/back-to/liveproxy.git - $ cd liveproxy - # python3 setup.py install -==================================== =========================================== - -.. _Latest release (pip): https://pypi.org/project/liveproxy/ -.. _Development version (pip): https://github.com/back-to/liveproxy -.. _Development version (git): https://github.com/back-to/liveproxy diff --git a/docs/url.rst b/docs/url.rst deleted file mode 100644 index 3640696..0000000 --- a/docs/url.rst +++ /dev/null @@ -1,196 +0,0 @@ -.. _url: - -.. |br| raw:: html - -
- -********* -URL Guide -********* - -Tutorial --------- - -LiveProxy is a local Proxyserver between Streamlink and an URL. - -After installing and running LiveProxy you will be able to access Streamlink -from any device in your local network via an URL. - -Now to get into actually using LiveProxy, let's say you want to watch the -stream located on https://www.youtube.com/user/france24, you start off by -starting LiveProxy in your terminal. - -.. code-block:: console - - $ liveproxy - [liveproxy-main][info] For LiveProxy support visit https://github.com/back-to/liveproxy - [liveproxy-main][info] Starting server: 127.0.0.1 on port 53422 - -The host or port can be changed with `--host` or `--port` - -.. code-block:: console - - $ liveproxy --host 0.0.0.0 --port 12345 - [liveproxy-main][info] For LiveProxy support visit https://github.com/back-to/liveproxy - [liveproxy-main][info] Starting server: 0.0.0.0 on port 12345 - -Now that LiveProxy is running, you will have to create a valid proxy url. - -For this Examples ``53422`` is used as the **default port**. - -Base64 ------- - -Streamlink -~~~~~~~~~~ - - :: - - http://127.0.0.1:53422/base64/STREAMLINK-COMMANDS/ - - Example for `streamlink https://www.youtube.com/user/france24 best` - - :: - - http://127.0.0.1:53422/base64/c3RyZWFtbGluayBodHRwczovL3d3dy55b3V0dWJlLmNvbS91c2VyL2ZyYW5jZTI0IGJlc3Q=/ - -Youtube-DL -~~~~~~~~~~ - - :: - - http://127.0.0.1:53422/base64/YOUTUBE-DL-COMMANDS/ - - Example for `youtube-dl https://www.youtube.com/user/france24/live` - - :: - - http://127.0.0.1:53422/base64/eW91dHViZS1kbCBodHRwczovL3d3dy55b3V0dWJlLmNvbS91c2VyL2ZyYW5jZTI0L2xpdmU=/ - -LiveProxy-Command -~~~~~~~~~~~~~~~~~ - - LiveProxy can create this URL automatically. - - Create a new file with your commands. - - :: - - #EXTM3U - #EXTINF:-1,Arte FR - streamlink https://www.arte.tv/fr/direct/ 720p,720p_alt,best - #EXTINF:-1,France24 - streamlink https://www.youtube.com/user/france24 best - #EXTINF:-1 tvg-id="EuroNews" tvg-name="EuroNews",Euronews - streamlink https://www.euronews.com/live best - #EXTINF:-1,France24 - youtube-dl https://www.youtube.com/user/france24/live - - For this example the filename is `example.m3u` - - :: - - liveproxy --file example.m3u - - It will create a new file `example.m3u.new` with valid URLs,|br| - only lines with `streamlink`, `youtube-dl` or `youtube_dl` at the start will be changed. - - :: - - #EXTM3U - #EXTINF:-1,Arte FR - http://127.0.0.1:53422/base64/c3RyZWFtbGluayBodHRwczovL3d3dy5hcnRlLnR2L2ZyL2RpcmVjdC8gNzIwcCw3MjBwX2FsdCxiZXN0/ - #EXTINF:-1,France24 - http://127.0.0.1:53422/base64/c3RyZWFtbGluayBodHRwczovL3d3dy55b3V0dWJlLmNvbS91c2VyL2ZyYW5jZTI0IGJlc3Q=/ - #EXTINF:-1 tvg-id="EuroNews" tvg-name="EuroNews",Euronews - http://127.0.0.1:53422/base64/c3RyZWFtbGluayBodHRwczovL3d3dy5ldXJvbmV3cy5jb20vbGl2ZSBiZXN0/ - #EXTINF:-1,France24 - http://127.0.0.1:53422/base64/eW91dHViZS1kbCBodHRwczovL3d3dy55b3V0dWJlLmNvbS91c2VyL2ZyYW5jZTI0L2xpdmU=/ - - You can also use ``--file-output`` for a specified new file,|br| - but be careful don't overwrite any important files. - - :: - - liveproxy --file example.m3u --file-output my_file.m3u - -Examples --------- - -URL -~~~ - - Here are some finished working examples. - - **Euronews** (Streamlink) - - :: - - http://127.0.0.1:53422/base64/c3RyZWFtbGluayBodHRwczovL3d3dy5ldXJvbmV3cy5jb20vbGl2ZSBiZXN0/ - - **France24** (Streamlink) - - :: - - http://127.0.0.1:53422/base64/c3RyZWFtbGluayBodHRwczovL3d3dy55b3V0dWJlLmNvbS91c2VyL2ZyYW5jZTI0IGJlc3Q=/ - - **France24** (Youtube-DL) - - :: - - http://127.0.0.1:53422/base64/eW91dHViZS1kbCBodHRwczovL3d3dy55b3V0dWJlLmNvbS91c2VyL2ZyYW5jZTI0L2xpdmU=/ - -M3U -~~~ - - **Euronews** - - :: - - #EXTINF:-1 tvg-id="EURONEWS" group-title="English;News" tvg-logo="",Euronews - http://127.0.0.1:53422/base64/c3RyZWFtbGluayBodHRwczovL3d3dy5ldXJvbmV3cy5jb20vbGl2ZSBiZXN0/ - - **France24** - - :: - - #EXTINF:-1 tvg-id="France24" group-title="English;News" tvg-logo="",France24 - http://127.0.0.1:53422/base64/c3RyZWFtbGluayBodHRwczovL3d3dy55b3V0dWJlLmNvbS91c2VyL2ZyYW5jZTI0IGJlc3Q=/ - - -Userbouquet -^^^^^^^^^^^ - - If you use the webinterface, you can just copy your finished URL there. |br| - But if you use a text editor, you will have to create a valid Userbouquet. - - I will use the service id **4097** IPTV for my examples. - - You can use a different service id such as - - - service **5001** gstplayer (gstreamer) - - service **5002** exteplayer3 (ffmpeg) - - You might need to install a serviceapp for **5001** and **5002** - - :: - - opkg install enigma2-plugin-systemplugins-serviceapp - - .. note:: - - But I only tested it with **4097** - - **Euronews** - - :: - - #SERVICE 4097:0:1:0:0:0:0:0:0:0:http%3a//127.0.0.1%3a53422/base64/c3RyZWFtbGluayBodHRwczovL3d3dy5ldXJvbmV3cy5jb20vbGl2ZSBiZXN0/:Euronews - #DESCRIPTION Euronews - - **France24** - - :: - - #SERVICE 4097:0:1:0:0:0:0:0:0:0:http%3a//127.0.0.1%3a53422/base64/c3RyZWFtbGluayBodHRwczovL3d3dy55b3V0dWJlLmNvbS91c2VyL2ZyYW5jZTI0IGJlc3Q=/:France24 - #DESCRIPTION France24 diff --git a/requirements-docs.txt b/requirements-docs.txt deleted file mode 100644 index 8213302..0000000 --- a/requirements-docs.txt +++ /dev/null @@ -1,2 +0,0 @@ -sphinx -sphinx_rtd_theme