Skip to main content

A tool to copy files between S3 buckets across AWS accounts

Project description

s3hop - Cross-account S3 bucket streaming copy

A command-line tool to efficiently copy files between S3 buckets across different AWS accounts.

Features

  • Copy files between S3 buckets across different AWS accounts
  • Smart file comparison to only copy new or updated files
  • Progress tracking with ETA and transfer speed
  • Detailed transfer summary with file type statistics
  • Handles large files and directories efficiently using streaming
  • Preserves file structure between source and destination

Installation

You can install this package directly from PyPI:

pip install s3hop

Or install from source:

git clone https://github.com/hamsti/s3hop.git
cd s3hop
pip install .

Prerequisites

  1. Python 3.6 or later
  2. AWS credentials configured for both source and destination accounts
  3. Appropriate S3 permissions in both accounts

AWS Credentials Setup

  1. Configure your AWS credentials for both accounts in ~/.aws/credentials:
[source-profile]
aws_access_key_id = YOUR_SOURCE_ACCESS_KEY
aws_secret_access_key = YOUR_SOURCE_SECRET_KEY

[dest-profile]
aws_access_key_id = YOUR_DEST_ACCESS_KEY
aws_secret_access_key = YOUR_DEST_SECRET_KEY
  1. Ensure you have the necessary S3 permissions:
    • Source bucket: s3:ListBucket, s3:GetObject
    • Destination bucket: s3:ListBucket, s3:PutObject

Usage

Basic usage:

s3hop source-profile s3://source-bucket/prefix/ dest-profile s3://dest-bucket/prefix/

Example with specific profiles and paths:

s3hop prod s3://prod-bucket/data/ staging s3://staging-bucket/backup/

Arguments

  • source-profile: AWS profile for the source account
  • source_url: Source S3 URL (s3://bucket-name/prefix/)
  • dest-profile: AWS profile for the destination account
  • dest_url: Destination S3 URL (s3://bucket-name/prefix/)

Features in Detail

  1. Smart File Comparison

    • Compares files using ETags and last modified timestamps
    • Only copies new or updated files
    • Preserves existing files that haven't changed
  2. Progress Tracking

    • Real-time transfer speed
    • Estimated time remaining
    • Progress bar with file counts
    • Total data transferred/remaining
  3. Transfer Summary

    • Start and end times
    • Duration
    • Number of files transferred/skipped
    • File type statistics
    • Failed transfers (if any)

License

MIT License

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

s3hop-0.1.0.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

s3hop-0.1.0-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file s3hop-0.1.0.tar.gz.

File metadata

  • Download URL: s3hop-0.1.0.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for s3hop-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9b93ee518b125c0c580f2ce024d75f7638f564cf8bfe7bc65d2bcf91fc1b689d
MD5 5784cee4331747b6c0b4b29e79414b72
BLAKE2b-256 8dcad94a7fe5b0bd7917e3d196f4a51b1a45c672ab21c5670ffb4da8f4bc9106

See more details on using hashes here.

File details

Details for the file s3hop-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: s3hop-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for s3hop-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 054ec4c37d9af7bb9ae65860da58cf3bb8382a8f9417396309013c619917108d
MD5 f4d8dbef8308ebb7e36f43f0623ce71f
BLAKE2b-256 1eb050dd76e422dffd7409628219bc77d40107ebc49f57414a9d1b4159d75729

See more details on using hashes here.

Supported by

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