Welcome to Stream’s documentation!¶
+Stream-Localhost - A secured interface to stream videos¶
Read Me:
-
@@ -350,7 +350,7 @@
- -pystream.models.ngrok.run_tunnel(logger: Logger) → None¶ +pystream.models.ngrok.run_tunnel(logger: Logger, **kwargs) → None¶
Runs reverse proxy on video port to expose it using a public URL.
- Parameters: @@ -606,7 +606,7 @@
Indices and tablesTable of Contents
Models
diff --git a/docs/objects.inv b/docs/objects.inv
index f99e4d3..abbd7f1 100644
Binary files a/docs/objects.inv and b/docs/objects.inv differ
diff --git a/docs/searchindex.js b/docs/searchindex.js
index d48045d..bf34ced 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["Video Streaming", "Welcome to Stream\u2019s documentation!"], "terms": {"deploy": 0, "us": [0, 1], "fastapi": [0, 1], "python": 0, "m": 0, "pip": 0, "localhost": 0, "import": 0, "pystream": [0, 1], "__name__": 0, "__main__": 0, "start": [0, 1], "environ": [0, 1], "can": 0, "load": [0, 1], "from": [0, 1], "ani": [0, 1], "file": [0, 1], "default": 0, "set": 0, "var": [0, 1], "env_fil": [0, 1], "filenam": [0, 1], "mandatori": 0, "usernam": [0, 1], "choic": 0, "password": [0, 1], "_": 0, "sourc": 0, "path": [0, 1], "mp4": 0, "option": [0, 1], "host": 0, "ip": 0, "address": 0, "127": [0, 1], "0": [0, 1], "1": [0, 1], "port": [0, 1], "number": 0, "applic": 0, "8000": [0, 1], "websit": [0, 1], "add": [0, 1], "cor": 0, "configur": [0, 1], "worker": [0, 1], "spin": 0, "up": 0, "uvicorn": [0, 1], "server": 0, "docstr": 0, "format": 0, "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "isort": 0, "requir": [0, 1], "gitvers": 0, "revers": [0, 1], "f": 0, "release_not": 0, "rst": 0, "t": 0, "pre": 0, "commit": 0, "ensur": 0, "run": [0, 1], "pytest": 0, "gener": 0, "valid": [0, 1], "hyperlink": 0, "all": [0, 1], "markdown": 0, "includ": 0, "wiki": 0, "page": [0, 1], "sphinx": 0, "5": 0, "recommonmark": 0, "http": 0, "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "instal": 1, "usag": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "startup_task": 1, "none": 1, "task": 1, "need": 1, "dure": 1, "api": 1, "startup": 1, "kwarg": 1, "starter": 1, "function": 1, "paramet": 1, "keyword": 1, "argument": 1, "env": 1, "async": 1, "verifi": 1, "credenti": 1, "httpbasiccredenti": 1, "jsonrespons": 1, "client": 1, "return": 1, "json": 1, "respons": 1, "content": 1, "statu": 1, "type": 1, "class": 1, "envconfig": 1, "_case_sensit": 1, "bool": 1, "_env_prefix": 1, "str": 1, "_env_fil": 1, "dotenvtyp": 1, "posixpath": 1, "_env_file_encod": 1, "_env_nested_delimit": 1, "_secrets_dir": 1, "video_sourc": 1, "video_port": 1, "int": 1, "url": 1, "ngrok_token": 1, "video_host": 1, "ipv4address": 1, "pydant": 1, "share": 1, "across": 1, "creat": 1, "new": 1, "pars": 1, "input": 1, "data": 1, "rais": 1, "validationerror": 1, "pydantic_cor": 1, "cannot": 1, "form": 1, "__init__": 1, "__pydantic_self__": 1, "instead": 1, "more": 1, "common": 1, "self": 1, "first": 1, "arg": 1, "allow": 1, "field": 1, "name": 1, "variabl": 1, "env_prefix": 1, "extra": 1, "ignor": 1, "fileio": 1, "index": 1, "html": 1, "list_fil": 1, "static": 1, "chunk_siz": 1, "1048576": 1, "vault": 1, "object": 1, "store": 1, "valu": 1, "session": 1, "info": 1, "dict": 1, "inform": 1, "alia": 1, "videofilt": 1, "initi": 1, "log": 1, "while": 1, "preserv": 1, "other": 1, "access": 1, "overrid": 1, "implement": 1, "subclass": 1, "The": 1, "method": 1, "record": 1, "examin": 1, "true": 1, "fals": 1, "discard": 1, "logger": 1, "which": 1, "togeth": 1, "its": 1, "children": 1, "have": 1, "event": 1, "through": 1, "If": 1, "i": 1, "specifi": 1, "everi": 1, "logrecord": 1, "out": 1, "repres": 1, "an": 1, "time": 1, "someth": 1, "flag": 1, "endpoint": 1, "rootfilt": 1, "get_tunnel": 1, "union": 1, "noreturn": 1, "check": 1, "activ": 1, "public": 1, "tunnel": 1, "httpurl": 1, "run_tunnel": 1, "proxi": 1, "expos": 1, "take": 1, "custom": 1, "log_connect": 1, "request": 1, "connect": 1, "onli": 1, "devic": 1, "thi": 1, "avoid": 1, "multipl": 1, "when": 1, "same": 1, "differ": 1, "get_dir_cont": 1, "parent": 1, "subdir": 1, "list": 1, "get": 1, "insid": 1, "particular": 1, "directori": 1, "displai": 1, "login": 1, "subdirectori": 1, "within": 1, "exist": 1, "A": 1, "dictionari": 1, "filepath": 1, "kei": 1, "pair": 1, "get_stream_cont": 1, "folder": 1, "contain": 1, "each": 1, "section": 1, "send_bytes_range_request": 1, "file_obj": 1, "binaryio": 1, "start_rang": 1, "end_rang": 1, "asynciter": 1, "bytestr": 1, "send": 1, "chunk": 1, "rang": 1, "specif": 1, "rfc7233": 1, "byte": 1, "end": 1, "yield": 1, "iter": 1, "get_range_head": 1, "range_head": 1, "file_s": 1, "tupl": 1, "proce": 1, "header": 1, "size": 1, "range_requests_respons": 1, "file_path": 1, "streamingrespons": 1, "given": 1, "auth": 1, "depend": 1, "httpbasic": 1, "templaterespons": 1, "handler": 1, "templat": 1, "logout": 1, "401": 1, "user": 1, "httpexcept": 1, "messag": 1, "get_favicon": 1, "filerespons": 1, "favicon": 1, "ico": 1, "support": 1, "robinhood": 1, "script": 1, "root": 1, "redirectrespons": 1, "render": 1, "redirect": 1, "stream_video": 1, "video_path": 1, "ha": 1, "video_endpoint": 1, "receiv": 1, "cooki": 1, "search": 1}, "objects": {"pystream": [[1, 0, 0, "-", "main"]], "pystream.main": [[1, 1, 1, "", "start"], [1, 1, 1, "", "startup_tasks"]], "pystream.models": [[1, 0, 0, "-", "authenticator"], [1, 0, 0, "-", "config"], [1, 0, 0, "-", "filters"], [1, 0, 0, "-", "ngrok"], [1, 0, 0, "-", "squire"], [1, 0, 0, "-", "stream"]], "pystream.models.authenticator": [[1, 1, 1, "", "verify"]], "pystream.models.config": [[1, 2, 1, "", "EnvConfig"], [1, 2, 1, "", "FileIO"], [1, 2, 1, "", "Session"], [1, 2, 1, "", "Static"], [1, 3, 1, "", "env"]], "pystream.models.config.EnvConfig": [[1, 2, 1, "", "Config"], [1, 3, 1, "", "ngrok_token"], [1, 3, 1, "", "password"], [1, 3, 1, "", "username"], [1, 3, 1, "", "video_host"], [1, 3, 1, "", "video_port"], [1, 3, 1, "", "video_source"], [1, 3, 1, "", "website"], [1, 3, 1, "", "workers"]], "pystream.models.config.EnvConfig.Config": [[1, 3, 1, "", "env_file"], [1, 3, 1, "", "env_prefix"], [1, 3, 1, "", "extra"]], "pystream.models.config.FileIO": [[1, 3, 1, "", "index"], [1, 3, 1, "", "list_files"]], "pystream.models.config.Session": [[1, 3, 1, "", "info"]], "pystream.models.config.Static": [[1, 3, 1, "", "CHUNK_SIZE"], [1, 3, 1, "", "VAULT"]], "pystream.models.filters": [[1, 2, 1, "", "RootFilter"], [1, 2, 1, "", "VideoFilter"]], "pystream.models.filters.RootFilter": [[1, 4, 1, "", "filter"]], "pystream.models.filters.VideoFilter": [[1, 4, 1, "", "filter"]], "pystream.models.ngrok": [[1, 1, 1, "", "get_tunnel"], [1, 1, 1, "", "run_tunnel"]], "pystream.models.squire": [[1, 1, 1, "", "get_dir_content"], [1, 1, 1, "", "get_stream_content"], [1, 1, 1, "", "log_connection"]], "pystream.models.stream": [[1, 1, 1, "", "get_range_header"], [1, 1, 1, "", "range_requests_response"], [1, 1, 1, "", "send_bytes_range_requests"]], "pystream.routers": [[1, 0, 0, "-", "auth"], [1, 0, 0, "-", "basics"], [1, 0, 0, "-", "video"]], "pystream.routers.auth": [[1, 1, 1, "", "login"], [1, 1, 1, "", "logout"]], "pystream.routers.basics": [[1, 1, 1, "", "get_favicon"], [1, 1, 1, "", "root"]], "pystream.routers.video": [[1, 1, 1, "", "stream_video"], [1, 1, 1, "", "video_endpoint"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "titleterms": {"video": [0, 1], "stream": [0, 1], "instal": 0, "usag": 0, "env": 0, "variabl": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "read": 1, "me": 1, "main": 1, "modul": 1, "model": 1, "authent": 1, "config": 1, "filter": 1, "ngrok": 1, "squir": 1, "router": 1, "basic": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}})
\ No newline at end of file
+Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["Video Streaming", "Stream-Localhost - A secured interface to stream videos"], "terms": {"deploy": 0, "python": 0, "modul": 0, "via": 0, "authent": 0, "session": [0, 1], "us": [0, 1], "fastapi": [0, 1], "m": 0, "pip": 0, "localhost": 0, "import": 0, "pystream": [0, 1], "__name__": 0, "__main__": 0, "start": [0, 1], "environ": [0, 1], "can": 0, "load": [0, 1], "from": [0, 1], "ani": [0, 1], "file": [0, 1], "default": 0, "set": 0, "var": [0, 1], "env_fil": [0, 1], "filenam": [0, 1], "mandatori": 0, "usernam": [0, 1], "choic": 0, "password": [0, 1], "_": 0, "sourc": 0, "path": [0, 1], "mp4": 0, "option": [0, 1], "host": 0, "ip": 0, "address": 0, "127": [0, 1], "0": [0, 1], "1": [0, 1], "port": [0, 1], "number": 0, "applic": 0, "8000": [0, 1], "websit": [0, 1], "add": [0, 1], "cor": 0, "configur": [0, 1], "worker": [0, 1], "spin": 0, "up": 0, "uvicorn": [0, 1], "server": 0, "docstr": 0, "format": 0, "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "isort": 0, "requir": [0, 1], "gitvers": 0, "revers": [0, 1], "f": 0, "release_not": 0, "rst": 0, "t": 0, "pre": 0, "commit": 0, "ensur": 0, "run": [0, 1], "pytest": 0, "gener": 0, "valid": [0, 1], "hyperlink": 0, "all": [0, 1], "markdown": 0, "includ": 0, "wiki": 0, "page": [0, 1], "sphinx": 0, "5": 0, "recommonmark": 0, "http": 0, "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "instal": 1, "usag": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "startup_task": 1, "none": 1, "task": 1, "need": 1, "dure": 1, "api": 1, "startup": 1, "kwarg": 1, "starter": 1, "function": 1, "paramet": 1, "keyword": 1, "argument": 1, "env": 1, "async": 1, "verifi": 1, "credenti": 1, "httpbasiccredenti": 1, "jsonrespons": 1, "client": 1, "return": 1, "json": 1, "respons": 1, "content": 1, "statu": 1, "type": 1, "class": 1, "envconfig": 1, "_case_sensit": 1, "bool": 1, "_env_prefix": 1, "str": 1, "_env_fil": 1, "dotenvtyp": 1, "posixpath": 1, "_env_file_encod": 1, "_env_nested_delimit": 1, "_secrets_dir": 1, "video_sourc": 1, "video_port": 1, "int": 1, "url": 1, "ngrok_token": 1, "video_host": 1, "ipv4address": 1, "pydant": 1, "share": 1, "across": 1, "creat": 1, "new": 1, "pars": 1, "input": 1, "data": 1, "rais": 1, "validationerror": 1, "pydantic_cor": 1, "cannot": 1, "form": 1, "__init__": 1, "__pydantic_self__": 1, "instead": 1, "more": 1, "common": 1, "self": 1, "first": 1, "arg": 1, "allow": 1, "field": 1, "name": 1, "variabl": 1, "env_prefix": 1, "extra": 1, "ignor": 1, "fileio": 1, "index": 1, "html": 1, "list_fil": 1, "static": 1, "chunk_siz": 1, "1048576": 1, "vault": 1, "object": 1, "store": 1, "valu": 1, "info": 1, "dict": 1, "inform": 1, "alia": 1, "videofilt": 1, "initi": 1, "log": 1, "while": 1, "preserv": 1, "other": 1, "access": 1, "overrid": 1, "implement": 1, "subclass": 1, "The": 1, "method": 1, "record": 1, "examin": 1, "true": 1, "fals": 1, "discard": 1, "logger": 1, "which": 1, "togeth": 1, "its": 1, "children": 1, "have": 1, "event": 1, "through": 1, "If": 1, "i": 1, "specifi": 1, "everi": 1, "logrecord": 1, "out": 1, "repres": 1, "an": 1, "time": 1, "someth": 1, "flag": 1, "endpoint": 1, "rootfilt": 1, "get_tunnel": 1, "union": 1, "noreturn": 1, "check": 1, "activ": 1, "public": 1, "tunnel": 1, "httpurl": 1, "run_tunnel": 1, "proxi": 1, "expos": 1, "take": 1, "custom": 1, "log_connect": 1, "request": 1, "connect": 1, "onli": 1, "devic": 1, "thi": 1, "avoid": 1, "multipl": 1, "when": 1, "same": 1, "differ": 1, "get_dir_cont": 1, "parent": 1, "subdir": 1, "list": 1, "get": 1, "insid": 1, "particular": 1, "directori": 1, "displai": 1, "login": 1, "subdirectori": 1, "within": 1, "exist": 1, "dictionari": 1, "filepath": 1, "kei": 1, "pair": 1, "get_stream_cont": 1, "folder": 1, "contain": 1, "each": 1, "section": 1, "send_bytes_range_request": 1, "file_obj": 1, "binaryio": 1, "start_rang": 1, "end_rang": 1, "asynciter": 1, "bytestr": 1, "send": 1, "chunk": 1, "rang": 1, "specif": 1, "rfc7233": 1, "byte": 1, "end": 1, "yield": 1, "iter": 1, "get_range_head": 1, "range_head": 1, "file_s": 1, "tupl": 1, "proce": 1, "header": 1, "size": 1, "range_requests_respons": 1, "file_path": 1, "streamingrespons": 1, "given": 1, "auth": 1, "depend": 1, "httpbasic": 1, "templaterespons": 1, "handler": 1, "templat": 1, "logout": 1, "401": 1, "user": 1, "httpexcept": 1, "messag": 1, "get_favicon": 1, "filerespons": 1, "favicon": 1, "ico": 1, "support": 1, "robinhood": 1, "script": 1, "": 1, "root": 1, "redirectrespons": 1, "render": 1, "redirect": 1, "stream_video": 1, "video_path": 1, "ha": 1, "video_endpoint": 1, "receiv": 1, "cooki": 1, "search": 1}, "objects": {"pystream": [[1, 0, 0, "-", "main"]], "pystream.main": [[1, 1, 1, "", "start"], [1, 1, 1, "", "startup_tasks"]], "pystream.models": [[1, 0, 0, "-", "authenticator"], [1, 0, 0, "-", "config"], [1, 0, 0, "-", "filters"], [1, 0, 0, "-", "ngrok"], [1, 0, 0, "-", "squire"], [1, 0, 0, "-", "stream"]], "pystream.models.authenticator": [[1, 1, 1, "", "verify"]], "pystream.models.config": [[1, 2, 1, "", "EnvConfig"], [1, 2, 1, "", "FileIO"], [1, 2, 1, "", "Session"], [1, 2, 1, "", "Static"], [1, 3, 1, "", "env"]], "pystream.models.config.EnvConfig": [[1, 2, 1, "", "Config"], [1, 3, 1, "", "ngrok_token"], [1, 3, 1, "", "password"], [1, 3, 1, "", "username"], [1, 3, 1, "", "video_host"], [1, 3, 1, "", "video_port"], [1, 3, 1, "", "video_source"], [1, 3, 1, "", "website"], [1, 3, 1, "", "workers"]], "pystream.models.config.EnvConfig.Config": [[1, 3, 1, "", "env_file"], [1, 3, 1, "", "env_prefix"], [1, 3, 1, "", "extra"]], "pystream.models.config.FileIO": [[1, 3, 1, "", "index"], [1, 3, 1, "", "list_files"]], "pystream.models.config.Session": [[1, 3, 1, "", "info"]], "pystream.models.config.Static": [[1, 3, 1, "", "CHUNK_SIZE"], [1, 3, 1, "", "VAULT"]], "pystream.models.filters": [[1, 2, 1, "", "RootFilter"], [1, 2, 1, "", "VideoFilter"]], "pystream.models.filters.RootFilter": [[1, 4, 1, "", "filter"]], "pystream.models.filters.VideoFilter": [[1, 4, 1, "", "filter"]], "pystream.models.ngrok": [[1, 1, 1, "", "get_tunnel"], [1, 1, 1, "", "run_tunnel"]], "pystream.models.squire": [[1, 1, 1, "", "get_dir_content"], [1, 1, 1, "", "get_stream_content"], [1, 1, 1, "", "log_connection"]], "pystream.models.stream": [[1, 1, 1, "", "get_range_header"], [1, 1, 1, "", "range_requests_response"], [1, 1, 1, "", "send_bytes_range_requests"]], "pystream.routers": [[1, 0, 0, "-", "auth"], [1, 0, 0, "-", "basics"], [1, 0, 0, "-", "video"]], "pystream.routers.auth": [[1, 1, 1, "", "login"], [1, 1, 1, "", "logout"]], "pystream.routers.basics": [[1, 1, 1, "", "get_favicon"], [1, 1, 1, "", "root"]], "pystream.routers.video": [[1, 1, 1, "", "stream_video"], [1, 1, 1, "", "video_endpoint"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "titleterms": {"video": [0, 1], "stream": [0, 1], "instal": 0, "usag": 0, "env": 0, "variabl": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "localhost": 1, "A": 1, "secur": 1, "interfac": 1, "read": 1, "me": 1, "main": 1, "modul": 1, "model": 1, "authent": 1, "config": 1, "filter": 1, "ngrok": 1, "squir": 1, "router": 1, "basic": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}})
\ No newline at end of file
diff --git a/release_notes.rst b/release_notes.rst
index 81d4628..118ac9e 100644
--- a/release_notes.rst
+++ b/release_notes.rst
@@ -1,6 +1,12 @@
Release Notes
=============
+v0.0.1b (12/04/2023)
+--------------------
+- Install ``ngrok`` as an exteion package only if needed
+- Remove ``ip_hosted`` flag
+- Add utils package to get public IP and local IP
+
v0.0.1a (12/03/2023)
--------------------
- Release alpha version of ``stream-localhost``