Skip to main content

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

Project description

Versions Supported

Python

Language Stats

Language count Code coverage

Repo Stats

GitHub GitHub repo size GitHub code size LOC

Activity

GitHub Repo created GitHub commit activity GitHub last commit

Build Status

pypi-publish pages-build-deployment

S3 Download

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

Install from pypi

pip install s3-downloader

Usage

Using multi-threading
from s3.dumper import Downloader

if __name__ == '__main__':
    Downloader(bucket_name='MY_BUCKET_NAME').run_in_parallel()
Without using multi-threading
from s3.dumper import Downloader

if __name__ == '__main__':
    Downloader(bucket_name='MY_BUCKET_NAME').run()

Coding Standards

Docstring format: Google
Styling conventions: PEP 8
Clean code with pre-commit hooks: flake8 and isort

Linting

PreCommit will ensure linting, and the doc creation are run on every commit.

Requirement
pip install --no-cache --upgrade sphinx pre-commit recommonmark

Usage
pre-commit run --all-files

Pypi Package

pypi-module

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

Runbook

made-with-sphinx-doc

https://thevickypedia.github.io/s3-downloader/

License & copyright

© Vignesh Sivanandha Rao

Licensed under the MIT License

Change Log

0.0.5 (04/17/2022)

  • Add OOP section for easy usage
  • Update docs

0.0.4 (04/17/2022)

  • Implement multi-threading for performance

0.0.3 (04/17/2022)

  • Base script to download s3 objects

0.0.2 (04/17/2022)

  • Setup pypi package and sphinx docs
  • Add all requirements

0.0.1 (04/17/2022)

  • Initial commit

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

s3-downloader-0.0.5.tar.gz (5.1 kB view hashes)

Uploaded Source

Built Distribution

s3_downloader-0.0.5-py2.py3-none-any.whl (5.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page