1+ ** Deployments**
2+
3+ [ ![ pages] ( https://github.com/thevickypedia/pystream/actions/workflows/pages/pages-build-deployment/badge.svg )] [ gha_pages ]
4+ [ ![ pypi] ( https://github.com/thevickypedia/pystream/actions/workflows/python-publish.yml/badge.svg )] [ gha_pypi ]
5+
6+ [ ![ PyPI version shields.io] ( https://img.shields.io/pypi/v/stream-localhost )] [ pypi ]
7+ [ ![ Pypi-format] ( https://img.shields.io/pypi/format/stream-localhost )] ( https://pypi.org/project/stream-localhost/#files )
8+ [ ![ Pypi-status] ( https://img.shields.io/pypi/status/stream-localhost )] [ pypi ]
9+
110# Video Streaming
211Video streaming using FastAPI
312
@@ -17,3 +26,60 @@ Video streaming using FastAPI
1726> - ` IP_HOSTED ` is typically set to ` True ` if port forwarding is used to expose the API
1827> - This will allow the application to host the API on local IP instead of ` localhost ` (if ` VIDEO_HOST ` is ` None ` )
1928> - This can also be done by specifying the local IP for the env var ` VIDEO_HOST ` manually
29+
30+ ## Coding Standards
31+ Docstring format: [ ` Google ` ] [ google-docs ] <br >
32+ Styling conventions: [ ` PEP 8 ` ] [ pep8 ] and [ ` isort ` ] [ isort ]
33+
34+ ## [ Release Notes] [ release-notes ]
35+ ** Requirement**
36+ ``` shell
37+ python -m pip install gitverse
38+ ```
39+
40+ ** Usage**
41+ ``` shell
42+ gitverse-release reverse -f release_notes.rst -t ' Release Notes'
43+ ```
44+
45+ ## Linting
46+ ` pre-commit ` will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL
47+ markdown files (including Wiki pages)
48+
49+ ** Requirement**
50+ ``` shell
51+ pip install sphinx==5.1.1 pre-commit recommonmark
52+ ```
53+
54+ ** Usage**
55+ ``` shell
56+ pre-commit run --all-files
57+ ```
58+
59+ ## Pypi Package
60+ [ ![ pypi-module] ( https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg )] [ pypi-repo ]
61+
62+ [ https://pypi.org/project/stream-localhost/ ] [ pypi ]
63+
64+ ## Runbook
65+ [ ![ made-with-sphinx-doc] ( https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg )] [ sphinx ]
66+
67+ [ https://jarvis-docs.vigneshrao.com/ ] [ runbook ]
68+
69+ ## License & copyright
70+
71+ © ; Vignesh Rao
72+
73+ Licensed under the [ MIT License] [ license ]
74+
75+ [ license ] : https://github.com/thevickypedia/pystream/blob/master/LICENSE
76+ [ pypi ] : https://pypi.org/project/stream-localhost
77+ [ pypi-repo ] : https://packaging.python.org/tutorials/packaging-projects/
78+ [ release-notes ] : https://github.com/thevickypedia/pystream/blob/master/release_notes.rst
79+ [ gha_pages ] : https://github.com/thevickypedia/pystream/actions/workflows/pages/pages-build-deployment
80+ [ gha_pypi ] : https://github.com/thevickypedia/pystream/actions/workflows/python-publish.yml
81+ [ google-docs ] : https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
82+ [ pep8 ] : https://www.python.org/dev/peps/pep-0008/
83+ [ isort ] : https://pycqa.github.io/isort/
84+ [ sphinx ] : https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
85+ [ runbook ] : https://jarvis-docs.vigneshrao.com/
0 commit comments