diff --git a/README.md b/README.md index abe52eb..cd721c4 100644 --- a/README.md +++ b/README.md @@ -33,22 +33,24 @@ if __name__ == '__main__': ``` ### Env Variables -> :bulb:   Environment variables can be loaded from any file. -> Defaults to `.env` (_set the env var `env_file` to the filename_) +> :bulb:   Environment variables can be loaded from any file. _Defaults to `.env`_
+> Set the env var `env_file` to the filename to use custom `.env` files **Mandatory** - **USERNAME**: Any username of choice. - **PASSWORD**: Any password of choice. -- **VIDEO_SOURCE**: Source path for `.mp4` files. +- **VIDEO_SOURCE**: Source path for video files. > :bulb:   Files starting with `_` _(underscore)_ will be ignored **Optional** - **VIDEO_HOST**: IP address to host the video. Defaults to `127.0.0.1` - **VIDEO_PORT**: Port number to host the application. Defaults to `8000` +- **FILE_FORMATS**: Sequence of supported video file formats. Defaults to `(.mp4, .mov)` - **WORKERS**: Number of workers to spin up the `uvicorn` server. Defaults to `1` - **WEBSITE**: Website to add to CORS configuration. _Required only if tunneled via CDN_ - **AUTO_THUMBNAIL**: Boolean flag to auto generate thumbnail images for preview. Defaults to `True` - **SCAN_INTERVAL**: Interval in seconds to scan `VIDEO_SOURCE` in the background. Defaults traditional scan at run time. +- **NGROK_TOKEN**: Ngrok token to initiate tunneling via public endpoint. > :bulb:   When `SCAN_INTERVAL` is set to `None`, `VIDEO_SOURCE` will be scanned in real time whenever the user > loads the landing page. Setting a `SCAN_INTERVAL` will scan the `VIDEO_SOURCE` in background and reduce runtime > delays in case of complex directory structure. diff --git a/docs/README.html b/docs/README.html index 003e008..d1dc5f2 100644 --- a/docs/README.html +++ b/docs/README.html @@ -77,14 +77,14 @@

Usage

Env Variables

-

:bulb:   Environment variables can be loaded from any file. -Defaults to .env (set the env var env_file to the filename)

+

:bulb:   Environment variables can be loaded from any file. Defaults to .env
+Set the env var env_file to the filename to use custom .env files

Mandatory

:bulb:   Files starting with _ (underscore) will be ignored

@@ -93,10 +93,12 @@

Env Variables

  • VIDEO_HOST: IP address to host the video. Defaults to 127.0.0.1

  • VIDEO_PORT: Port number to host the application. Defaults to 8000

    • +

  • FILE_FORMATS: Sequence of supported video file formats. Defaults to (.mp4, .mov)

  • WORKERS: Number of workers to spin up the uvicorn server. Defaults to 1

  • WEBSITE: Website to add to CORS configuration. Required only if tunneled via CDN

  • AUTO_THUMBNAIL: Boolean flag to auto generate thumbnail images for preview. Defaults to True

  • SCAN_INTERVAL: Interval in seconds to scan VIDEO_SOURCE in the background. Defaults traditional scan at run time.

    • +

  • NGROK_TOKEN: Ngrok token to initiate tunneling via public endpoint.

    • :bulb:   When SCAN_INTERVAL is set to None, VIDEO_SOURCE will be scanned in real time whenever the user diff --git a/docs/README.md b/docs/README.md index abe52eb..cd721c4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -33,22 +33,24 @@ if __name__ == '__main__': ``` ### Env Variables -> :bulb:   Environment variables can be loaded from any file. -> Defaults to `.env` (_set the env var `env_file` to the filename_) +> :bulb:   Environment variables can be loaded from any file. _Defaults to `.env`_
    +> Set the env var `env_file` to the filename to use custom `.env` files **Mandatory** - **USERNAME**: Any username of choice. - **PASSWORD**: Any password of choice. -- **VIDEO_SOURCE**: Source path for `.mp4` files. +- **VIDEO_SOURCE**: Source path for video files. > :bulb:   Files starting with `_` _(underscore)_ will be ignored **Optional** - **VIDEO_HOST**: IP address to host the video. Defaults to `127.0.0.1` - **VIDEO_PORT**: Port number to host the application. Defaults to `8000` +- **FILE_FORMATS**: Sequence of supported video file formats. Defaults to `(.mp4, .mov)` - **WORKERS**: Number of workers to spin up the `uvicorn` server. Defaults to `1` - **WEBSITE**: Website to add to CORS configuration. _Required only if tunneled via CDN_ - **AUTO_THUMBNAIL**: Boolean flag to auto generate thumbnail images for preview. Defaults to `True` - **SCAN_INTERVAL**: Interval in seconds to scan `VIDEO_SOURCE` in the background. Defaults traditional scan at run time. +- **NGROK_TOKEN**: Ngrok token to initiate tunneling via public endpoint. > :bulb:   When `SCAN_INTERVAL` is set to `None`, `VIDEO_SOURCE` will be scanned in real time whenever the user > loads the landing page. Setting a `SCAN_INTERVAL` will scan the `VIDEO_SOURCE` in background and reduce runtime > delays in case of complex directory structure. diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt index abe52eb..cd721c4 100644 --- a/docs/_sources/README.md.txt +++ b/docs/_sources/README.md.txt @@ -33,22 +33,24 @@ if __name__ == '__main__': ``` ### Env Variables -> :bulb:   Environment variables can be loaded from any file. -> Defaults to `.env` (_set the env var `env_file` to the filename_) +> :bulb:   Environment variables can be loaded from any file. _Defaults to `.env`_
    +> Set the env var `env_file` to the filename to use custom `.env` files **Mandatory** - **USERNAME**: Any username of choice. - **PASSWORD**: Any password of choice. -- **VIDEO_SOURCE**: Source path for `.mp4` files. +- **VIDEO_SOURCE**: Source path for video files. > :bulb:   Files starting with `_` _(underscore)_ will be ignored **Optional** - **VIDEO_HOST**: IP address to host the video. Defaults to `127.0.0.1` - **VIDEO_PORT**: Port number to host the application. Defaults to `8000` +- **FILE_FORMATS**: Sequence of supported video file formats. Defaults to `(.mp4, .mov)` - **WORKERS**: Number of workers to spin up the `uvicorn` server. Defaults to `1` - **WEBSITE**: Website to add to CORS configuration. _Required only if tunneled via CDN_ - **AUTO_THUMBNAIL**: Boolean flag to auto generate thumbnail images for preview. Defaults to `True` - **SCAN_INTERVAL**: Interval in seconds to scan `VIDEO_SOURCE` in the background. Defaults traditional scan at run time. +- **NGROK_TOKEN**: Ngrok token to initiate tunneling via public endpoint. > :bulb:   When `SCAN_INTERVAL` is set to `None`, `VIDEO_SOURCE` will be scanned in real time whenever the user > loads the landing page. Setting a `SCAN_INTERVAL` will scan the `VIDEO_SOURCE` in background and reduce runtime > delays in case of complex directory structure. diff --git a/docs/genindex.html b/docs/genindex.html index 6641e56..cee5e69 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -138,6 +138,8 @@

    G

      +
    • get_iter() (in module pystream.models.squire) +
    • get_local_ip() (in module pystream.utils)
    • get_public_ip() (in module pystream.utils) @@ -363,6 +365,8 @@

      R

      • range_requests_response() (in module pystream.models.stream) +
        • +
      • remove_thumbnail() (in module pystream.models.squire)
      • RepeatedTimer (class in pystream.models.scheduler)
        • diff --git a/docs/index.html b/docs/index.html index fa558f7..03fc34c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -108,7 +108,7 @@

        Models

        Config

        -class pystream.models.config.EnvConfig(_case_sensitive: bool | None = None, _env_prefix: str | None = None, _env_file: DotenvType | None = PosixPath('.'), _env_file_encoding: str | None = None, _env_nested_delimiter: str | None = None, _secrets_dir: str | Path | None = None, *, username: str, password: SecretStr, video_source: Path, auto_thumbnail: bool = True, video_port: int = 8000, website: Optional[Url] = None, ngrok_token: Optional[str] = None, file_formats: Sequence[str] = ('.mov', '.mp4'), video_host: IPv4Address = '127.0.0.1', workers: int = 1, scan_interval: Optional[int] = None)
        +class pystream.models.config.EnvConfig(_case_sensitive: bool | None = None, _env_prefix: str | None = None, _env_file: DotenvType | None = PosixPath('.'), _env_file_encoding: str | None = None, _env_nested_delimiter: str | None = None, _secrets_dir: str | Path | None = None, *, username: str, password: SecretStr, video_source: Path, video_host: IPv4Address = '127.0.0.1', video_port: int = 8000, file_formats: Sequence[str] = ('.mov', '.mp4'), workers: int = 1, website: Optional[Url] = None, auto_thumbnail: bool = True, scan_interval: Optional[int] = None, ngrok_token: Optional[str] = None)

        Configure all env vars and validate using pydantic to share across modules.

        >>> EnvConfig
        @@ -134,8 +134,8 @@

        Models

        -
        -auto_thumbnail: bool
        +
        +video_host: IPv4Address
        @@ -144,33 +144,33 @@

        Models

        -
        -website: Optional[Url]
        +
        +file_formats: Sequence[str]
        -
        -ngrok_token: Optional[str]
        +
        +workers: int
        -
        -file_formats: Sequence[str]
        +
        +website: Optional[Url]
        -
        -video_host: IPv4Address
        +
        +auto_thumbnail: bool
        -
        -workers: int
        +
        +scan_interval: Optional[int]
        -
        -scan_interval: Optional[int]
        +
        +ngrok_token: Optional[str]
        @@ -524,12 +524,40 @@

        Models

        +
        +
        +pystream.models.squire.get_iter(filename: PurePath) → Union[Tuple[str, str], Tuple[None, None]]
        +

        Sort video files at the currently served file’s directory, and return the previous and next filenames.

        +
        +
        Parameters:
        +

        filename – Path to the video file currently rendered.

        +
        +
        Returns:
        +

        Tuple of previous file and next file.

        +
        +
        Return type:
        +

        Tuple[str, str]

        +
        +
        +
        +
        pystream.models.squire.scanner() → None

        Update the shared static object member to response from stream all content.

        +
        +
        +pystream.models.squire.remove_thumbnail(img_path: PosixPath) → None
        +

        Triggered by timer to remove the thumbnail file.

        +
        +
        Parameters:
        +

        img_path – PosixPath to the thumbnail image.

        +
        +
        +
        +

        Stream

        diff --git a/docs/objects.inv b/docs/objects.inv index 941a9cd..91109c7 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/searchindex.js b/docs/searchindex.js index 18f36e9..311a159 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -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, "asyncio": 0, "o": 0, "pystream": [0, 1], "__name__": 0, "__main__": 0, "kwarg": [0, 1], "dict": [0, 1], "usernam": [0, 1], "foo": 0, "password": [0, 1], "bar": 0, "video_sourc": [0, 1], "path": [0, 1], "join": 0, "expandus": 0, "download": 0, "add": [0, 1], "follow": 0, "host": [0, 1], "local": [0, 1], "ip": [0, 1], "address": [0, 1], "skip": 0, "127": [0, 1], "0": [0, 1], "1": [0, 1], "video_host": [0, 1], "util": 0, "get_local_ip": [0, 1], "run": [0, 1], "start": [0, 1], "bulb": 0, "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, "choic": 0, "_": 0, "sourc": [0, 1], "mp4": [0, 1], "underscor": 0, "ignor": [0, 1], "option": [0, 1], "port": [0, 1], "number": [0, 1], "applic": 0, "8000": [0, 1], "worker": [0, 1], "spin": 0, "up": 0, "uvicorn": [0, 1], "server": 0, "websit": [0, 1], "cor": 0, "configur": [0, 1], "requir": [0, 1], "onli": [0, 1], "tunnel": [0, 1], "cdn": 0, "auto": 0, "thumbnail": [0, 1], "boolean": [0, 1], "flag": [0, 1], "gener": [0, 1], "imag": 0, "preview": [0, 1], "true": [0, 1], "scan": 0, "interv": [0, 1], "second": [0, 1], "background": 0, "tradit": 0, "time": [0, 1], "when": [0, 1], "scan_interv": [0, 1], "i": [0, 1], "none": [0, 1], "real": 0, "whenev": 0, "user": [0, 1], "land": 0, "page": [0, 1], "reduc": 0, "runtim": 0, "delai": 0, "case": 0, "complex": 0, "directori": [0, 1], "structur": 0, "docstr": 0, "format": 0, "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "isort": 0, "gitvers": 0, "revers": [0, 1], "f": 0, "release_not": 0, "rst": 0, "t": [0, 1], "pre": 0, "commit": 0, "ensur": 0, "pytest": 0, "valid": [0, 1], "hyperlink": 0, "all": [0, 1], "markdown": 0, "includ": [0, 1], "wiki": 0, "sphinx": 0, "5": 0, "recommonmark": 0, "http": [0, 1], "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, "task": 1, "need": 1, "dure": 1, "api": 1, "startup": 1, "async": 1, "starter": 1, "function": 1, "paramet": 1, "keyword": 1, "argument": 1, "env": 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, "secretstr": 1, "auto_thumbnail": 1, "video_port": 1, "int": 1, "url": 1, "ngrok_token": 1, "file_format": 1, "sequenc": 1, "mov": 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, "hide_input_in_error": 1, "classmethod": 1, "parse_video_host": 1, "valu": 1, "string": 1, "notion": 1, "object": 1, "fileio": 1, "index": 1, "html": 1, "list_fil": 1, "static": 1, "vault": 1, "query_param": 1, "index_endpoint": 1, "logout_endpoint": 1, "logout": 1, "streaming_endpoint": 1, "chunk_siz": 1, "1048576": 1, "landing_pag": 1, "list": 1, "store": 1, "info": 1, "inform": 1, "alia": 1, "filepath": 1, "initi": 1, "captur": 1, "frame": 1, "particular": 1, "instanti": 1, "opencv": 1, "": 1, "videocaptur": 1, "generate_thumbnail": 1, "output_dir": 1, "output": 1, "success": 1, "failur": 1, "get_video_length": 1, "tupl": 1, "timedelta": 1, "get": 1, "calcul": 1, "length": 1, "datetim": 1, "generate_preview": 1, "at_second": 1, "which": 1, "should": 1, "get_tunnel": 1, "union": 1, "noreturn": 1, "check": 1, "activ": 1, "public": 1, "httpurl": 1, "run_tunnel": 1, "proxi": 1, "expos": 1, "take": 1, "custom": 1, "an": 1, "repeatedtim": 1, "callabl": 1, "kick": 1, "off": 1, "thread": 1, "timer": 1, "repeat": 1, "trigger": 1, "_run": 1, "target": 1, "isn": 1, "alreadi": 1, "stop": 1, "cancel": 1, "futur": 1, "log_connect": 1, "request": 1, "log": 1, "connect": 1, "devic": 1, "thi": 1, "avoid": 1, "multipl": 1, "same": 1, "differ": 1, "natural_sort_kei": 1, "kei": 1, "sort": 1, "natur": 1, "wai": 1, "element": 1, "deriv": 1, "split": 1, "part": 1, "regular": 1, "express": 1, "get_dir_stream_cont": 1, "parent": 1, "subdir": 1, "insid": 1, "displai": 1, "login": 1, "subdirectori": 1, "within": 1, "exist": 1, "dictionari": 1, "pair": 1, "get_all_stream_cont": 1, "folder": 1, "contain": 1, "each": 1, "section": 1, "scanner": 1, "updat": 1, "member": 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, "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, "redirectrespons": 1, "401": 1, "out": 1, "httpexcept": 1, "messag": 1, "get_favicon": 1, "filerespons": 1, "favicon": 1, "ico": 1, "endpoint": 1, "robinhood": 1, "script": 1, "root": 1, "render": 1, "redirect": 1, "preview_load": 1, "img_path": 1, "ha": 1, "stream_video": 1, "video_path": 1, "video_endpoint": 1, "receiv": 1, "cooki": 1, "rootfilt": 1, "filter": 1, "while": 1, "preserv": 1, "other": 1, "access": 1, "200": 1, "ok": 1, "307": 1, "temporari": 1, "vid_nam": 1, "redund": 1, "pass": 1, "overrid": 1, "implement": 1, "subclass": 1, "The": 1, "method": 1, "record": 1, "examin": 1, "fals": 1, "discard": 1, "togeth": 1, "its": 1, "children": 1, "have": 1, "event": 1, "through": 1, "If": 1, "specifi": 1, "everi": 1, "logrecord": 1, "repres": 1, "someth": 1, "simpl": 1, "network": 1, "id": 1, "retriev": 1, "privat": 1, "machin": 1, "get_public_ip": 1, "extract": 1, "make": 1, "extern": 1, "search": 1}, "objects": {"pystream": [[1, 0, 0, "-", "logger"], [1, 0, 0, "-", "main"], [1, 0, 0, "-", "utils"]], "pystream.logger": [[1, 1, 1, "", "RootFilter"]], "pystream.logger.RootFilter": [[1, 2, 1, "", "filter"]], "pystream.main": [[1, 3, 1, "", "start"], [1, 3, 1, "", "startup_tasks"]], "pystream.models": [[1, 0, 0, "-", "authenticator"], [1, 0, 0, "-", "config"], [1, 0, 0, "-", "images"], [1, 0, 0, "-", "ngrok"], [1, 0, 0, "-", "scheduler"], [1, 0, 0, "-", "squire"], [1, 0, 0, "-", "stream"]], "pystream.models.authenticator": [[1, 3, 1, "", "verify"]], "pystream.models.config": [[1, 1, 1, "", "EnvConfig"], [1, 1, 1, "", "FileIO"], [1, 1, 1, "", "Session"], [1, 1, 1, "", "Static"], [1, 4, 1, "", "env"]], "pystream.models.config.EnvConfig": [[1, 1, 1, "", "Config"], [1, 4, 1, "", "auto_thumbnail"], [1, 4, 1, "", "file_formats"], [1, 4, 1, "", "ngrok_token"], [1, 2, 1, "", "parse_video_host"], [1, 4, 1, "", "password"], [1, 4, 1, "", "scan_interval"], [1, 4, 1, "", "username"], [1, 4, 1, "", "video_host"], [1, 4, 1, "", "video_port"], [1, 4, 1, "", "video_source"], [1, 4, 1, "", "website"], [1, 4, 1, "", "workers"]], "pystream.models.config.EnvConfig.Config": [[1, 4, 1, "", "env_file"], [1, 4, 1, "", "env_prefix"], [1, 4, 1, "", "extra"], [1, 4, 1, "", "hide_input_in_errors"]], "pystream.models.config.FileIO": [[1, 4, 1, "", "index"], [1, 4, 1, "", "list_files"]], "pystream.models.config.Session": [[1, 4, 1, "", "info"]], "pystream.models.config.Static": [[1, 4, 1, "", "chunk_size"], [1, 4, 1, "", "index_endpoint"], [1, 4, 1, "", "landing_page"], [1, 4, 1, "", "logout_endpoint"], [1, 4, 1, "", "preview"], [1, 4, 1, "", "query_param"], [1, 4, 1, "", "streaming_endpoint"], [1, 4, 1, "", "vault"]], "pystream.models.images": [[1, 1, 1, "", "Images"]], "pystream.models.images.Images": [[1, 2, 1, "", "generate_preview"], [1, 2, 1, "", "generate_thumbnails"], [1, 2, 1, "", "get_video_length"]], "pystream.models.ngrok": [[1, 3, 1, "", "get_tunnel"], [1, 3, 1, "", "run_tunnel"]], "pystream.models.scheduler": [[1, 1, 1, "", "RepeatedTimer"]], "pystream.models.scheduler.RepeatedTimer": [[1, 2, 1, "", "_run"], [1, 2, 1, "", "cancel"], [1, 2, 1, "", "start"], [1, 2, 1, "", "stop"]], "pystream.models.squire": [[1, 3, 1, "", "get_all_stream_content"], [1, 3, 1, "", "get_dir_stream_content"], [1, 3, 1, "", "log_connection"], [1, 3, 1, "", "natural_sort_key"], [1, 3, 1, "", "scanner"]], "pystream.models.stream": [[1, 3, 1, "", "get_range_header"], [1, 3, 1, "", "range_requests_response"], [1, 3, 1, "", "send_bytes_range_requests"]], "pystream.routers": [[1, 0, 0, "-", "auth"], [1, 0, 0, "-", "basics"], [1, 0, 0, "-", "video"]], "pystream.routers.auth": [[1, 3, 1, "", "index"], [1, 3, 1, "", "logout"]], "pystream.routers.basics": [[1, 3, 1, "", "get_favicon"], [1, 3, 1, "", "root"]], "pystream.routers.video": [[1, 3, 1, "", "preview_loader"], [1, 3, 1, "", "stream_video"], [1, 3, 1, "", "video_endpoint"]], "pystream.utils": [[1, 3, 1, "", "get_local_ip"], [1, 3, 1, "", "get_public_ip"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function", "4": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"]}, "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, "imag": 1, "ngrok": 1, "schedul": 1, "squir": 1, "router": 1, "basic": 1, "support": 1, "logger": 1, "util": 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, "asyncio": 0, "o": 0, "pystream": [0, 1], "__name__": 0, "__main__": 0, "kwarg": [0, 1], "dict": [0, 1], "usernam": [0, 1], "foo": 0, "password": [0, 1], "bar": 0, "video_sourc": [0, 1], "path": [0, 1], "join": 0, "expandus": 0, "download": 0, "add": [0, 1], "follow": 0, "host": [0, 1], "local": [0, 1], "ip": [0, 1], "address": [0, 1], "skip": 0, "127": [0, 1], "0": [0, 1], "1": [0, 1], "video_host": [0, 1], "util": 0, "get_local_ip": [0, 1], "run": [0, 1], "start": [0, 1], "bulb": 0, "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], "custom": [0, 1], "mandatori": 0, "choic": 0, "_": 0, "sourc": [0, 1], "underscor": 0, "ignor": [0, 1], "option": [0, 1], "port": [0, 1], "number": [0, 1], "applic": 0, "8000": [0, 1], "format": 0, "sequenc": [0, 1], "support": 0, "mp4": [0, 1], "mov": [0, 1], "worker": [0, 1], "spin": 0, "up": 0, "uvicorn": [0, 1], "server": 0, "websit": [0, 1], "cor": 0, "configur": [0, 1], "requir": [0, 1], "onli": [0, 1], "tunnel": [0, 1], "cdn": 0, "auto": 0, "thumbnail": [0, 1], "boolean": [0, 1], "flag": [0, 1], "gener": [0, 1], "imag": 0, "preview": [0, 1], "true": [0, 1], "scan": 0, "interv": [0, 1], "second": [0, 1], "background": 0, "tradit": 0, "time": [0, 1], "ngrok": 0, "token": 0, "initi": [0, 1], "public": [0, 1], "endpoint": [0, 1], "when": [0, 1], "scan_interv": [0, 1], "i": [0, 1], "none": [0, 1], "real": 0, "whenev": 0, "user": [0, 1], "land": 0, "page": [0, 1], "reduc": 0, "runtim": 0, "delai": 0, "case": 0, "complex": 0, "directori": [0, 1], "structur": 0, "docstr": 0, "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "isort": 0, "gitvers": 0, "revers": [0, 1], "f": 0, "release_not": 0, "rst": 0, "t": [0, 1], "pre": 0, "commit": 0, "ensur": 0, "pytest": 0, "valid": [0, 1], "hyperlink": 0, "all": [0, 1], "markdown": 0, "includ": [0, 1], "wiki": 0, "sphinx": 0, "5": 0, "recommonmark": 0, "http": [0, 1], "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, "task": 1, "need": 1, "dure": 1, "api": 1, "startup": 1, "async": 1, "starter": 1, "function": 1, "paramet": 1, "keyword": 1, "argument": 1, "env": 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, "secretstr": 1, "ipv4address": 1, "video_port": 1, "int": 1, "file_format": 1, "url": 1, "auto_thumbnail": 1, "ngrok_token": 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, "hide_input_in_error": 1, "classmethod": 1, "parse_video_host": 1, "valu": 1, "string": 1, "notion": 1, "object": 1, "fileio": 1, "index": 1, "html": 1, "list_fil": 1, "static": 1, "vault": 1, "query_param": 1, "index_endpoint": 1, "logout_endpoint": 1, "logout": 1, "streaming_endpoint": 1, "chunk_siz": 1, "1048576": 1, "landing_pag": 1, "list": 1, "store": 1, "info": 1, "inform": 1, "alia": 1, "filepath": 1, "captur": 1, "frame": 1, "particular": 1, "instanti": 1, "opencv": 1, "": 1, "videocaptur": 1, "generate_thumbnail": 1, "output_dir": 1, "output": 1, "success": 1, "failur": 1, "get_video_length": 1, "tupl": 1, "timedelta": 1, "get": 1, "calcul": 1, "length": 1, "datetim": 1, "generate_preview": 1, "at_second": 1, "which": 1, "should": 1, "get_tunnel": 1, "union": 1, "noreturn": 1, "check": 1, "activ": 1, "httpurl": 1, "run_tunnel": 1, "proxi": 1, "expos": 1, "take": 1, "an": 1, "repeatedtim": 1, "callabl": 1, "kick": 1, "off": 1, "thread": 1, "timer": 1, "repeat": 1, "trigger": 1, "_run": 1, "target": 1, "isn": 1, "alreadi": 1, "stop": 1, "cancel": 1, "futur": 1, "log_connect": 1, "request": 1, "log": 1, "connect": 1, "devic": 1, "thi": 1, "avoid": 1, "multipl": 1, "same": 1, "differ": 1, "natural_sort_kei": 1, "kei": 1, "sort": 1, "natur": 1, "wai": 1, "element": 1, "deriv": 1, "split": 1, "part": 1, "regular": 1, "express": 1, "get_dir_stream_cont": 1, "parent": 1, "subdir": 1, "insid": 1, "displai": 1, "login": 1, "subdirectori": 1, "within": 1, "exist": 1, "dictionari": 1, "pair": 1, "get_all_stream_cont": 1, "folder": 1, "contain": 1, "each": 1, "section": 1, "get_it": 1, "purepath": 1, "current": 1, "serv": 1, "previou": 1, "next": 1, "render": 1, "scanner": 1, "updat": 1, "member": 1, "remove_thumbnail": 1, "img_path": 1, "remov": 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, "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, "redirectrespons": 1, "401": 1, "out": 1, "httpexcept": 1, "messag": 1, "get_favicon": 1, "filerespons": 1, "favicon": 1, "ico": 1, "robinhood": 1, "script": 1, "root": 1, "redirect": 1, "preview_load": 1, "ha": 1, "stream_video": 1, "video_path": 1, "video_endpoint": 1, "receiv": 1, "cooki": 1, "rootfilt": 1, "filter": 1, "while": 1, "preserv": 1, "other": 1, "access": 1, "200": 1, "ok": 1, "307": 1, "temporari": 1, "vid_nam": 1, "redund": 1, "pass": 1, "overrid": 1, "implement": 1, "subclass": 1, "The": 1, "method": 1, "record": 1, "examin": 1, "fals": 1, "discard": 1, "togeth": 1, "its": 1, "children": 1, "have": 1, "event": 1, "through": 1, "If": 1, "specifi": 1, "everi": 1, "logrecord": 1, "repres": 1, "someth": 1, "simpl": 1, "network": 1, "id": 1, "retriev": 1, "privat": 1, "machin": 1, "get_public_ip": 1, "extract": 1, "make": 1, "extern": 1, "search": 1}, "objects": {"pystream": [[1, 0, 0, "-", "logger"], [1, 0, 0, "-", "main"], [1, 0, 0, "-", "utils"]], "pystream.logger": [[1, 1, 1, "", "RootFilter"]], "pystream.logger.RootFilter": [[1, 2, 1, "", "filter"]], "pystream.main": [[1, 3, 1, "", "start"], [1, 3, 1, "", "startup_tasks"]], "pystream.models": [[1, 0, 0, "-", "authenticator"], [1, 0, 0, "-", "config"], [1, 0, 0, "-", "images"], [1, 0, 0, "-", "ngrok"], [1, 0, 0, "-", "scheduler"], [1, 0, 0, "-", "squire"], [1, 0, 0, "-", "stream"]], "pystream.models.authenticator": [[1, 3, 1, "", "verify"]], "pystream.models.config": [[1, 1, 1, "", "EnvConfig"], [1, 1, 1, "", "FileIO"], [1, 1, 1, "", "Session"], [1, 1, 1, "", "Static"], [1, 4, 1, "", "env"]], "pystream.models.config.EnvConfig": [[1, 1, 1, "", "Config"], [1, 4, 1, "", "auto_thumbnail"], [1, 4, 1, "", "file_formats"], [1, 4, 1, "", "ngrok_token"], [1, 2, 1, "", "parse_video_host"], [1, 4, 1, "", "password"], [1, 4, 1, "", "scan_interval"], [1, 4, 1, "", "username"], [1, 4, 1, "", "video_host"], [1, 4, 1, "", "video_port"], [1, 4, 1, "", "video_source"], [1, 4, 1, "", "website"], [1, 4, 1, "", "workers"]], "pystream.models.config.EnvConfig.Config": [[1, 4, 1, "", "env_file"], [1, 4, 1, "", "env_prefix"], [1, 4, 1, "", "extra"], [1, 4, 1, "", "hide_input_in_errors"]], "pystream.models.config.FileIO": [[1, 4, 1, "", "index"], [1, 4, 1, "", "list_files"]], "pystream.models.config.Session": [[1, 4, 1, "", "info"]], "pystream.models.config.Static": [[1, 4, 1, "", "chunk_size"], [1, 4, 1, "", "index_endpoint"], [1, 4, 1, "", "landing_page"], [1, 4, 1, "", "logout_endpoint"], [1, 4, 1, "", "preview"], [1, 4, 1, "", "query_param"], [1, 4, 1, "", "streaming_endpoint"], [1, 4, 1, "", "vault"]], "pystream.models.images": [[1, 1, 1, "", "Images"]], "pystream.models.images.Images": [[1, 2, 1, "", "generate_preview"], [1, 2, 1, "", "generate_thumbnails"], [1, 2, 1, "", "get_video_length"]], "pystream.models.ngrok": [[1, 3, 1, "", "get_tunnel"], [1, 3, 1, "", "run_tunnel"]], "pystream.models.scheduler": [[1, 1, 1, "", "RepeatedTimer"]], "pystream.models.scheduler.RepeatedTimer": [[1, 2, 1, "", "_run"], [1, 2, 1, "", "cancel"], [1, 2, 1, "", "start"], [1, 2, 1, "", "stop"]], "pystream.models.squire": [[1, 3, 1, "", "get_all_stream_content"], [1, 3, 1, "", "get_dir_stream_content"], [1, 3, 1, "", "get_iter"], [1, 3, 1, "", "log_connection"], [1, 3, 1, "", "natural_sort_key"], [1, 3, 1, "", "remove_thumbnail"], [1, 3, 1, "", "scanner"]], "pystream.models.stream": [[1, 3, 1, "", "get_range_header"], [1, 3, 1, "", "range_requests_response"], [1, 3, 1, "", "send_bytes_range_requests"]], "pystream.routers": [[1, 0, 0, "-", "auth"], [1, 0, 0, "-", "basics"], [1, 0, 0, "-", "video"]], "pystream.routers.auth": [[1, 3, 1, "", "index"], [1, 3, 1, "", "logout"]], "pystream.routers.basics": [[1, 3, 1, "", "get_favicon"], [1, 3, 1, "", "root"]], "pystream.routers.video": [[1, 3, 1, "", "preview_loader"], [1, 3, 1, "", "stream_video"], [1, 3, 1, "", "video_endpoint"]], "pystream.utils": [[1, 3, 1, "", "get_local_ip"], [1, 3, 1, "", "get_public_ip"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function", "4": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"]}, "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, "imag": 1, "ngrok": 1, "schedul": 1, "squir": 1, "router": 1, "basic": 1, "support": 1, "logger": 1, "util": 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/pystream/models/config.py b/pystream/models/config.py index 9259ac0..86f196f 100644 --- a/pystream/models/config.py +++ b/pystream/models/config.py @@ -19,15 +19,17 @@ class EnvConfig(BaseSettings): password: SecretStr video_source: DirectoryPath - auto_thumbnail: bool = True + video_host: IPv4Address = socket.gethostbyname("localhost") video_port: PositiveInt = 8000 - website: Union[HttpUrl, None] = None - ngrok_token: Union[str, None] = None file_formats: Sequence[str] = (".mov", ".mp4") - video_host: IPv4Address = socket.gethostbyname("localhost") + workers: int = Field(1, le=os.cpu_count(), ge=1, env="WORKERS") + website: Union[HttpUrl, None] = None + auto_thumbnail: bool = True scan_interval: Union[PositiveInt, None] = Field(None, ge=30, le=86_400) # range: 30s to 24h + ngrok_token: Union[str, None] = None + class Config: """Environment variables configuration.""" diff --git a/pystream/models/squire.py b/pystream/models/squire.py index d4b342f..4e2d1d9 100644 --- a/pystream/models/squire.py +++ b/pystream/models/squire.py @@ -1,7 +1,7 @@ import os import pathlib import re -from typing import Dict, List, Union, Tuple +from typing import Dict, List, Tuple, Union from fastapi import Request