Skip to main content

A command line to assist McCloud users.

Project description

Intro

mccloud_cli is a command line interface to the McCloud service. McCloud provides a simple means to start a Shasta assembly in the cloud.

mccloud_cli currently provides an easy means to generate presigned URLs to use with the McCloud. Eventually it will also provide a means to submit jobs directly from the command line.

Quick start

  1. [optional] we highly suggest you run all python programs in a virtual environment.
  2. pip install mccloud-cli
  3. mccloud_cli --help

Presigned URLs example

mccloud_cli will generate AWS presigned URLs. This is useful when you want to store your data in your own AWS S3 bucket (ie, privately), but want to temporarily grant McCloud access to read input data, and write results back to your bucket.

Usage:

$ mccloud_cli generate-s3-presigned-url --help
Usage: mccloud_cli generate-s3-presigned-url [OPTIONS]

Options:
  --profile TEXT             Use a specific profile from your AWS credential file.
  --no-confirmation BOOLEAN  Perform requested actions without user confirmation.
  -i, --input-url TEXT       S3 URL which will be presigned to allow READ (input) access.
  -o, --output-url TEXT      S3 URL which will be presigned to allow WRITE (output) access.
  --expires-in INTEGER       Number of seconds until the pre-signed URLs expire.  [default: 28800]
  --help                     Show this message and exit.

For example:

$ mccloud_cli generate-s3-presigned-url --profile my-aws-profile -i s3://my-bucket/reads.fasta.gz -o s3://my-bucket/results.tar.gz

This action will generate AWS S3 presigned URLs for the input and output URLs you have specified, with an expiration time 28800 seconds [8 hours] from now.

Read (input) URLs:
------------------
s3://my-bucket/reads.fasta.gz

Write (output) URLs:
--------------------
s3://my-bucket/results.tar.gz
        
Do you wish to proceed? [y/N]: Y

Your presigned URLs will expire in 8 hours.

Please launch the McCloud job with these URLs.

Presigned INPUT URLs:
---------------------
https://s3.amazonaws.com/my-bucket/reads.fasta.gz?AWSAccessKeyId=...

Presigned OUTPUT URLs:
----------------------
https://s3.amazonaws.com/my-bucket/results.tar.gz?AWSAccessKeyId=...

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

mccloud_cli-0.0.2.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

mccloud_cli-0.0.2-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file mccloud_cli-0.0.2.tar.gz.

File metadata

  • Download URL: mccloud_cli-0.0.2.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for mccloud_cli-0.0.2.tar.gz
Algorithm Hash digest
SHA256 2b2cf935ec73009c0d99f57ed407a6771dfdbb5c3dcd446f6003dc0383b2358a
MD5 0da1f9c278842f68865d0368399aa78b
BLAKE2b-256 089937ec3d0d4b8b441e2bbc7ce3a79375ed49811a8173d0dce540e11d99f618

See more details on using hashes here.

Provenance

File details

Details for the file mccloud_cli-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: mccloud_cli-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for mccloud_cli-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 62334565c583901a1f9a1bd4ac4aacdf18d8447d5a2617c28cd0e8ab0da71a17
MD5 9c7290f263e363f3940d3a5f57c7818f
BLAKE2b-256 3ee91934c57c05be48394e4a8bb7b009fe299427bbe23e61a3463b8f92621ab3

See more details on using hashes here.

Provenance

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