Simple CLI for Happywhale¶
Happywhale is a global citizen science project dedicated to whale and dolphin research and conservation. The user-friendly Happywhale app allows anyone to share photos of encounters with these marine mammals, which are then processed by a team of scientists and volunteers using advanced image recognition algorithms. Identified individuals are tracked over time and across locations, yielding valuable insights into their behavior and aiding in the preservation of critical habitats.
The CLI is designed to interact with the website and allow for you to perform operations like search, download and more using underlying api end points. The CLI provides tools based on API endpoints that may change and evolve and can lead to compatibility issues without API documentations so this tool will be developed as needed to support the larger community needs.
Disclaimer: This is an unofficial tool. Is not licensed or endorsed by Happywhale.com. It is created and maintained by Samapriya Roy.
happywhale -h
usage: happywhale.py [-h] {readme,auth,species,stats,fetch,search,download} ...
Simple CLI for HappyWhale API
positional arguments:
{readme,auth,species,stats,fetch,search,download}
readme Go to the web based happywhale cli readme page
auth Saves your username and password
species Get species list
stats Go site stats for happywhale
fetch Fetch details on an encounter based on encounter id
search Search and export results (Default: Global 1 month)
download Download images from search results (Default: Global 1 month)
options:
-h, --help show this help message and exit
Citation¶
You can cite the tool too
Samapriya Roy. (2023). open-oceans/happywhale: Simple CLI for Happywhales.com API (0.0.2).
Zenodo. https://doi.org/10.5281/zenodo.10081817
Created: 2023-11-07