covid-util
CLI tool for uploading and downloading files from the EMBL-EBI hosted Embassy cloud infrastructure
PyPi: https://pypi.org/project/covid-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 covid-util from PyPi.
$ pip install covid-util
Usage
Display help
$ covid-util -h
usage: covid-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:
$ covid-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:
$ covid-util <command> -h
Some commands or options/flags are restricted to authorised users (for e.g. wranglers, admin) only.
config command
Configure AWS credentials
$ covid-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 _covid-util_embassy, 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 covid-util profile.
create command
Create an upload area (authorised users only)
$ covid-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
$ covid-util select AREA
positional arguments:
AREA area uuid. If not present then selected area is shown
list command
List contents of selected area
$ covid-util list [-b]
optional arguments:
-b list all areas in bucket **(authorised users only)**
upload command
Upload files to the selected area
$ covid-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
$ covid-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
$ covid-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)**
Metadata
Release files for covid-util 0.0.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| covid-util-0.0.8.tar.gz | 18.6 kB | Without provenance | Details for covid-util-0.0.8.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| covid_util-0.0.8-py3-none-any.whl | Python 3 | none | any | Details for covid_util-0.0.8-py3-none-any.whl |
Total release size: 42.8 kB
Release files / covid-util-0.0.8.tar.gz
| Download URL | covid-util-0.0.8.tar.gz |
|---|---|
| Size | 18.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
727710131140c2dcfbf5cd17c1886b58cbc80ad6cf744b373a05d4f3b6312f43
|
|
BLAKE2b-256 checksum How to use checksums |
c929b376f406e597689f1a0b7ad64f2f8734d10861d04bbf3f8fb05ef1d96bae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.5.0.1 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.9
|
Release files / covid_util-0.0.8-py3-none-any.whl
| Download URL | covid_util-0.0.8-py3-none-any.whl |
|---|---|
| Size | 24.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e906b137f8d1bb97c42931340f92ec155fc4ab4f2f7a891e59ace9f90d8417bf
|
|
BLAKE2b-256 checksum How to use checksums |
abb753330d0e648d00e069476b126d82071eef2a702f2d5ab614c853d50e770c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.5.0.1 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.9
|
Security for covid-util 0.0.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.