air-quality-index¶
Download PM2.5 air quality index data from AirNow
Installation¶
pipenv install air-quality-index
Command-line usage¶
Usage: airqualityindex [OPTIONS] COMMAND [ARGS]...
A command-line interface for downloading PM2.5 air quality index data from AirNow.
Options:
--help Show this message and exit.
Commands:
air-quality Download latest air quality GeoJSON data
Download a GeoJSON of PM2.5 air quality index from AirNow.
airqualityindex air-quality
Python usage¶
Import the library.
import air_quality_index
Download a GeoJSON of air quality index from AirNow. Returns GeoJSON.
data = air_quality_index.get_air_quality()
Contributing¶
Install dependencies for development.
pipenv install --dev
Run tests.
pipenv run python test.py
Developing the CLI¶
The command-line interface is implemented using Click and setuptools. To install it locally for development inside your virtual environment, run the following installation command, as prescribed by the Click documentation.
pipenv run pip install --editable .