CLI tool for file transfer (upload and download) to/from AWS S3.
Project description
hca-util
CLI tool for uploading and downloading files from an HCA upload area.
PyPi: https://pypi-hypernode.com/project/hca-util/
Users
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
Get hca-util from PyPi.
$ pip install hca-util
Usage
Display help
$ hca-util -h
usage: hca-util [-h] [--profile PROFILE]
{config,create,select,dir,clear,list,upload,download,delete}
In the above, optional arguments are between [] and choices between {}.
The basic usage is as follows:
$ hca-util cmd ARG1 ARG2 -o1 -o2
Use the tool by specifying a command (cmd - see list below) to run, any mandatory (positional) arguments (e.g. ARG1 and ARG2 - see positional args for each command), and any optional arguments (e.g. -o1 and o2 - see options for each command).
List of commands
help for a specific command:
$ hca-util <command> -h
Some commands or options/flags are restricted to authorised users (for e.g. wranglers, admin) only.
config command
Configure AWS credentials
$ hca-util config ACCESS_KEY SECRET_KEY
positional arguments:
ACCESS_KEY AWS Access Key ID
SECRET_KEY AWS Secret Access Key
By default, this tool looks for and uses the profile name hca-util, if it exists, or it can be set by the config command.
Running a command with the --profile argument uses the specified profile instead of the default hca-util profile.
create command
Create an upload area (authorised users only)
$ hca-util create NAME [-p {u,ud,ux,udx}]
positional arguments:
NAME name for the new area
optional arguments:
-n name optional project name for new area
-p {u,ud,ux,udx} allowed actions (permissions) on new area. u for
upload, x for delete and d for download. Default is ux
select command
Select or show the active upload area
$ hca-util select AREA
positional arguments:
AREA area uuid. If not present then selected area is shown
list command
List contents of selected area
$ hca-util list [-b]
optional arguments:
-b list all areas in bucket **(authorised users only)**
upload command
Upload files to the selected area
$ hca-util upload (-a | -f file [file ...]) [-o]
optional arguments:
-a upload all files from current user directory
-f file [file ...] upload specified file(s)
-o overwrite files with same names
download command
Download files from the selected area
$ hca-util download (-a | -f file [file ...])
optional arguments:
-a download all files from selected area
-f file [file ...] download specified file(s) only
delete command
Delete files from the selected area
$ hca-util delete (-a | -f file [file ...] | -d)
optional arguments:
-a delete all files from selected area
-f file [file ...] delete specified file(s) only
-d delete area and contents **(authorised users only)**
Developers
Run
python3 -m hca_util
Run tests
python3 -m tests.test_hca_util
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
File details
Details for the file hca-util-0.1.10.tar.gz.
File metadata
- Download URL: hca-util-0.1.10.tar.gz
- Upload date:
- Size: 14.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.20.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ccf50673f5aa740c5b1cafc3b540edf99a81cd44b33cebf6bcfa779b86e00149 |
|
| MD5 | 89b99e1b6b2933a40ff1af2346747d79 |
|
| BLAKE2b-256 | 751d659b0dee8c2fd0ce0d9a0d076b7ba5b5b9ed21ff17f719c38b6ad6ecd99c |
File details
Details for the file hca_util-0.1.10-py3-none-any.whl.
File metadata
- Download URL: hca_util-0.1.10-py3-none-any.whl
- Upload date:
- Size: 23.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.20.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0b06298a83eb0a752d17df73b87bd042f1929a0894819fa6119976e8306a3357 |
|
| MD5 | ec0aba593f90f1ad04ded761c112716a |
|
| BLAKE2b-256 | 8238cbbbe7d57ae71e1de6eec9b5b1c2f78d8be282c9f2240bc422d8ce9da09f |
