Usage

See https://docs.launchableinc.com/cli-reference and https://docs.launchableinc.com/getting-started.

Development

Preparation

We recommend Pipenv

pip install pipenv==2021.5.29
pipenv install --dev

Note that you will need to use 2021.5.29 as the Python version is fixed at 3.5, and the Pipenv beyond that version won't support Python 3.5 or below.

If you mess up your local pipenv, pipenv --rm will revert the operation above.

In order to automatically format files with autopep8, this repository contains a configuration for pre-commit. Install the hook with pipenv run pre-commit install.

Load development environment

pipenv shell

Run tests

pipenv run test

Add dependency

pipenv install --dev some-what-module

How to release

Create new release on Github, then Github Actions automatically uploads the module to PyPI.

Installing CLI

You can install the launchable command from either source or pypi.

Prerequisite

• >= Python 3.5
• >= Java 8

Install from source

$ pwd
~/cli

$ python setup.py install

Install from pypi

$ pip3 install --user --upgrade launchable~=1.0

Versioning

This module follows Semantic versioning such as X.Y.Z.

• Major (X)
  • Drastic update breaking backward compatibility
• Minor (Y)
  • Add new plugins, options with backward compatibility
• Patch (Z)-
  • Fix bugs or minor behaviors