Skip to content

Commit 855f1f5

Browse files
dormant-userdormant-user
committed
Update project description
1 parent 55cb9e3 commit 855f1f5

File tree

10 files changed

+26
-20
lines changed

10 files changed

+26
-20
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![Pypi-status](https://img.shields.io/pypi/status/stream-localhost)][pypi]
99

1010
# Video Streaming
11-
Video streaming using FastAPI
11+
Python module to, stream videos via authenticated sessions using FastAPI
1212

1313
## Install
1414
```shell

‎doc_gen/index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Welcome to Stream's documentation!
7-
==================================
6+
Stream-Localhost - A secured interface to stream videos
7+
=======================================================
88

99
.. toctree::
1010
:maxdepth: 2

‎docs/README.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
<link rel="index" title="Index" href="genindex.html" />
2020
<link rel="search" title="Search" href="search.html" />
21-
<link rel="prev" title="Welcome to Stream’s documentation!" href="index.html" />
21+
<link rel="prev" title="Stream-Localhost - A secured interface to stream videos" href="index.html" />
2222
</head><body>
2323
<div class="related" role="navigation" aria-label="related navigation">
2424
<h3>Navigation</h3>
@@ -30,7 +30,7 @@ <h3>Navigation</h3>
3030
<a href="py-modindex.html" title="Python Module Index"
3131
>modules</a> |</li>
3232
<li class="right" >
33-
<a href="index.html" title="Welcome to Stream’s documentation!"
33+
<a href="index.html" title="Stream-Localhost - A secured interface to stream videos"
3434
accesskey="P">previous</a> |</li>
3535
<li class="nav-item nav-item-0"><a href="index.html">Stream documentation</a> &#187;</li>
3636
<li class="nav-item nav-item-this"><a href="">Video Streaming</a></li>
@@ -50,7 +50,7 @@ <h3>Navigation</h3>
5050
<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>
5151
<section id="video-streaming">
5252
<h1>Video Streaming<a class="headerlink" href="#video-streaming" title="Permalink to this heading"></a></h1>
53-
<p>Video streaming using FastAPI</p>
53+
<p>Python module to, stream videos via authenticated sessions using FastAPI</p>
5454
<section id="install">
5555
<h2>Install<a class="headerlink" href="#install" title="Permalink to this heading"></a></h2>
5656
<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>
161161
<div>
162162
<h4>Previous topic</h4>
163163
<p class="topless"><a href="index.html"
164-
title="previous chapter">Welcome to Stream’s documentation!</a></p>
164+
title="previous chapter">Stream-Localhost - A secured interface to stream videos</a></p>
165165
</div>
166166
<div role="note" aria-label="source link">
167167
<h3>This Page</h3>
@@ -194,7 +194,7 @@ <h3>Navigation</h3>
194194
<a href="py-modindex.html" title="Python Module Index"
195195
>modules</a> |</li>
196196
<li class="right" >
197-
<a href="index.html" title="Welcome to Stream’s documentation!"
197+
<a href="index.html" title="Stream-Localhost - A secured interface to stream videos"
198198
>previous</a> |</li>
199199
<li class="nav-item nav-item-0"><a href="index.html">Stream documentation</a> &#187;</li>
200200
<li class="nav-item nav-item-this"><a href="">Video Streaming</a></li>

‎docs/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![Pypi-status](https://img.shields.io/pypi/status/stream-localhost)][pypi]
99

1010
# Video Streaming
11-
Video streaming using FastAPI
11+
Python module to, stream videos via authenticated sessions using FastAPI
1212

1313
## Install
1414
```shell

‎docs/_sources/README.md.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![Pypi-status](https://img.shields.io/pypi/status/stream-localhost)][pypi]
99

1010
# Video Streaming
11-
Video streaming using FastAPI
11+
Python module to, stream videos via authenticated sessions using FastAPI
1212

1313
## Install
1414
```shell

‎docs/_sources/index.rst.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Welcome to Stream's documentation!
7-
==================================
6+
Stream-Localhost - A secured interface to stream videos
7+
=======================================================
88

99
.. toctree::
1010
:maxdepth: 2

‎docs/index.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
88

9-
<title>Welcome to Stream’s documentation! &#8212; Stream documentation</title>
9+
<title>Stream-Localhost - A secured interface to stream videos &#8212; Stream documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
1212

@@ -33,7 +33,7 @@ <h3>Navigation</h3>
3333
<a href="README.html" title="Video Streaming"
3434
accesskey="N">next</a> |</li>
3535
<li class="nav-item nav-item-0"><a href="#">Stream documentation</a> &#187;</li>
36-
<li class="nav-item nav-item-this"><a href="">Welcome to Stream’s documentation!</a></li>
36+
<li class="nav-item nav-item-this"><a href="">Stream-Localhost - A secured interface to stream videos</a></li>
3737
</ul>
3838
</div>
3939

@@ -42,8 +42,8 @@ <h3>Navigation</h3>
4242
<div class="bodywrapper">
4343
<div class="body" role="main">
4444

45-
<section id="welcome-to-stream-s-documentation">
46-
<h1>Welcome to Stream’s documentation!<a class="headerlink" href="#welcome-to-stream-s-documentation" title="Permalink to this heading"></a></h1>
45+
<section id="stream-localhost-a-secured-interface-to-stream-videos">
46+
<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>
4747
<div class="toctree-wrapper compound">
4848
<p class="caption" role="heading"><span class="caption-text">Read Me:</span></p>
4949
<ul>
@@ -350,7 +350,7 @@ <h1>Models<a class="headerlink" href="#models" title="Permalink to this heading"
350350

351351
<dl class="py function">
352352
<dt class="sig sig-object py" id="pystream.models.ngrok.run_tunnel">
353-
<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>
353+
<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>
354354
<dd><p>Runs reverse proxy on video port to expose it using a public URL.</p>
355355
<dl class="field-list simple">
356356
<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
606606
<div>
607607
<h3><a href="#">Table of Contents</a></h3>
608608
<ul>
609-
<li><a class="reference internal" href="#">Welcome to Stream’s documentation!</a></li>
609+
<li><a class="reference internal" href="#">Stream-Localhost - A secured interface to stream videos</a></li>
610610
<li><a class="reference internal" href="#module-pystream.main">Main Module</a></li>
611611
<li><a class="reference internal" href="#models">Models</a></li>
612612
<li><a class="reference internal" href="#module-pystream.models.authenticator">Authenticator</a></li>
@@ -662,7 +662,7 @@ <h3>Navigation</h3>
662662
<a href="README.html" title="Video Streaming"
663663
>next</a> |</li>
664664
<li class="nav-item nav-item-0"><a href="#">Stream documentation</a> &#187;</li>
665-
<li class="nav-item nav-item-this"><a href="">Welcome to Stream’s documentation!</a></li>
665+
<li class="nav-item nav-item-this"><a href="">Stream-Localhost - A secured interface to stream videos</a></li>
666666
</ul>
667667
</div>
668668
<div class="footer" role="contentinfo">

‎docs/objects.inv‎

1 Byte
Binary file not shown.

0 commit comments

Comments
 (0)