Skip to main content

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.

Metadata

Release files for sucket 0.3.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sucket 0.3.4
File Size Uploaded
sucket-0.3.4.tar.gz 4.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sucket 0.3.4
File Interpreter ABI Platform
sucket-0.3.4-py3-none-any.whl Python 3 none any Details

Total release size: 9.4 kB

Release files / sucket-0.3.4.tar.gz

Download URL sucket-0.3.4.tar.gz
Size 4.3 kB
Tags Source
SHA-256 checksum
How to use checksums
14d4e5e47059ccfe3c83376ce498e09c0b7c29537ca94a31012d6102b2da087d
BLAKE2b-256 checksum
How to use checksums
ee5e3cd9653bcb15c636f63ed2f62b19cd8afc0880b21cf44de10ae30ab9ac9a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.2 CPython/3.8.1 Darwin/18.7.0

Release files / sucket-0.3.4-py3-none-any.whl

Download URL sucket-0.3.4-py3-none-any.whl
Size 5.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b7e3a78d42fb21a2aee8867efc6827394e4a61df9759c161a7c36189f451a0e6
BLAKE2b-256 checksum
How to use checksums
f246f8c84f2f2c80d7442501c8ddd3aae845c981fc10fd70e3d4f4ed9df8c242
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.2 CPython/3.8.1 Darwin/18.7.0

Release history Release notifications | RSS feed

This release

0.3.4 This release

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page