Skip to main content

Command line client to the CloudLaunch API.

Project description

===============
CloudLaunch CLI
===============


.. image:: https://img.shields.io/pypi/v/cloudlaunch_cli.svg
:target: https://pypi.python.org/pypi/cloudlaunch_cli

.. image:: https://readthedocs.org/projects/cloudlaunch-cli/badge/?version=latest
:target: https://cloudlaunch-cli.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://pyup.io/repos/github/CloudVE/cloudlaunch_cli/shield.svg
:target: https://pyup.io/repos/github/CloudVE/cloudlaunch_cli/
:alt: Updates


Command line client to the CloudLaunch API.


* Free software: MIT license
* Documentation: https://cloudlaunch-cli.readthedocs.io.


Quickstart
==========

1. Create a virtual environment and activate it
::

python3 -m venv venv
source venv/bin/activate

2. Install ``cloudlaunch-cli`` from GitHub
::

pip install git+https://github.com/CloudVE/cloudlaunch-cli.git#egg=cloudlaunch-cli

3. The CloudLaunch CLI requires two config settings. First is the URL of
the API root:
::

cloudlaunch config set url https://beta.launch.usegalaxy.org/cloudlaunch/api/v1

4. Second config setting is an auth token. To get an auth token, first
log into CloudLaunch, for example, by going to
https://beta.launch.usegalaxy.org/login. Then navigate to the
``/api/v1/auth/api-auth-token`` API endpoint, for example,
https://beta.launch.usegalaxy.org/cloudlaunch/api/v1/auth/api-token-auth/.
Copy the token out of the JSON response and then run the following
(substituting your own token instead):
::

cloudlaunch config set token b38faadf2ef6d59ce46711ed73e99d6...

5. Now you should be able to list your deployments
::

cloudlaunch deployments list

6. You can create a deployment as well
::

cloudlaunch deployments create my-ubuntu-test ubuntu \
amazon-us-east-n-virginia --application-version 16.04

Installing for development
==========================

1. ``python3 -m venv venv``
2. ``source venv/bin/activate``
3. ``python setup.py develop``

Now you can run ``cloudlaunch``.

Credits
---------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.1.0 (2018-01-09)
------------------

* First release on PyPI.


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

cloudlaunch_cli-0.1.0.tar.gz (20.8 kB view hashes)

Uploaded source

Built Distribution

cloudlaunch_cli-0.1.0-py3-none-any.whl (8.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page