Release v1.0.0

Update README.md and release_notes.rst
thevickypedia · Feb 29, 2024 · 0d6cb30 · 0d6cb30
1 parent 1be4397
commit 0d6cb30
Show file tree

Hide file tree

Showing 9 changed files with 87 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -52,6 +52,21 @@ if __name__ == '__main__':
     wrapper.run()
 ```
 
+#### Mandatory arg
+- **bucket_name** - Name of the s3 bucket.
+
+#### Optional kwargs
+- **prefix** - Prefix to filter the objects based on their path. Defaults to `None`
+- **logger** - Bring your own custom pre-configured logger. Defaults to on-screen logging.
+- **download_dir** - Name/path of the directory where the objects have to be stored.
+Defaults to `bucket_name` at current working directory.
+<br><br>
+- **region_name** - AWS region name. Defaults to the env var `AWS_DEFAULT_REGION`
+- **profile_name** - AWS profile name. Defaults to the env var `PROFILE_NAME`
+- **aws_access_key_id** - AWS access key ID. Defaults to the env var `AWS_ACCESS_KEY_ID`
+- **aws_secret_access_key** - AWS secret access key. Defaults to the env var `AWS_SECRET_ACCESS_KEY`
+> AWS values are loaded from env vars or the default config at `~/.aws/config` / `~/.aws/credentials`
+
 ### Coding Standards
 Docstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) <br>
 Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>

diff --git a/docs/README.html b/docs/README.html
@@ -90,6 +90,29 @@ <h3>Download objects in sequence<a class="headerlink" href="#download-objects-in
 </pre></div>
 </div>
 </section>
+<section id="mandatory-arg">
+<h3>Mandatory arg<a class="headerlink" href="#mandatory-arg" title="Permalink to this heading">¶</a></h3>
+<ul class="simple">
+<li><p><strong>bucket_name</strong> - Name of the s3 bucket.</p></li>
+</ul>
+</section>
+<section id="optional-kwargs">
+<h3>Optional kwargs<a class="headerlink" href="#optional-kwargs" title="Permalink to this heading">¶</a></h3>
+<ul class="simple">
+<li><p><strong>prefix</strong> - Prefix to filter the objects based on their path. Defaults to <code class="docutils literal notranslate"><span class="pre">None</span></code></p></li>
+<li><p><strong>logger</strong> - Bring your own custom pre-configured logger. Defaults to on-screen logging.</p></li>
+<li><p><strong>download_dir</strong> - Name/path of the directory where the objects have to be stored.
+Defaults to <code class="docutils literal notranslate"><span class="pre">bucket_name</span></code> at current working directory.
+<br><br></p></li>
+<li><p><strong>region_name</strong> - AWS region name. Defaults to the env var <code class="docutils literal notranslate"><span class="pre">AWS_DEFAULT_REGION</span></code></p></li>
+<li><p><strong>profile_name</strong> - AWS profile name. Defaults to the env var <code class="docutils literal notranslate"><span class="pre">PROFILE_NAME</span></code></p></li>
+<li><p><strong>aws_access_key_id</strong> - AWS access key ID. Defaults to the env var <code class="docutils literal notranslate"><span class="pre">AWS_ACCESS_KEY_ID</span></code></p></li>
+<li><p><strong>aws_secret_access_key</strong> - AWS secret access key. Defaults to the env var <code class="docutils literal notranslate"><span class="pre">AWS_SECRET_ACCESS_KEY</span></code></p></li>
+</ul>
+<blockquote>
+<div><p>AWS values are loaded from env vars or the default config at <code class="docutils literal notranslate"><span class="pre">~/.aws/config</span></code> / <code class="docutils literal notranslate"><span class="pre">~/.aws/credentials</span></code></p>
+</div></blockquote>
+</section>
 </section>
 <section id="coding-standards">
 <h2>Coding Standards<a class="headerlink" href="#coding-standards" title="Permalink to this heading">¶</a></h2>
@@ -149,6 +172,8 @@ <h3><a href="index.html">Table of Contents</a></h3>
 <li><a class="reference internal" href="#usage">Usage</a><ul>
 <li><a class="reference internal" href="#download-objects-in-parallel">Download objects in parallel</a></li>
 <li><a class="reference internal" href="#download-objects-in-sequence">Download objects in sequence</a></li>
+<li><a class="reference internal" href="#mandatory-arg">Mandatory arg</a></li>
+<li><a class="reference internal" href="#optional-kwargs">Optional kwargs</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#coding-standards">Coding Standards</a></li>

diff --git a/docs/README.md b/docs/README.md
@@ -52,6 +52,21 @@ if __name__ == '__main__':
     wrapper.run()
 ```
 
