stream-localhost 0.0.1a0

Python module to, stream videos via authenticated sessions using FastAPI

Deployments

Video Streaming

Video streaming using FastAPI

Env Variables

Mandatory

• USERNAME: Any username of choice.
• PASSWORD: Any password of choice.
• VIDEO_SOURCE: Source path for videos.

Optional

• IP_HOSTED: Boolean flag to specify if the API is hosted via public IP
• 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
• WEBSITE: Website to add to CORS configuration.
• WORKERS: Number of workers to spin up the uvicorn server. Defaults to 1.

• IP_HOSTED is typically set to True if port forwarding is used to expose the API
• This will allow the application to host the API on local IP instead of localhost (if VIDEO_HOST is None)
• This can also be done by specifying the local IP for the env var VIDEO_HOST manually

Coding Standards

Docstring format: Google
Styling conventions: PEP 8 and isort

Release Notes

Requirement

python -m pip install gitverse

Usage

gitverse-release reverse -f release_notes.rst -t 'Release Notes'

Linting

pre-commit will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL markdown files (including Wiki pages)

Requirement

pip install sphinx==5.1.1 pre-commit recommonmark

Usage

pre-commit run --all-files

Pypi Package

https://pypi.org/project/stream-localhost/

Runbook

https://jarvis-docs.vigneshrao.com/

License & copyright

© Vignesh Rao

Licensed under the MIT License