hydro_cli 0.1.0

Hydro Deploy Command Line Interface
Documentation

Hydro CLI

The Hydro CLI is a library and command line tool for provisioning machines and launching distributed Hydro programs on them. Currently, only macOS/Linux are supported.

Installation

First, create a virtual environment and activate it:

$ python3 -m venv .venv
$ source .venv/bin/activate

Then, install Maturin:

$ pip install maturin
$ cargo install maturin # alternative that works outside the venv

Then, build the CLI for local use:

$ maturin develop

Usage

The CLI is a Python package that can be imported into other Python programs. It can also be used as a command line tool.

Command Line Tool

After building the CLI, it will be automatically available on your path in the virtual environment. To see the available commands, run:

$ hydro --help

Python Package

The deployment API can be imported into other Python programs. To use it, import the hydro package:

import hydro

See test.hydro.py for an example of how to use the available APIs.