Skip to main content

A tool to get all files from an S3 bucket

Project description

Sucket

A tool to download all objects from an S3 bucket. Supports filtering keys by a prefix.

Help

-> % sucket --help
Usage: sucket [OPTIONS] BUCKET_NAME [PREFIX]

  Download all files from a S3 bucket

  Everything from the bucket BUCKET_NAME is downloaded, with an optional key
  filter, specified with PREFIX

  By default the "folder" mode is used, which will keep the bucket "folder
  structure" when downloading.

  The "flat" mode will download all objects into the current folder by
  adding the folder structure into the key name.

  The "keys-only" will completely disregard the folders and put all files in
  the current folder.

Options:
  -m, --mode [folder|flat|keys-only]
                                  The structure to download the objects in.
  -y, --yes                       Don't prompt for continuing
  -q, --quiet                     Don't print out any info, assumes --yes
  -s, --semaphores INTEGER        Max number of asynchronous requests to make.
                                  Default: 1000
  --help                          Show this message and exit.

Examples

folder flat keys-only

Notes

This has only been tested on a fairly limited set of data, but has worked well for ~3500 small files. Need to tweak and experiment with larger files.

Special thanks

This is heavily based on a script that @steinnes wrote some time ago and has been very useful to me for a long time, the name was entirely his idea.

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

sucket-0.3.4.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

sucket-0.3.4-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file sucket-0.3.4.tar.gz.

File metadata

  • Download URL: sucket-0.3.4.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.2 CPython/3.8.1 Darwin/18.7.0

File hashes

Hashes for sucket-0.3.4.tar.gz
Algorithm Hash digest
SHA256 14d4e5e47059ccfe3c83376ce498e09c0b7c29537ca94a31012d6102b2da087d
MD5 24161bbfe99d30917ef5a4b32e561aac
BLAKE2b-256 ee5e3cd9653bcb15c636f63ed2f62b19cd8afc0880b21cf44de10ae30ab9ac9a

See more details on using hashes here.

File details

Details for the file sucket-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: sucket-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.2 CPython/3.8.1 Darwin/18.7.0

File hashes

Hashes for sucket-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b7e3a78d42fb21a2aee8867efc6827394e4a61df9759c161a7c36189f451a0e6
MD5 7aa748c387dd907537848cd0fe1b080b
BLAKE2b-256 f246f8c84f2f2c80d7442501c8ddd3aae845c981fc10fd70e3d4f4ed9df8c242

See more details on using hashes here.

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