Simple CLI for Aqualink API
Project description
pyaqua: Simple CLI for Aqualink API
Table of contents
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.4 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 https://github.com/samapriya/pyaqua.git
cd pyaqua
python setup.py 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:
usage: pyaqua [-h] {site-list,site-live,site-daily,site-timeseries} ...
Simple CLI for Aqualink API
positional arguments:
{site-list,site-live,site-daily,site-timeseries}
site-list Print lists of Site Name and ID with spotters
site-live Get most recent/live info from a site
site-daily Print daily data info for a site
site-timeseries Print daily data info for a site
optional arguments:
-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 pyaqua.py [arguments go here]
pyaqua Simple CLI for Aqualink API
The tool is designed to interact with the Aqualink.org API, for now this is focused only on the spotter endpoints.
site list
This allows you to get existing sites with spotters attached and print Site Name and ID. These could be in different status of application including maintenance, deployed, lost, shipped and so on. The tool also applies a fuzzy search and allows you to look for a specific site to get site id.
site-live
This allows to get the most updated/live information about a site based on a site ID from the idlist. The tool parses the output as an indent JSON object.
site daily
This allows to get the most daily data for a site based on a site ID from the idlist. The tool parses the daily output as an indented JSON and you can specify months since today as well as data type like wind/wave/temp.
site timeseries
This allows to get the most daily data for a site based on a site ID from the idlist. The tool exports the time series data for both NOAA and spotter datasets as CSV to a given folder. It attaches the site_id to the CSV filename spotter_dhw_siteid for example spotter_dhw_1113
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.