Metadata-Version: 2.1
Name: hca-util
Version: 0.0.8
Summary: CLI tool to allow submitters to upload to and download from the EBI S3 buckets.
Home-page: https://github.com/ebi-ait/hca-util
Author: hca-ingest-dev
Author-email: prabhat@ebi.ac.uk
License: Apache License
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
        1. Basic command-line knowledge
        2. Python3.x installed on their machine
        3. Credentials to access data in the S3 bucket (access and secret keys)
        
        ## Install and configure
        1. Get the tool from PyPi
        
                $ pip install hca-util
        
        2. Run the `hca-util` tool
        
                $ hca-util
                Type ? to list commands
                hca>
        
        3. Run `config` command specifying your credentials
        
                hca> 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)
                                            Project name is optional
                                            If specified, needs to be between 1-12 alphanumeric characters with no space
            list                            List contents of bucket (authorised user only)
            list DIR_NAME                   List contents of directory
            select DIR_NAME                 Select 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
        
        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.
        
Platform: MacOS X
Platform: Posix
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
