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 @@
Python module to download all the objects in an S3 bucket.
+Python module to download objects in an S3 bucket.
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¶
+
License & copyright¶
© Vignesh Rao
@@ -128,7 +152,11 @@ Table of Contents
Coding Standards
+Release Notes
+Linting
+
License & copyright
diff --git a/docs/README.md b/docs/README.md
index 40909fb..9c57dbe 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -9,23 +9,23 @@
**Repo Stats**
-[![GitHub](https://img.shields.io/github/license/thevickypedia/s3-downloader)](https://github.com/thevickypedia/s3-downloader/blob/main/LICENSE)
-[![GitHub repo size](https://img.shields.io/github/repo-size/thevickypedia/s3-downloader)](https://api.github.com/repos/thevickypedia/s3-downloader)
-[![GitHub code size](https://img.shields.io/github/languages/code-size/thevickypedia/s3-downloader)](https://api.github.com/repos/thevickypedia/s3-downloader)
+[![GitHub](https://img.shields.io/github/license/thevickypedia/s3-downloader)][license]
+[![GitHub repo size](https://img.shields.io/github/repo-size/thevickypedia/s3-downloader)][repo]
+[![GitHub code size](https://img.shields.io/github/languages/code-size/thevickypedia/s3-downloader)][repo]
**Activity**
-[![GitHub Repo created](https://img.shields.io/date/1618966420)](https://api.github.com/repos/thevickypedia/s3-downloader)
-[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/thevickypedia/s3-downloader)](https://api.github.com/repos/thevickypedia/s3-downloader)
-[![GitHub last commit](https://img.shields.io/github/last-commit/thevickypedia/s3-downloader)](https://api.github.com/repos/thevickypedia/s3-downloader)
+[![GitHub Repo created](https://img.shields.io/date/1618966420)][repo]
+[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/thevickypedia/s3-downloader)][repo]
+[![GitHub last commit](https://img.shields.io/github/last-commit/thevickypedia/s3-downloader)][repo]
**Build Status**
-[![pypi-publish](https://github.com/thevickypedia/s3-downloader/actions/workflows/python-publish.yml/badge.svg)](https://github.com/thevickypedia/s3-downloader/actions/workflows/python-publish.yml)
-[![pages-build-deployment](https://github.com/thevickypedia/s3-downloader/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/thevickypedia/s3-downloader/actions/workflows/pages/pages-build-deployment)
+[![pypi-publish][gha-pypi-badge]][gha-pypi]
+[![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
@@ -58,13 +58,49 @@ Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/)
Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and
[`isort`](https://pycqa.github.io/isort/)
+## [Release Notes][release-notes]
+**Requirement**
+```shell
+python -m pip install gitverse
+```
+
+**Usage**
+```shell
+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**
+```shell
+pip install sphinx==5.1.1 pre-commit recommonmark
+```
+
+**Usage**
+```shell
+pre-commit run --all-files
+```
+
### Pypi Package
-[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)](https://packaging.python.org/tutorials/packaging-projects/)
+[![pypi-module][pypi-logo]][pypi-tutorials]
-[https://pypi.org/project/s3-downloader/](https://pypi.org/project/s3-downloader/)
+[https://pypi.org/project/s3-downloader/][pypi]
## License & copyright
© Vignesh Rao
-Licensed under the [MIT License](https://github.com/thevickypedia/s3-downloader/blob/main/LICENSE)
+Licensed under the [MIT License][license]
+
+[license]: https://github.com/thevickypedia/s3-downloader/blob/main/LICENSE
+[release-notes]: https://github.com/thevickypedia/s3-downloader/blob/main/release_notes.rst
+[pypi]: https://pypi.org/project/s3-downloader/
+[pypi-tutorials]: https://packaging.python.org/tutorials/packaging-projects/
+[pypi-logo]: https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg
+[repo]: https://api.github.com/repos/thevickypedia/s3-downloader
+[gha-pages-badge]: https://github.com/thevickypedia/s3-downloader/actions/workflows/pages/pages-build-deployment/badge.svg
+[gha-pypi-badge]: https://github.com/thevickypedia/s3-downloader/actions/workflows/python-publish.yml/badge.svg
+[gha-pages]: https://github.com/thevickypedia/s3-downloader/actions/workflows/pages/pages-build-deployment
+[gha-pypi]: https://github.com/thevickypedia/s3-downloader/actions/workflows/python-publish.yml
diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt
index 40909fb..9c57dbe 100644
--- a/docs/_sources/README.md.txt
+++ b/docs/_sources/README.md.txt
@@ -9,23 +9,23 @@
**Repo Stats**
-[![GitHub](https://img.shields.io/github/license/thevickypedia/s3-downloader)](https://github.com/thevickypedia/s3-downloader/blob/main/LICENSE)
-[![GitHub repo size](https://img.shields.io/github/repo-size/thevickypedia/s3-downloader)](https://api.github.com/repos/thevickypedia/s3-downloader)
-[![GitHub code size](https://img.shields.io/github/languages/code-size/thevickypedia/s3-downloader)](https://api.github.com/repos/thevickypedia/s3-downloader)
+[![GitHub](https://img.shields.io/github/license/thevickypedia/s3-downloader)][license]
+[![GitHub repo size](https://img.shields.io/github/repo-size/thevickypedia/s3-downloader)][repo]
+[![GitHub code size](https://img.shields.io/github/languages/code-size/thevickypedia/s3-downloader)][repo]
**Activity**
-[![GitHub Repo created](https://img.shields.io/date/1618966420)](https://api.github.com/repos/thevickypedia/s3-downloader)
-[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/thevickypedia/s3-downloader)](https://api.github.com/repos/thevickypedia/s3-downloader)
-[![GitHub last commit](https://img.shields.io/github/last-commit/thevickypedia/s3-downloader)](https://api.github.com/repos/thevickypedia/s3-downloader)
+[![GitHub Repo created](https://img.shields.io/date/1618966420)][repo]
+[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/thevickypedia/s3-downloader)][repo]
+[![GitHub last commit](https://img.shields.io/github/last-commit/thevickypedia/s3-downloader)][repo]
**Build Status**
-[![pypi-publish](https://github.com/thevickypedia/s3-downloader/actions/workflows/python-publish.yml/badge.svg)](https://github.com/thevickypedia/s3-downloader/actions/workflows/python-publish.yml)
-[![pages-build-deployment](https://github.com/thevickypedia/s3-downloader/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/thevickypedia/s3-downloader/actions/workflows/pages/pages-build-deployment)
+[![pypi-publish][gha-pypi-badge]][gha-pypi]
+[![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
@@ -58,13 +58,49 @@ Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/)
Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and
[`isort`](https://pycqa.github.io/isort/)
+## [Release Notes][release-notes]
+**Requirement**
+```shell
+python -m pip install gitverse
+```
+
+**Usage**
+```shell
+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**
+```shell
+pip install sphinx==5.1.1 pre-commit recommonmark
+```
+
+**Usage**
+```shell
+pre-commit run --all-files
+```
+
### Pypi Package
-[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)](https://packaging.python.org/tutorials/packaging-projects/)
+[![pypi-module][pypi-logo]][pypi-tutorials]
-[https://pypi.org/project/s3-downloader/](https://pypi.org/project/s3-downloader/)
+[https://pypi.org/project/s3-downloader/][pypi]
## License & copyright
© Vignesh Rao
-Licensed under the [MIT License](https://github.com/thevickypedia/s3-downloader/blob/main/LICENSE)
+Licensed under the [MIT License][license]
+
+[license]: https://github.com/thevickypedia/s3-downloader/blob/main/LICENSE
+[release-notes]: https://github.com/thevickypedia/s3-downloader/blob/main/release_notes.rst
+[pypi]: https://pypi.org/project/s3-downloader/
+[pypi-tutorials]: https://packaging.python.org/tutorials/packaging-projects/
+[pypi-logo]: https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg
+[repo]: https://api.github.com/repos/thevickypedia/s3-downloader
+[gha-pages-badge]: https://github.com/thevickypedia/s3-downloader/actions/workflows/pages/pages-build-deployment/badge.svg
+[gha-pypi-badge]: https://github.com/thevickypedia/s3-downloader/actions/workflows/python-publish.yml/badge.svg
+[gha-pages]: https://github.com/thevickypedia/s3-downloader/actions/workflows/pages/pages-build-deployment
+[gha-pypi]: https://github.com/thevickypedia/s3-downloader/actions/workflows/python-publish.yml
diff --git a/docs/genindex.html b/docs/genindex.html
index 4392cf5..b611dbf 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -42,33 +42,20 @@ Navigation
Index
-_
-
-
-
-
-
B
@@ -88,7 +75,17 @@ C
D
+
@@ -104,7 +101,7 @@ E
F
@@ -113,6 +110,10 @@ G
+
@@ -124,15 +125,7 @@ I
- - InvalidDelimiter
-
-
-
-
-L
-
-
@@ -147,11 +140,21 @@ M
s3.dumper
s3.exceptions
+
+ s3.logger
+N
+
+
+ - NoObjectFound
+
+
+
+
P