Skip to main content

s3-parallel-put Parallel uploads to Amazon AWS S3

s3-parallel-put speeds the uploading of many small keys to Amazon AWS S3 by executing multiple PUTs in parallel.

Dependencies

Installation

python -m pip install s3-parallel-put

Usage

The program reads your credentials from the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.

s3-parallel-put --bucket=BUCKET --prefix=PREFIX SOURCE

Keys are computed by combining PREFIX with the path of the file, starting from SOURCE. Values are file contents.

Options:

  • -h, --help — show help message
S3 options:
  • --bucket=BUCKET — set bucket
  • --bucket_region=BUCKET_REGION — set bucket region if not in us-east-1 (default new bucket region)
  • --host=HOST — set AWS host name
  • --secure and --insecure control whether a secure connection is used
Source options:
  • --walk=MODE — set walk mode (filesystem or tar)
  • --exclude=PATTERN — exclude files matching PATTERN
  • --include=PATTERN — don't exclude files matching PATTERN
Put options:
  • --content-type=CONTENT-TYPE — sets the Content-Type header, set to "guess" to guess based on file name or "magic" to guess by filename and libmagic

  • --gzip — compresses common text files and sets the Content-Encoding header to gzip

  • --gzip-type=GZIP_TYPE — if --gzip is set, sets what content-type to gzip, defaults to a list of known text content types, "all" will gzip everything. Specify multiple times for multiple content types (eg.--gzip-type=guess --gzip-type="image/svg+xml") [default: "guess"]

  • --put=MODE — sets the heuristic used for deciding whether to upload a file or not. Valid modes are:

    • add set the key's content if the key is not already present.
    • stupid always set the key's content.
    • update set the key's content if the key is not already present and its content has changed (as determined by its ETag).
    • copy
      The default heuristic is update. If you know that the keys are not already present then stupid is fastest (it avoids an extra HEAD request for each key). If you know that some keys are already present and that they have the correct values, then add is faster than update (it avoids calculating the MD5 sum of the content on the client side).
  • --prefix=PREFIX — set key prefix

  • --resume=FILENAME — resume from log file

  • --grant=GRANT — A Canned ACL policy to be applied to each file uploaded. Choices: private, public-read, public-read-write, authenticated-read, bucket-owner-read, bucket-owner-full-control, log-delivery-write

  • --header=HEADER:VALUE — adds an arbitrary header to the S3 file. This option can be specified multiple times.

  • --encrypt-key — use server side encryption

Logging options:
  • --log-filename=FILENAME — set log filename
  • -q, --quiet — less output
  • -v, --verbose — more output to be printed, including progress of individual files
Debug and performance tuning options:
  • --dry-run — don't write to S3. Causes the program to print what it would do, but not to upload any files. It is strongly recommended that you test the program with this option before transferring any real data.
  • --limit=N — set maximum number of keys to put. Causes the program to upload no more than N files. Combined with --dry-run, this is also useful for testing.
  • --processes=N — sets the number of parallel upload processes

Architecture

  • A walker process generates (filename, key_name) pairs and inserts them in put_queue.
  • Multiple putter processes consume these pairs in parallel, uploading the files to S3 and sending file-by-file statistics to stat_queue.
  • A statter process consumes these file-by-file statistics and generates summary statistics.

Bugs

  • Limited error checking.

To Do

  • Automatically parallelize uploads of large files by splitting into chunks.

Related projects

Licence

The MIT License (MIT)

Copyright (c) 2011-2014 Tom Payne

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

vim: set spell spelllang=en textwidth=76:

Metadata

Release files for s3-parallel-put 0.8

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

Source distribution (sdist)

Source distribution for s3-parallel-put 0.8
File Size Uploaded Provenance Actions
s3-parallel-put-0.8.tar.gz 9.3 kB Without provenance Details for s3-parallel-put-0.8.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for s3-parallel-put 0.8
File Interpreter ABI Platform Actions
s3_parallel_put-0.8-py2-none-any.whl Python 2 none any Details for s3_parallel_put-0.8-py2-none-any.whl

Total release size: 19.9 kB

Release files / s3-parallel-put-0.8.tar.gz

Download URL s3-parallel-put-0.8.tar.gz
Size 9.3 kB
Tags Source
SHA-256 checksum
How to use checksums
954b57c98fc4578017d32e503ca696658948903f08cdc2367c29327e4972c8d8
BLAKE2b-256 checksum
How to use checksums
94122b22af4be3571025f52a3697d6cfc2d0733fcbe0afeded43c31dd58bb1fd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/2.7.15

Release files / s3_parallel_put-0.8-py2-none-any.whl

Download URL s3_parallel_put-0.8-py2-none-any.whl
Size 10.6 kB
Tags Python 2
SHA-256 checksum
How to use checksums
0b3471c1d0234bc571e231fd8ac3582d8efaf8610d9ff4e6a6db3ee0b3634846
BLAKE2b-256 checksum
How to use checksums
6e0387106a13b4794437fab6edbbdb7535e39cf755c0829f7b191338bb085ddf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/2.7.15

Security for s3-parallel-put 0.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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