Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 1.29 KB

README.md

File metadata and controls

73 lines (50 loc) · 1.29 KB
Raw

Download wildfires data from CalFire

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

Installation

pipenv install calfire-wildfires

Command-line usage

Usage: calfirewildfires [OPTIONS] COMMAND [ARGS]...

    A command-line interface for downloading wildfires data from CalFire.
    Returns GeoJSON.

Options:
    --help  Show this message and exit.

Commands:
    active-fires    The latest active fires
    all-fires       Fires year-to-date, both active and contained

From the shell:

calfirewildfires all-fires
calfirewildfires active-fires

Python usage

Import the library.

>>> import calfire_wildfires
>>> data = calfire_wildfires.get_all_fires()
>>> data = calfire_wildfires.get_active_fires()

Contributing

Install dependencies for development.

pipenv install --dev

Run tests.

make test

Ship new version to PyPI.

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.

pip install --editable .