Load/scan any .env file during startup

Log daemon services launched in the background
Change list to tuple wherever possible
Unhook version number dependency on release notes

Author: dormant-user

.gitignore

@@ -3,7 +3,7 @@ venv
 .idea
 
 # Env vars stored in a .env file
-.env
+*.env
 
 # File generated when an EC2 instance in spunup
 *.json

README.md

@@ -2,7 +2,7 @@
 Expose an app/api running on local host to public internet using AWS EC2
 
 ### Requirements
-- Access to an AWS account.
+- Access to an AWS account and [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html#getting-started-install-instructions) configured.
 - A `service/app/api` running on a specific port that has to be exposed to public internet.
 - **[Optional]** A domain `example.com` hosted on `route53`.
 
@@ -14,14 +14,17 @@ Environment variables can be loaded from a `.env` file.
 - `PORT`: Port number that has to be exposed (on which a localhost `service/app/api` is running)
 
 **Optional Args:**
-- `AMI_ID`: ID of any public AMI with an Ubuntu OS. Defaults to a region specific image ID.
-- `ACCESS_KEY`: Access key to access AWS resources. Defaults to `~/.aws/config`
-- `SECRET_KEY`: Secret key to access AWS resources. Defaults to `~/.aws/config`
-- `REGION_NAME`: Region name where the instance should live. Defaults to `US-WEST-2`
-- `DOMAIN`: If the domain name is registered using `route53`. *Example: `mywebsite.com`*
-- `SUBDOMAIN`: Sub-domain that has to be added for the domain name. *Example: `tunnel.mywebsite.com`*
-- `EMAIL`: Email address to create the self-signed SSL and private key. Defaults to `[email protected]`
-- `ORG`: Organization name for the certificate. Defaults to the AWS endpoint.
+- `IMAGE_ID`: ID of any public AMI with an Ubuntu OS. Defaults to a region specific image ID.
+- `AWS_ACCESS_KEY`: Access key to access AWS resources. Defaults to `~/.aws/config`
+- `AWS_SECRET_KEY`: Secret key to access AWS resources. Defaults to `~/.aws/config`
+- `AWS_REGION_NAME`: Region name where the instance should live. Defaults to `US-WEST-2`
+
+*Optionally `.env` files can also be scanned for:*
+```python
+import expose
+
+expose.load_env(scan=True)
+```
 
 <details>
 <summary><strong>Setup a custom endpoint</strong></summary>
@@ -58,8 +61,8 @@ To manually generate a self-signed cert:
 
 Simply let `expose` create a self-signed SSL certificate and a private key.
 
-- `EMAIL`: Email address to create the self-signed SSL and private key. Defaults to `[email protected]`
-- `ORG`: Organization name for the certificate. Defaults to the AWS endpoint.
+- `EMAIL_ADDRESS`: Email address to create the self-signed SSL and private key. Defaults to `[email protected]`
+- `ORGANIZATION`: Organization name for the certificate. Defaults to the AWS endpoint.
 
 </details>
 

docs/README.html

@@ -48,7 +48,7 @@ <h1>Expose localhost using EC2<a class="headerlink" href="#expose-localhost-usin
 <section id="requirements">
 <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
 <ul class="simple">
-<li><p>Access to an AWS account.</p></li>
+<li><p>Access to an AWS account and <a class="reference external" href="https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html#getting-started-install-instructions">AWS CLI</a> configured.</p></li>
 <li><p>A <code class="docutils literal notranslate"><span class="pre">service/app/api</span></code> running on a specific port that has to be exposed to public internet.</p></li>
 <li><p><strong>[Optional]</strong> A domain <code class="docutils literal notranslate"><span class="pre">example.com</span></code> hosted on <code class="docutils literal notranslate"><span class="pre">route53</span></code>.</p></li>
 </ul>
@@ -64,15 +64,17 @@ <h3>Environment Variables:<a class="headerlink" href="#environment-variables" ti
 </ul>
 <p><strong>Optional Args:</strong></p>
 <ul class="simple">
-<li><p><code class="docutils literal notranslate"><span class="pre">AMI_ID</span></code>: ID of any public AMI with an Ubuntu OS. Defaults to a region specific image ID.</p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">ACCESS_KEY</span></code>: Access key to access AWS resources. Defaults to <code class="docutils literal notranslate"><span class="pre">~/.aws/config</span></code></p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">SECRET_KEY</span></code>: Secret key to access AWS resources. Defaults to <code class="docutils literal notranslate"><span class="pre">~/.aws/config</span></code></p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">REGION_NAME</span></code>: Region name where the instance should live. Defaults to <code class="docutils literal notranslate"><span class="pre">US-WEST-2</span></code></p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">DOMAIN</span></code>: If the domain name is registered using <code class="docutils literal notranslate"><span class="pre">route53</span></code>. <em>Example: <code class="docutils literal notranslate"><span class="pre">mywebsite.com</span></code></em></p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">SUBDOMAIN</span></code>: Sub-domain that has to be added for the domain name. <em>Example: <code class="docutils literal notranslate"><span class="pre">tunnel.mywebsite.com</span></code></em></p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">EMAIL</span></code>: Email address to create the self-signed SSL and private key. Defaults to <code class="docutils literal notranslate"><span class="pre">USER&#64;expose-localhost.com</span></code></p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">ORG</span></code>: Organization name for the certificate. Defaults to the AWS endpoint.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">IMAGE_ID</span></code>: ID of any public AMI with an Ubuntu OS. Defaults to a region specific image ID.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">AWS_ACCESS_KEY</span></code>: Access key to access AWS resources. Defaults to <code class="docutils literal notranslate"><span class="pre">~/.aws/config</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">AWS_SECRET_KEY</span></code>: Secret key to access AWS resources. Defaults to <code class="docutils literal notranslate"><span class="pre">~/.aws/config</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">AWS_REGION_NAME</span></code>: Region name where the instance should live. Defaults to <code class="docutils literal notranslate"><span class="pre">US-WEST-2</span></code></p></li>
 </ul>
+<p><em>Optionally <code class="docutils literal notranslate"><span class="pre">.env</span></code> files can also be scanned for:</em></p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">expose</span>
+
+<span class="n">expose</span><span class="o">.</span><span class="n">load_env</span><span class="p">(</span><span class="n">scan</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+</pre></div>
+</div>
 <details>
 <summary><strong>Setup a custom endpoint</strong></summary><p>The public DNS names for EC2 instances are long and messy. To avoid that, an <code class="docutils literal notranslate"><span class="pre">A</span></code> record can be added to the <code class="docutils literal notranslate"><span class="pre">route53</span></code> hosted zone.</p>
 <p>:warning:   Requires an active hosted zone on <code class="docutils literal notranslate"><span class="pre">route53</span></code>.</p>
@@ -100,8 +102,8 @@ <h3>Certificate:<a class="headerlink" href="#certificate" title="Permalink to th
 <p>[OR]</p>
 <p>Simply let <code class="docutils literal notranslate"><span class="pre">expose</span></code> create a self-signed SSL certificate and a private key.</p>
 <ul class="simple">
-<li><p><code class="docutils literal notranslate"><span class="pre">EMAIL</span></code>: Email address to create the self-signed SSL and private key. Defaults to <code class="docutils literal notranslate"><span class="pre">USER&#64;expose-localhost.com</span></code></p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">ORG</span></code>: Organization name for the certificate. Defaults to the AWS endpoint.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">EMAIL_ADDRESS</span></code>: Email address to create the self-signed SSL and private key. Defaults to <code class="docutils literal notranslate"><span class="pre">USER&#64;expose-localhost.com</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">ORGANIZATION</span></code>: Organization name for the certificate. Defaults to the AWS endpoint.</p></li>
 </ul>
 </details></section>
 </section>

docs/_sources/README.md.txt

@@ -2,7 +2,7 @@
 Expose an app/api running on local host to public internet using AWS EC2
 
 ### Requirements
-- Access to an AWS account.
+- Access to an AWS account and [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html#getting-started-install-instructions) configured.
 - A `service/app/api` running on a specific port that has to be exposed to public internet.
 - **[Optional]** A domain `example.com` hosted on `route53`.
 
@@ -14,14 +14,17 @@ Environment variables can be loaded from a `.env` file.
 - `PORT`: Port number that has to be exposed (on which a localhost `service/app/api` is running)
 
 **Optional Args:**
-- `AMI_ID`: ID of any public AMI with an Ubuntu OS. Defaults to a region specific image ID.
-- `ACCESS_KEY`: Access key to access AWS resources. Defaults to `~/.aws/config`
-- `SECRET_KEY`: Secret key to access AWS resources. Defaults to `~/.aws/config`
-- `REGION_NAME`: Region name where the instance should live. Defaults to `US-WEST-2`
-- `DOMAIN`: If the domain name is registered using `route53`. *Example: `mywebsite.com`*
-- `SUBDOMAIN`: Sub-domain that has to be added for the domain name. *Example: `tunnel.mywebsite.com`*
-- `EMAIL`: Email address to create the self-signed SSL and private key. Defaults to `[email protected]`
-- `ORG`: Organization name for the certificate. Defaults to the AWS endpoint.
+- `IMAGE_ID`: ID of any public AMI with an Ubuntu OS. Defaults to a region specific image ID.
+- `AWS_ACCESS_KEY`: Access key to access AWS resources. Defaults to `~/.aws/config`
+- `AWS_SECRET_KEY`: Secret key to access AWS resources. Defaults to `~/.aws/config`
+- `AWS_REGION_NAME`: Region name where the instance should live. Defaults to `US-WEST-2`
+
+*Optionally `.env` files can also be scanned for:*
+```python
+import expose
+
+expose.load_env(scan=True)
+```
 
 <details>
 <summary><strong>Setup a custom endpoint</strong></summary>
@@ -58,8 +61,8 @@ To manually generate a self-signed cert:
 
 Simply let `expose` create a self-signed SSL certificate and a private key.
 
-- `EMAIL`: Email address to create the self-signed SSL and private key. Defaults to `[email protected]`
-- `ORG`: Organization name for the certificate. Defaults to the AWS endpoint.
+- `EMAIL_ADDRESS`: Email address to create the self-signed SSL and private key. Defaults to `[email protected]`
+- `ORGANIZATION`: Organization name for the certificate. Defaults to the AWS endpoint.
 
 </details>
 

docs/genindex.html

@@ -238,11 +238,15 @@ <h2 id="S">S</h2>
 </li>
       <li><a href="index.html#expose.helpers.server.Server.server_write">server_write() (expose.helpers.server.Server method)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#expose.main.Tunnel.start">start() (expose.main.Tunnel method)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#expose.main.Tunnel.stop">stop() (expose.main.Tunnel method)</a>
+</li>
+      <li><a href="index.html#expose.helpers.defaults.AWSDefaults.SUPPORTED_ACTIONS">SUPPORTED_ACTIONS (expose.helpers.defaults.AWSDefaults attribute)</a>
+</li>
+      <li><a href="index.html#expose.helpers.defaults.AWSDefaults.SUPPORTED_RECORDS">SUPPORTED_RECORDS (expose.helpers.defaults.AWSDefaults attribute)</a>
 </li>
   </ul></td>
 </tr></table>