Command line client to the CloudLaunch API.
Project description
===============
CloudLaunch CLI
===============
.. image:: https://travis-ci.org/CloudVE/cloudlaunch-cli.svg?branch=master
:target: https://travis-ci.org/CloudVE/cloudlaunch-cli
.. image:: https://coveralls.io/repos/github/CloudVE/cloudlaunch-cli/badge.svg?branch=master
:target: https://coveralls.io/github/CloudVE/cloudlaunch-cli?branch=master
.. image:: https://img.shields.io/pypi/v/cloudlaunch_cli.svg
:target: https://pypi-hypernode.com/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`` with pip
::
pip install cloudlaunch-cli
3. The CloudLaunch CLI requires two config settings. First is the URL of
the API root:
::
cloudlaunch config set url https://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://launch.usegalaxy.org/login. Then navigate to the
``/api/v1/auth/tokens`` API endpoint, for example,
https://launch.usegalaxy.org/cloudlaunch/api/v1/auth/tokens/.
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. ``pip install -r requirements_dev.txt``
Now you can run ``cloudlaunch``.
Release process
===============
::
bumpversion patch
# or `bumpversion minor` or `bumpversion major`
git push
git push --tags
make release
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.2.0 - 2018-11-14 - (sha 331e58f756145316334049100f582dd4316055fb)
------------------
* Major refactoring.
* Backward compatibility with Python 2.
* Integration tests with CloudLaunch.
0.1.0 - 2018-01-09
------------------
* First release on PyPI.
CloudLaunch CLI
===============
.. image:: https://travis-ci.org/CloudVE/cloudlaunch-cli.svg?branch=master
:target: https://travis-ci.org/CloudVE/cloudlaunch-cli
.. image:: https://coveralls.io/repos/github/CloudVE/cloudlaunch-cli/badge.svg?branch=master
:target: https://coveralls.io/github/CloudVE/cloudlaunch-cli?branch=master
.. image:: https://img.shields.io/pypi/v/cloudlaunch_cli.svg
:target: https://pypi-hypernode.com/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`` with pip
::
pip install cloudlaunch-cli
3. The CloudLaunch CLI requires two config settings. First is the URL of
the API root:
::
cloudlaunch config set url https://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://launch.usegalaxy.org/login. Then navigate to the
``/api/v1/auth/tokens`` API endpoint, for example,
https://launch.usegalaxy.org/cloudlaunch/api/v1/auth/tokens/.
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. ``pip install -r requirements_dev.txt``
Now you can run ``cloudlaunch``.
Release process
===============
::
bumpversion patch
# or `bumpversion minor` or `bumpversion major`
git push
git push --tags
make release
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.2.0 - 2018-11-14 - (sha 331e58f756145316334049100f582dd4316055fb)
------------------
* Major refactoring.
* Backward compatibility with Python 2.
* Integration tests with CloudLaunch.
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.2.1.tar.gz
(33.4 kB
view details)
Built Distribution
File details
Details for the file cloudlaunch_cli-0.2.1.tar.gz
.
File metadata
- Download URL: cloudlaunch_cli-0.2.1.tar.gz
- Upload date:
- Size: 33.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1057199769c328cf95b7d3578a9c7c3e3fb374b0e1b468025893b90f07fb9748 |
|
MD5 | 3c0c5c1341473be8696e4463a358a095 |
|
BLAKE2b-256 | 9bc7d3ab153fed06998c1af9241bf7f5185f058a7239e50fa0e9df292ae0b3ed |
File details
Details for the file cloudlaunch_cli-0.2.1-py3-none-any.whl
.
File metadata
- Download URL: cloudlaunch_cli-0.2.1-py3-none-any.whl
- Upload date:
- Size: 13.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f07fbf212c2b63a2e17f59c5214f03f13e8bb6ecb66ec663f61d6110ca904f4f |
|
MD5 | e390caf0eac9f02917e4dfae7ba60d8d |
|
BLAKE2b-256 | 3a087013c704830a993ff00ca9f1f591ef5027ba28476f4b93067cc44f88fcf7 |