s3sync-util 2.3.1

Sync directories/files with Amazon S3.

S3SyncUtility

S3SyncUtility is a Python tool using Boto3 to simplify syncing local directories with Amazon S3, for easy uploads and downloads.

Installation

You can install S3Sync using pip by providing the Git repository URL:

pip install git+https://github.com/GeonsV3Collab/S3SyncUtility.git@development

or

pip install s3sync_util

Configuration

Initialize the S3Sync configuration:

s3sync config init

This will interactively create a .config.ini file with your S3 bucket and prefix settings.

1. Modify `.config.ini`:

   You can manually edit the `.config.ini` file to change the configuration options.

Usage

Before using the utility, make sure you have the required dependencies installed.

1. To upload files/directories to S3:

   s3sync upload --directory <local_directory> --s3-bucket <bucket_name> --s3-prefix <prefix>
   

2. To download files/directories from S3:

   s3sync download --s3-bucket <bucket_name> --s3-prefix <prefix> --directory <local_directory>
   

Versioning Example

• Major version bump: v1.0.0 (Breaking backward compatibility)
• Minor version bump: v1.1.0 (Backward-compatible new features)
• Patch version bump: v1.1.1 (Backward-compatible bug fixes)
• Alpha release: v2.0.0-alpha (Initial development)
• Beta release: v2.0.0-beta (Feature-complete, testing phase)
• Dev version: v2.0.0-dev (Development version)
• Stable release: v2.0.0 (Production-ready)

License

This project is licensed under the MIT License.

MIT License

Copyright (c) 2023 Geons Logix and V3 Analytics - Collaboration

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.