Skip to content

Commit 33aa2f0

Browse files
committed
Check for app running on port before initiating tunneling
Flush screen output before carriage return Take optional args to terminate instance and delete security group Remove unnecessary args
1 parent 4033a0a commit 33aa2f0

10 files changed

+103
-43
lines changed

CHANGELOG

+7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
Change Log
22
==========
33

4+
0.4.1 (01/19/2022)
5+
------------------
6+
- Check for app running on port before initiating tunneling
7+
- Flush screen output before carriage return
8+
- Take optional args to terminate instance and delete security group
9+
- Remove unnecessary args
10+
411
0.4.0 (01/15/2022)
512
------------------
613
- Update python-publish.yml

docs/genindex.html

+4
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,10 @@ <h2 id="P">P</h2>
211211
<table style="width: 100%" class="indextable genindextable"><tr>
212212
<td style="width: 33%; vertical-align: top;"><ul>
213213
<li><a href="index.html#helpers.auxiliary.prefix">prefix() (in module helpers.auxiliary)</a>
214+
</li>
215+
</ul></td>
216+
<td style="width: 33%; vertical-align: top;"><ul>
217+
<li><a href="index.html#helpers.server.print_warning">print_warning() (in module helpers.server)</a>
214218
</li>
215219
</ul></td>
216220
</tr></table>

docs/index.html

+21-1
Original file line numberDiff line numberDiff line change
@@ -253,8 +253,17 @@ <h1>Welcome to Expose’s documentation!<a class="headerlink" href="#welcome-to-
253253

254254
<dl class="py method">
255255
<dt class="sig sig-object py" id="tunnel.Tunnel.stop">
256-
<span class="sig-name descname"><span class="pre">stop</span></span><span class="sig-paren">(</span><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="#tunnel.Tunnel.stop" title="Permalink to this definition"></a></dt>
256+
<span class="sig-name descname"><span class="pre">stop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">partial</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">security_group_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</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="#tunnel.Tunnel.stop" title="Permalink to this definition"></a></dt>
257257
<dd><p>Disables tunnelling by terminating the <code class="docutils literal notranslate"><span class="pre">EC2</span></code> instance, <code class="docutils literal notranslate"><span class="pre">KeyPair</span></code>, and the <code class="docutils literal notranslate"><span class="pre">SecurityGroup</span></code> created.</p>
258+
<dl class="field-list simple">
259+
<dt class="field-odd">Parameters</dt>
260+
<dd class="field-odd"><ul class="simple">
261+
<li><p><strong>partial</strong> – Flag to indicate whether the <code class="docutils literal notranslate"><span class="pre">SecurityGroup</span></code> has to be removed.</p></li>
262+
<li><p><strong>instance_id</strong> – Instance that has to be terminated.</p></li>
263+
<li><p><strong>security_group_id</strong> – Security group that has to be removed.</p></li>
264+
</ul>
265+
</dd>
266+
</dl>
258267
</dd></dl>
259268

260269
</dd></dl>
@@ -282,6 +291,17 @@ <h1>Welcome to Expose’s documentation!<a class="headerlink" href="#welcome-to-
282291
</dl>
283292
</dd></dl>
284293

294+
<dl class="py function">
295+
<dt class="sig sig-object py" id="helpers.server.print_warning">
296+
<span class="sig-prename descclassname"><span class="pre">helpers.server.</span></span><span class="sig-name descname"><span class="pre">print_warning</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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="#helpers.server.print_warning" title="Permalink to this definition"></a></dt>
297+
<dd><p>Prints a message on screen to run an app or api on the specific port.</p>
298+
<dl class="field-list simple">
299+
<dt class="field-odd">Parameters</dt>
300+
<dd class="field-odd"><p><strong>port</strong> – Port number.</p>
301+
</dd>
302+
</dl>
303+
</dd></dl>
304+
285305
<dl class="py class">
286306
<dt class="sig sig-object py" id="helpers.server.Server">
287307
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">helpers.server.</span></span><span class="sig-name descname"><span class="pre">Server</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hostname</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pem_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'ubuntu'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#helpers.server.Server" title="Permalink to this definition"></a></dt>

docs/objects.inv

11 Bytes
Binary file not shown.

docs/searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

expose/helpers/auxiliary.py

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ def sleeper(sleep_time: int) -> None:
1919
for i in range(sleep_time):
2020
sys.stdout.write(f'\rRemaining: {sleep_time - i:0{len(str(sleep_time))}}s')
2121
sleep(1)
22+
sys.stdout.flush()
2223
sys.stdout.write('\r')
2324

2425

0 commit comments

Comments
 (0)