Update project description

thevickypedia · Dec 4, 2023 · 855f1f5 · 855f1f5
1 parent 55cb9e3
commit 855f1f5
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 20 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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