From 1be439727b288f5718f589d8bbe8b68568e4a96d Mon Sep 17 00:00:00 2001 From: thevickypedia Date: Wed, 28 Feb 2024 22:59:47 -0600 Subject: [PATCH] Use `Prefix` key to filter objects at server side Update doc strings and doc generation process --- README.md | 2 +- docs/README.html | 32 ++++++- docs/README.md | 60 +++++++++--- docs/_sources/README.md.txt | 60 +++++++++--- docs/genindex.html | 64 +++++++------ docs/index.html | 176 +++++++++++++++++++++++++++--------- docs/objects.inv | Bin 507 -> 536 bytes docs/searchindex.js | 2 +- docs_gen/README.md | 70 -------------- docs_gen/conf.py | 3 +- docs_gen/index.rst | 10 +- pre_commit.sh | 11 ++- pyproject.toml | 2 +- s3/dumper.py | 115 +++++++++++++---------- s3/exceptions.py | 57 ++++++++++-- s3/logger.py | 47 ++++++++-- 16 files changed, 470 insertions(+), 241 deletions(-) delete mode 100644 docs_gen/README.md mode change 100644 => 100755 pre_commit.sh diff --git a/README.md b/README.md index d3aa107..9c57dbe 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ [![pages-build-deployment][gha-pages-badge]][gha-pages] # S3 Download -Python module to download all the objects in an S3 bucket. +Python module to download objects in an S3 bucket. ### Installation ```shell diff --git a/docs/README.html b/docs/README.html index feda349..8a9bcfe 100644 --- a/docs/README.html +++ b/docs/README.html @@ -61,7 +61,7 @@

Navigation

pages-build-deployment

S3 Download

-

Python module to download all the objects in an S3 bucket.

+

Python module to download objects in an S3 bucket.

Installation

pip install s3-downloader
@@ -98,11 +98,35 @@ 

Coding Standardsflake8 and isort

+
+

Release Notes

+

Requirement

+
python -m pip install gitverse
+
+
+

Usage

+
gitverse-release reverse -f release_notes.rst -t 'Release Notes'
+
+
+
+
+

Linting

+

pre-commit will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL +markdown files (including Wiki pages)

+

Requirement

+
pip install sphinx==5.1.1 pre-commit recommonmark
+
+
+

Usage

+
pre-commit run --all-files
+
+
-

Pypi Package

+

Pypi Package

pypi-module

https://pypi.org/project/s3-downloader/

+