From 855f1f593c147bd8e9b929d7edaa9d7a50afae36 Mon Sep 17 00:00:00 2001
From: thevickypedia <vignesh.sivanandarao@gmail.com>
Date: Mon, 4 Dec 2023 00:49:58 -0600
Subject: [PATCH] Update project description

---
 README.md                   |   2 +-
 doc_gen/index.rst           |   4 ++--
 docs/README.html            |  10 +++++-----
 docs/README.md              |   2 +-
 docs/_sources/README.md.txt |   2 +-
 docs/_sources/index.rst.txt |   4 ++--
 docs/index.html             |  14 +++++++-------
 docs/objects.inv            | Bin 751 -> 752 bytes
 docs/searchindex.js         |   2 +-
 release_notes.rst           |   6 ++++++
 10 files changed, 26 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
index ff33761..e23c0cf 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@
 [![Pypi-status](https://img.shields.io/pypi/status/stream-localhost)][pypi]
 
 # Video Streaming
-Video streaming using FastAPI
+Python module to, stream videos via authenticated sessions using FastAPI
 
 ## Install
 ```shell
diff --git a/doc_gen/index.rst b/doc_gen/index.rst
index eb34c11..eae7180 100644
--- a/doc_gen/index.rst
+++ b/doc_gen/index.rst
@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Stream's documentation!
-==================================
+Stream-Localhost - A secured interface to stream videos
+=======================================================
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/README.html b/docs/README.html
index 9b51c28..cd736b6 100644
--- a/docs/README.html
+++ b/docs/README.html
@@ -18,7 +18,7 @@
     
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="Welcome to Stream’s documentation!" href="index.html" /> 
+    <link rel="prev" title="Stream-Localhost - A secured interface to stream videos" href="index.html" /> 
   </head><body>
     <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
@@ -30,7 +30,7 @@ <h3>Navigation</h3>
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="index.html" title="Welcome to Stream’s documentation!"
+          <a href="index.html" title="Stream-Localhost - A secured interface to stream videos"
              accesskey="P">previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">Stream  documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Video Streaming</a></li> 
@@ -50,7 +50,7 @@ <h3>Navigation</h3>
 <a class="reference external" href="https://pypi.org/project/stream-localhost"><img alt="Pypi-status" src="https://img.shields.io/pypi/status/stream-localhost" /></a></p>
 <section id="video-streaming">
 <h1>Video Streaming<a class="headerlink" href="#video-streaming" title="Permalink to this heading">¶</a></h1>
-<p>Video streaming using FastAPI</p>
+<p>Python module to, stream videos via authenticated sessions using FastAPI</p>
 <section id="install">
 <h2>Install<a class="headerlink" href="#install" title="Permalink to this heading">¶</a></h2>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>stream-localhost
@@ -161,7 +161,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
   <div>
     <h4>Previous topic</h4>
     <p class="topless"><a href="index.html"
-                          title="previous chapter">Welcome to Stream’s documentation!</a></p>
+                          title="previous chapter">Stream-Localhost - A secured interface to stream videos</a></p>
   </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
@@ -194,7 +194,7 @@ <h3>Navigation</h3>
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="index.html" title="Welcome to Stream’s documentation!"
+          <a href="index.html" title="Stream-Localhost - A secured interface to stream videos"
              >previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">Stream  documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Video Streaming</a></li> 
diff --git a/docs/README.md b/docs/README.md
index ff33761..e23c0cf 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -8,7 +8,7 @@
 [![Pypi-status](https://img.shields.io/pypi/status/stream-localhost)][pypi]
 
 # Video Streaming
-Video streaming using FastAPI
+Python module to, stream videos via authenticated sessions using FastAPI
 
 ## Install
 ```shell
diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt
index ff33761..e23c0cf 100644
--- a/docs/_sources/README.md.txt
+++ b/docs/_sources/README.md.txt
@@ -8,7 +8,7 @@
 [![Pypi-status](https://img.shields.io/pypi/status/stream-localhost)][pypi]
 
 # Video Streaming
-Video streaming using FastAPI
+Python module to, stream videos via authenticated sessions using FastAPI
 
 ## Install
 ```shell
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
index eb34c11..eae7180 100644
--- a/docs/_sources/index.rst.txt
+++ b/docs/_sources/index.rst.txt
@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Stream's documentation!
-==================================
+Stream-Localhost - A secured interface to stream videos
+=======================================================
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/index.html b/docs/index.html
index 61c39b0..baa1264 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Welcome to Stream’s documentation! &#8212; Stream  documentation</title>
+    <title>Stream-Localhost - A secured interface to stream videos &#8212; Stream  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
     
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
           <a href="README.html" title="Video Streaming"
              accesskey="N">next</a> |</li>
         <li class="nav-item nav-item-0"><a href="#">Stream  documentation</a> &#187;</li>
-        <li class="nav-item nav-item-this"><a href="">Welcome to Stream’s documentation!</a></li> 
+        <li class="nav-item nav-item-this"><a href="">Stream-Localhost - A secured interface to stream videos</a></li> 
       </ul>
     </div>  
 
@@ -42,8 +42,8 @@ <h3>Navigation</h3>
         <div class="bodywrapper">
           <div class="body" role="main">
             
-  <section id="welcome-to-stream-s-documentation">
-<h1>Welcome to Stream’s documentation!<a class="headerlink" href="#welcome-to-stream-s-documentation" title="Permalink to this heading">¶</a></h1>
+  <section id="stream-localhost-a-secured-interface-to-stream-videos">
+<h1>Stream-Localhost - A secured interface to stream videos<a class="headerlink" href="#stream-localhost-a-secured-interface-to-stream-videos" title="Permalink to this heading">¶</a></h1>
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Read Me:</span></p>
 <ul>
@@ -350,7 +350,7 @@ <h1>Models<a class="headerlink" href="#models" title="Permalink to this heading"
 
 <dl class="py function">
 <dt class="sig sig-object py" id="pystream.models.ngrok.run_tunnel">
-<span class="sig-prename descclassname"><span class="pre">pystream.models.ngrok.</span></span><span class="sig-name descname"><span class="pre">run_tunnel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Logger</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pystream.models.ngrok.run_tunnel" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">pystream.models.ngrok.</span></span><span class="sig-name descname"><span class="pre">run_tunnel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Logger</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pystream.models.ngrok.run_tunnel" title="Permalink to this definition">¶</a></dt>
 <dd><p>Runs reverse proxy on video port to expose it using a public URL.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -606,7 +606,7 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
   <div>
     <h3><a href="#">Table of Contents</a></h3>
     <ul>
-<li><a class="reference internal" href="#">Welcome to Stream’s documentation!</a></li>
+<li><a class="reference internal" href="#">Stream-Localhost - A secured interface to stream videos</a></li>
 <li><a class="reference internal" href="#module-pystream.main">Main Module</a></li>
 <li><a class="reference internal" href="#models">Models</a></li>
 <li><a class="reference internal" href="#module-pystream.models.authenticator">Authenticator</a></li>
@@ -662,7 +662,7 @@ <h3>Navigation</h3>
           <a href="README.html" title="Video Streaming"
              >next</a> |</li>
         <li class="nav-item nav-item-0"><a href="#">Stream  documentation</a> &#187;</li>
-        <li class="nav-item nav-item-this"><a href="">Welcome to Stream’s documentation!</a></li> 
+        <li class="nav-item nav-item-this"><a href="">Stream-Localhost - A secured interface to stream videos</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
diff --git a/docs/objects.inv b/docs/objects.inv
index f99e4d3bd78627d2e4951383dbd763d5160a7533..abbd7f1f21321ecde20830807274735a5232931a 100644
GIT binary patch
delta 644
zcmV-~0(<@M1@HxscYjmcFc60C`4yUJuhEn%w+s!_Ord2+;n0gmvDc0!j@D>bf&BZ*
zl7TSLA(C^mq<!A~(1*9%6I)PQxmDVTZhyYT%C#WA32iEPl55_!U*g>KtC&u@LwiZA
zEcaCHOvxIJI6LJ21GuhWMH@O6#0pxH%JCWu>rye=q)0#D<$n&WuJ>sXlxS+*WVnu?
zoSWUni$vKfqGNr&qViM<63niswa>y!DQ2rzj$xc!XQ9?lrxJW(tHx@X#^R=6+<+M?
z)%j{aqOHd2I09?bc68l$x&kcLNPHTl4(*AQ2%RlQ=l2LJ(mY-U?FKC6$z1yTvG|>S
z*&-){@fgpt)qlj{mS!ff1fu?JOU_^beF`;Zx@P4c+YHZvlNUeke*G+#i@)<R?&baL
z?&?pTf`8ExLBCNvoVCP1#6ZehM7|8)359zP4^tr!;5Amqi`@5DI6H&`IwOYgT4z)*
zaIyg|*ck(D+HXD5)|o7t9-Ow25p)DY)Rne{KXmNdlYboNK_f1Vl4-H&c>@tklL(`n
zGQ?4zf>ox0VhyT_$0pUgi~<%O91xTLpbiZ|mKK4jiq)Qhinp>ys#$d5M)YlGN?8uM
zen+&)aM*)>m`JV^>5_7SjbzxwTJ3a+Cd;)SVrtN#<;aOSfWvMVFDj{?hnB}5mJao2
z_wIH+`+a^r7sS<hg{7FDi8vE1M0h*JGC0wunKWQx1JT>JYUN)hPdv{?X3>96Ud;yC
z1B<9Py~0wpp;?@YnII^gh05FcOlswuHAXR9;gAqbeCa;$-tDK)3sL?$Rz1dXu=)vh
ev-f`l^Oh!1wp_mj<J^!*T)$BbO#T594NluLc0{rO

delta 643
zcmV-}0(|}O1@8rrcYki%Fc5|JK81>QYogg^7o-kiv}uF5Nr7$zS{liOWsbrbI`*#D
z==FM%Qly;NXo{GWcjC|Y-f&2c*lvjp$dy=0rL%T>zQWQrkbTUQE@2}UylUQuzVU}_
zJZksn3u0-wqbjQlR;aVHeeOSiZF82iq+>xWp&=nHFF>;@B!8ociu4s;tih;i8y7)=
zx>9w5bpXXguP>h^ibfJ0>-mC;Qz;10>%3BK6;4Vr8#T8K!{k~6mD-$2aKlCp)zY=W
zWzM(+Jyfc7*?vM(4%M*)M$6UUysuRWm@km{G)gU+6Dbi|Qw(0;6U<5Ra2Yg9Fq9^9
z<?hGyTl{4UoPY3>hd7Hy5&K)3xPTcDb+s*e1wH7NP+_7qOIK_YoINKlukXKp&S%q~
zlOguv;o|<w_cR4p(IP>&QQV)k$Uj6+iaSKU^4}4O`xoxJd?3IJERPp?=&o>b2zzuw
z48B??WY2S=2F}@P4Ncr{J<!JLB$^(rGLR5-0DaV@GJm-{bnKodDdt`y3=EQKu<m#b
z0gIFHt&}u`R<{Hrbq)CfWEqZ4th)#T1|BUCll!0+H9?XVfiCm;mVxp^*(22qT7M(D
zXJ<@W_PK6Hluj`0K-Y{U=aN)GDZvKPZ(=3asz9A&?V1=Hw10A>#O%R-xASL}Sm*x9
z;|@!U>U^zxcQ?8CbTi3_%kvV8Y<!l59zP@VwKJP}6Q%1>4LUp^y7`TqyUOH<U2kBf
z-RJ0KS}(gd;|DYay4NP}r2qW-O_`f#SFTRTF3@))m#0^(+U<BZ5VUSWii7Fi=o{GW
d)|G#KNE1j?EDpiY7noTXzm+wN{sKS`Njh_HI6nXY

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``
