Metadata-Version: 2.1
Name: pyprycd
Version: 0.1.8
Summary: An unofficial Python Client for the PRYCD API for Real Estate Analysis.
Author-email: "Charles S. Givre" <charles@geniza.ai>
License: MIT License
        
        Copyright (c) 2024 Geniza Inc.
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Repository, https://github.com/geniza-ai/pyprycd
Project-URL: Issues, https://github.com/geniza-ai/pyprycd/issues
Keywords: Real Estate,data,analysis
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dateparser
Requires-Dist: requests
Requires-Dist: pyarrow
Requires-Dist: pandas

# PyPRYCD
This module provides a simple unofficial wrapper for working with the PRYCD APIs for real estate analysis.

## Getting Started
To install, simply execute the following command in the command line:

```shell
pip install pyprycd
```

### Obtaining API Keys
Once you have installed the module, you can now make API calls, however you will have to purchase API keys from PRYCD at (www.prycd.com)  Pyrcd has two separate API keys for the pricing and comps API which must be purchased separately.  When you initialize the constructor, you can set either of them, or set the keys later using one of the setter methods.

## Methods
* `get_comps()`:  Returns PRYCD comparables in a requested region.
* `get_counties_in_state(<state>)`:  Returns a list of counties in a state. Accepts either a state name or code.
* `get_fips_code(<county>)`: Returns the FIPS code for a county. Note that you must spell out the full county name and state. IE: `Maricopa County AZ`
* `get_pricing()`:  Returns PRYCD estimated values for a requested property.  Supports all options for the PRYCD API.
* `set_pricing_api_key(<api_key>)`: Sets or resets the pricing API key. 
* `set_comp_api_key(<api_key>)`  Sets or resets the comp API key.  Supports all options for the PRYCD API.


## Example Usage
```python
from pyprycd import PyPrycd

PRICING_API_KEY = '1234'
COMPS_API_KEY = '5678'

# Initialize the PyPrycd Object
pyrcd = PyPrycd(pricing_api_key=PRICING_API_KEY, comp_api_key=COMPS_API_KEY)

# Get a FIPS code
fips = PyPrycd.get_fips_code('Autauga County AL')

# Get pricing data about a property
pricing_data = pyrcd.get_pricing()

```
