Skip to content

launchableinc/cli

Repository files navigation

Usage

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

Development

Preparation

We recommend Pipenv

pip install pipenv==2021.5.29
pipenv install --dev

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 cli

pipenv run test

Run tests exe_deploy.jar

bazel 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.

How to update launchable/jar/exe_deploy.jar

bazel build //src/main/java/com/launchableinc/ingest/commits:exe_deploy.jar
bazel test //...
cp bazel-bin/src/main/java/com/launchableinc/ingest/commits/exe_deploy.jar launchable/jar/exe_deploy.jar

Installing CLI

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

Prerequisite

  • >= Python 3.6
  • >= 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