+#### Mandatory arg
+- **bucket_name** - Name of the s3 bucket.
+
+#### Optional kwargs
+- **prefix** - Prefix to filter the objects based on their path. Defaults to `None`
+- **logger** - Bring your own custom pre-configured logger. Defaults to on-screen logging.
+- **download_dir** - Name/path of the directory where the objects have to be stored.
+Defaults to `bucket_name` at current working directory.
+<br><br>
+- **region_name** - AWS region name. Defaults to the env var `AWS_DEFAULT_REGION`
+- **profile_name** - AWS profile name. Defaults to the env var `PROFILE_NAME`
+- **aws_access_key_id** - AWS access key ID. Defaults to the env var `AWS_ACCESS_KEY_ID`
+- **aws_secret_access_key** - AWS secret access key. Defaults to the env var `AWS_SECRET_ACCESS_KEY`
+> AWS values are loaded from env vars or the default config at `~/.aws/config` / `~/.aws/credentials`
+
 ### Coding Standards
 Docstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) <br>
 Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>

diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt
@@ -52,6 +52,21 @@ if __name__ == '__main__':
     wrapper.run()
 ```
 
+#### Mandatory arg
+- **bucket_name** - Name of the s3 bucket.
+
+#### Optional kwargs
+- **prefix** - Prefix to filter the objects based on their path. Defaults to `None`
+- **logger** - Bring your own custom pre-configured logger. Defaults to on-screen logging.
+- **download_dir** - Name/path of the directory where the objects have to be stored.
+Defaults to `bucket_name` at current working directory.
+<br><br>
+- **region_name** - AWS region name. Defaults to the env var `AWS_DEFAULT_REGION`
+- **profile_name** - AWS profile name. Defaults to the env var `PROFILE_NAME`
+- **aws_access_key_id** - AWS access key ID. Defaults to the env var `AWS_ACCESS_KEY_ID`
+- **aws_secret_access_key** - AWS secret access key. Defaults to the env var `AWS_SECRET_ACCESS_KEY`
+> AWS values are loaded from env vars or the default config at `~/.aws/config` / `~/.aws/credentials`
+
 ### Coding Standards
 Docstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) <br>
 Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -12,10 +12,10 @@ Welcome to S3 Downloader's documentation!
 
    README
 
---------S3 Downloader--------
-=============================
-Dumper
-======
+S3 Downloader
+=============
+Main Module
+===========
 .. automodule:: s3.dumper
    :members:
    :undoc-members:
@@ -28,7 +28,7 @@ Exceptions
 
 Logger
 ======
-.. autoclass:: s3.logger
+.. automodule:: s3.logger
    :members:
    :undoc-members:
 

diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -68,6 +68,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="index.html#module-s3.exceptions"><code class="xref">s3.exceptions</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="index.html#module-s3.logger"><code class="xref">s3.logger</code></a></td><td>
+       <em></em></td></tr>
    </table>
 
 

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/release_notes.rst b/release_notes.rst
@@ -1,6 +1,11 @@
 Release Notes
 =============
 
+v1.0.0 (02/28/2024)
+-------------------
+- Includes a feature to filter objects using `prefix`
+- Minor stability and performance improvements
+
 v0.9.1 (10/04/2023)
 -------------------
 - Handle errors caused by threads and missing filenames

diff --git a/s3/__init__.py b/s3/__init__.py
@@ -1,3 +1,3 @@
 from s3.dumper import Downloader  # noqa: F401
 
-version = "0.9.1"
+version = "1.0.0"