Skip to content

General Installation

This assumes that you have native python & pip installed in your system, you can test this by going to the terminal (or windows command prompt) and trying

python and then pip list

pyaqua only support Python v3.7 or higher

To install pyaqua: Simple CLI for Aqualink API you can install using two methods.

pip install pyaqua

or you can also try

git clone
cd pyaqua
python install
For Linux use sudo or try pip install pyaqua --user.

I recommend installation within a virtual environment. Find more information on creating virtual environments here.

Getting started

As usual, to print help:

pyaqua -h
usage: pyaqua [-h] {readme,site-list,site-alert,site-info,site-live,site-daily,site-timeseries} ...

Simple CLI for Aqualink API

positional arguments:
    readme              Go to the web based pyaqua readme page
    site-list           Print lists of Site Name and ID with spotters
    site-alert          Print site alerts for sites with spotters
    site-info           Print detailed information for a site
    site-live           Get most recent/live info from a site
    site-daily          Print daily data info for a site
    site-timeseries     Exports timeseries data for a site

  -h, --help            show this help message and exit

To obtain help for specific functionality, simply call it with help switch, e.g.: pyaqua site-live -h. If you didn't install pyaqua, then you can run it just by going to pyaqua directory and running python [arguments go here]

Last update: 2023-10-24
Created: 2021-12-13