CLI tool to allow submitters to upload to and download from the EBI S3 buckets.
Project description
hca-util
This tool is intended to allow HCA wranglers and contributors to upload and download data to/from the HCA S3 bucket.
https://github.com/ebi-ait/hca-util
Prerequisites
Users need to have
- Basic command-line knowledge
- Python3.x installed on their machine
- Credentials to access data in the S3 bucket (access and secret keys)
Install and configure
-
Get the tool from PyPi
$ pip install hca-util
-
Run the
hca-util
tool$ hca-util Type ? to list commands hca>
-
Run
config
command specifying your credentialshca> config ACCESS_KEY SECRET_KEY
Step 2 opens an interactive prompt.
Step 3 adds a new hca-util profile to your local AWS configuration which the tool uses.
Use the tool to upload and download data
The following commands are currently possible.
command description
======= ===========
config ACCESS_KEY SECRET_KEY Configure your machine with credentials
create [project_name] [-udx] Create an upload directory for project (authorised user only)
If specified, project name needs to be between 1-12 alphanumeric characters with no space
If specified, allowed permissions include 'u', 'ud', 'ux' and 'udx'; otherwise default 'ux'
u - upload, d - download, x - delete
list List contents of bucket (authorised user only)
list DIR_NAME List contents of directory
select DIR_NAME Set active directory for upload and download
dir Show selected directory
upload F1 [f2] [f3] ... Multi-files upload to selected directory
upload . Upload all files from current user directory
delete F1 [f2] [f3] ... Delete specified file(s) from selected directory
delete . Delete all files from selected directory
download F1 [f2] [f3] ... Download specified file(s) from selected directory to local machine
download . Download all files from selected directory to local machine
exit (or quit) Exit the tool. Shorthand: x, q, or Ctrl-D
Type ? or help
to list commands.
Type help <command>
to display help info about a command.
Note only authorised users (for e.g. wranglers, devs) with their elevated access can create directory and list all directories.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hca_util-0.0.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f42253c21c9bf119b083d6d7029a6af9f1843d11dc5c9fb16eeb68c65851655a |
|
MD5 | 11cc3405f941fde137b9db87d9a3f37b |
|
BLAKE2b-256 | 5461e90f34fa8911a0d966d64df498fd6f02a31da5248515f8a7caac6ef3c374 |