Metadata-Version: 1.2
Name: calfire-wildfires
Version: 0.0.4
Summary: Download wildfires data from CalFire
Home-page: http://www.github.com/datadesk/calfire-wildfires
Author: Los Angeles Times Data Desk
Author-email: datadesk@latimes.com
License: MIT
Project-URL: Maintainer, https://github.com/datadesk
Project-URL: Source, https://github.com/datadesk/calfire-wildfires
Project-URL: Tracker, https://github.com/datadesk/calfire-wildfires/issues
Description: calfire-wildfires
        =================
        
        Download wildfires data from CalFire
        
        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
              fires           The latest fires, both active and contained
              inactive-fires  The latest inactive fires
              fires-JSON      The latest active fires JSON
        
        Download the latest fires, both active and contained ::
        
            $ calfirewildfires fires
        
        Download the latest active fires ::
        
            $ calfirewildfires active-fires
        
        Download the latest inactive fires ::
        
            $ calfirewildfires inactive-fires
        
        Download the latest active fires json ::
        
            $ calfirewildfires fires-json
        
        
        Python usage
        ------------
        
        Import the library. ::
        
            >>> import calfire_wildfires
        
        Download the latest fires, both active and contained ::
        
            >>> data = calfire_wildfires.get_fires()
        
        Download the latest active fires ::
        
            >>> data = calfire_wildfires.get_active_fires()
        
        Download the latest inactive fires ::
        
            >>> data = calfire_wildfires.get_inactive_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 <https://click.palletsprojects.com/en/7.x/setuptools/#setuptools-integration>`_. ::
        
            $ pip install --editable .
        
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: License :: OSI Approved :: MIT License
