Metadata-Version: 2.1
Name: air-quality-index
Version: 0.1.0
Summary: Download air quality index data from AirNow
Home-page: http://www.github.com/palewire/air-quality-index
Author: Ben Welsh
Author-email: b@palewi.re
License: MIT
Project-URL: Maintainer, https://github.com/palewire
Project-URL: Source, https://github.com/palewire/air-quality-index
Project-URL: Tracker, https://github.com/palewire/air-quality-index/issues
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: click
Requires-Dist: kml2geojson

Download air quality index data from AirNow

## Installation

```sh
pipenv install air_quality_index
```

## Command-line usage

```sh
Usage: airqualityindex [OPTIONS] COMMAND [ARGS]...

  A command-line interface for downloading wildfire data from NASA
  satellites.

  Returns GeoJSON.

Options:
  --help  Show this message and exit.

Commands:
  air-quality  Download a GeoJSON of air quality index from AirNow
```

Download a GeoJSON of air quality index from AirNow.

```sh
airqualityindex air-quality
```

## Python usage

Import the library.

```python
>>> import air_quality_index
```

Download a GeoJSON of air quality index from AirNow. Returns GeoJSON.

```python
>>> data = air_quality_index.get_air_quality()
```

## Contributing

In order to use this package, you'll need to obtain an API key from [AirNow](https://docs.airnowapi.org/) and set it as a variable in your environment as `AIRNOW_KEYS`. More than one key can be supplied by comma delimiting the string.

```sh
export AIRNOW_KEYS='YOURKEYS,GOHERE'
```

Install dependencies for development.

```sh
pipenv install --dev
```

Run tests.

```sh
make test
```

Shipping new version to PyPI.

```sh
make ship
```

## 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](https://click.palletsprojects.com/en/7.x/setuptools/#setuptools-integration).

```sh
pip install --editable .
```


