Metadata-Version: 2.1
Name: noaa-wildfires
Version: 0.0.3
Summary: Download wildfires data from NOAA satellites
Home-page: http://www.github.com/palewire/noaa-wildfires
Author: Ben Welsh
Author-email: b@palewi.re
License: MIT
Project-URL: Maintainer, https://github.com/palewire
Project-URL: Source, https://github.com/palewire/noaa-wildfires
Project-URL: Tracker, https://github.com/palewire/noaa-wildfires/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: fiona
Requires-Dist: geojson
Requires-Dist: click
Requires-Dist: requests

Download wildfires data from NOAA satellites

Hourly scrapes powered by a GitHub Action are stored in the `data` directory.

## Installation

```sh
pipenv install noaa-wildfires
```

## Command-line usage

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

  A command-line interface for downloading wildfires data from NOAA.

  Returns GeoJSON.

Options:
  --help  Show this message and exit.

Commands:
  hms-fires  The latest fires from Hazard Mapping System satellites
  hms-smoke  The latest smoke data from Hazard Mapping System satellites
```

Download the latest fires from Hazard Mapping System satellites.

```sh
noaawildfires hms-fires
```

Download the latest smoke data from Hazard Mapping System satellites.

```sh
noaawildfires hms-smoke
```

## Python usage

Import the library.

```python
>>> import noaa_wildfires
```

Download the latest fires from Hazard Mapping System satellites.

```python
>>> data = noaa_wildfires.get_hms_fires()
```

Download the latest smoke data from Hazard Mapping System satellites.

```python
>>> data = noaa_wildfires.get_hms_smoke()
```

## Contributing

Install dependencies for development.

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

Run tests.

```sh
make test
```

Ship 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 .
```


