https://github.com/immfly/s3resumable

This modules provides a helper class to download files from S3 using boto3. To be able to recover incomplete downloads, it downloads files in parts of the configured size.
https://github.com/immfly/s3resumable

amazon-s3 aws aws-s3 boto3 download download-manager downloader downloads python python2 python3 s3 s3-client

Last synced: about 1 month ago
JSON representation

This modules provides a helper class to download files from S3 using boto3. To be able to recover incomplete downloads, it downloads files in parts of the configured size.

• Host: GitHub
• URL: https://github.com/immfly/s3resumable
• Owner: immfly
• License: apache-2.0
• Created: 2020-03-09T15:29:02.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-06-02T01:13:56.000Z (over 3 years ago)
• Last Synced: 2024-10-01T19:17:21.301Z (about 1 month ago)
• Topics: amazon-s3, aws, aws-s3, boto3, download, download-manager, downloader, downloads, python, python2, python3, s3, s3-client
• Language: Python
• Homepage:
• Size: 69.3 KB
• Stars: 17
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/immfly/s3resumable.svg?branch=master)](https://travis-ci.org/immfly/s3resumable)

# S3Resumable

This modules provides a helper class to download files from S3 using boto3.

To be able to recover incomplete downloads, it downloads files in parts of

the configured size.

## Installation

Using `pip`:

```bash

pip install s3resumable

```

Using `docker-compose`:

```bash

docker-compose build

```

## Usage

The basic usage of s3resumable module can be summarized as declare a `boto3`

client and pass it on `S3Resumable` class:

 

```python

import boto3

from s3resumable import S3Resumable 

s3client = boto3.client('s3')

s3resumable = S3Resumable(s3client)

s3resumable.download_file('my_bucket', 'my_key', 'my_download_dir')

```

This will download the file in parts (15mb by default) and once downloaded

all the parts will join them in one file.

A CLI can also be used. Check the help:

```bash

s3resumable --help

```

## QA

In order to check QA, you can use docker-compose:

```bash

docker-compose build

docker-compose run py27 qa

docker-compose run py37 qa

```