Skip to main content

US3 helps you to manage files on AWS S3 or S3 compatible API like Ceph or Cleversafe

Project description

 _   _ ___|___ /
| | | / __| |_ \
| |_| \__ \___) |

us3 helps you to manage files on AWS S3 or S3 compatible API like Ceph or Cleversafe. Usefull with Continuous Integreation pipelines :)


pip install us3

For Docker check bottom


us3 (upload|download) [options] -s <src>
us3 delete [options] -s <src>


-h --help                                   Show this screen.
--version                                   Show version.
-a <access> --access=<access>               Access key.
-x <secret> --secret=<secret>               Secret key.
-e <endpoint> --endpoint=<endpoint>         Host to connect to. Default
                                            is You can check all AWS host/region on
-i <is_secure> --is_secure=<is_secure>      Use secure connection (https)
                                            or not (http). Default is True.
-k <clg> --calling_format=<clg>             Choose how to call the S3 API.
                                            - SubdomainCallingFormat (default)
                                            - VHostCallingFormat
                                            - OrdinaryCallingFormat
                                            - ProtocolIndependentOrdinaryCallingFormat.
-b <bucket> --bucket=<bucket>               Bucket name.
-s <src> --source=<src>                     File to download/upload.
-d <dest> --destination=<dest>               Destination folder path.
-c <config.yml> --config=<config.yml>       Config file path.

Thoses values are overrided by environment variables.

Config file

You could use a config file in YAML format to reduce options in CLI.

By default, us3 will look at /etc/default/us3.yaml or to the custom path with --config <pathtoconf>.

Thoses values are overrided by the CLI and environment variables.


$ cat /etc/default/us3.yaml
host:  mycustomhost
access: myaccesskey
secret: mysecurekey
calling_format: OrdinaryCallingFormat
is_secure: False

Environment variables

Environment variables had priority on config values and CLI values. To export a value, prepend variable name uppered with US3_.


export US3_HOST= myexporthost
export US3_ACCESS=myaccesskey
export US3_SECRET=mysecurekey


Image size ~70MB

docker pull ahmet2mir/us3

And use environment variables. By default, files are stored in /data

docker run --rm \
    -e "" \
    -e 'US3_BUCKET=xxxx' \
    -e 'US3_ACCESS=yyyy' \
    -e 'US3_SECRET=zzzz+' \
    -v /tmp/docker:/data \
    ahmet2mir/us3 download -s myfile


Copyright 2016 - Ahmet Demir

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

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

us3-0.0.7.tar.gz (5.8 kB view hashes)

Uploaded source

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