Metadata-Version: 2.4
Name: pyOpenFEMA
Version: 1.0.2
Summary: A python package for easily reading OpenFEMA datasets.
Maintainer-email: Keith Doore <keith.doore@fema.dhs.gov>
License: # License
        
        As a work of the United States government, this project is in the
        public domain within the United States.
        
        Additionally, we waive copyright and related rights in the work
        worldwide through the CC0 1.0 Universal public domain dedication.
        
        ## CC0 1.0 Universal summary
        
        This is a human-readable summary of the [Legal Code (read the full text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode).
        
        ### No copyright
        
        The person who associated a work with this deed has dedicated the work to
        the public domain by waiving all rights to the work worldwide
        under copyright law, including all related and neighboring rights, to the
        extent allowed by law.
        
        You can copy, modify, distribute, and perform the work, even for commercial
        purposes, all without asking permission.
        
        ### Other information
        
        In no way are the patent or trademark rights of any person affected by CC0,
        nor are the rights that other persons may have in the work or in how the
        work is used, such as publicity or privacy rights.
        
        Unless expressly stated otherwise, the person who associated a work with
        this deed makes no warranties about the work, and disclaims liability for
        all uses of the work, to the fullest extent permitted by applicable law.
        When using or citing the work, you should not imply endorsement by the
        author or the affirmer.
Project-URL: homepage, https://github.com/kjdoore/pyOpenFEMA
Project-URL: repository, https://github.com/kjdoore/pyOpenFEMA.git
Keywords: FEMA,Datasets
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: fsspec
Requires-Dist: aiohttp
Requires-Dist: pyarrow
Requires-Dist: pyyaml
Requires-Dist: fastparquet
Requires-Dist: geopandas
Provides-Extra: dev
Requires-Dist: flake8; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: requests_mock; extra == "dev"
Dynamic: license-file

# pyOpenFEMA
*A python package for easily reading OpenFEMA datasets.*

This package is intended to facilitate better access and promote more rapid analysis of OpenFEMA data.
It is a wrapper around the OpenFEMA API, which allows for direct reading of datasets into a [`pandas`](https://pandas.pydata.org/pandas-docs/stable/index.html) dataframe without a user having to manually set up the API URL to the data.
Users can either read in the full dataset or read in a subset of a dataset.

Please report any bugs, suggest enhancements, or ask questions by creating an [issue](https://github.com/kjdoore/pyOpenFEMA/issues).
  
## Installation
The package can be installed using pip
```sh
pip install pyOpenFEMA
```

## Basic Usage
At a basic level, a dataset can be read with:

```python
from pyOpenFEMA.OpenFEMA import OpenFEMA

# Initialize the OpenFEMA session
openfema = OpenFEMA()

# List available datasets
print(openfema.list_datasets())

# Read in a dataset
df_femaregions = openfema.read_dataset('FemaRegions')
```

For more details and how to subset a dataset, see the [tutorial notebook](https://github.com/kjdoore/pyOpenFEMA/blob/main/examples/tutorial.ipynb).
