| Name | pyprycd JSON |
| Version |
0.1.13
JSON |
| download |
| home_page | |
| Summary | An unofficial Python Client for the PRYCD API for Real Estate Analysis. |
| upload_time | 2024-03-19 17:33:57 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| 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. |
| keywords |
real estate
data
analysis
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
setuptools
requests
pandas
pyarrow
dateparser
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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()
```
Raw data
{
"_id": null,
"home_page": "",
"name": "pyprycd",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "Real Estate,data,analysis",
"author": "",
"author_email": "\"Charles S. Givre\" <charles@geniza.ai>",
"download_url": "https://files.pythonhosted.org/packages/12/2f/8d571670f814eec807454ee30b3cfd4fbfe1adb17d0d124202463173de0f/pyprycd-0.1.13.tar.gz",
"platform": null,
"description": "# PyPRYCD\nThis module provides a simple unofficial wrapper for working with the PRYCD APIs for real estate analysis.\n\n## Getting Started\nTo install, simply execute the following command in the command line:\n\n```shell\npip install pyprycd\n```\n\n### Obtaining API Keys\nOnce 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.\n\n## Methods\n* `get_comps()`: Returns PRYCD comparables in a requested region.\n* `get_counties_in_state(<state>)`: Returns a list of counties in a state. Accepts either a state name or code.\n* `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`\n* `get_pricing()`: Returns PRYCD estimated values for a requested property. Supports all options for the PRYCD API.\n* `set_pricing_api_key(<api_key>)`: Sets or resets the pricing API key. \n* `set_comp_api_key(<api_key>)` Sets or resets the comp API key. Supports all options for the PRYCD API.\n\n\n## Example Usage\n\n```python\nfrom pyprycd import PyPrycd\n\nPRICING_API_KEY = '1234'\nCOMPS_API_KEY = '5678'\n\n# Initialize the PyPrycd Object\npyrcd = PyPrycd(pricing_api_key=PRICING_API_KEY, comp_api_key=COMPS_API_KEY)\n\n# Get a FIPS code\nfips = PyPrycd.get_fips_code('Autauga County AL')\n\n# Get pricing data about a property\npricing_data = pyrcd.get_pricing()\n\n```\n",
"bugtrack_url": null,
"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. ",
"summary": "An unofficial Python Client for the PRYCD API for Real Estate Analysis.",
"version": "0.1.13",
"project_urls": {
"Issues": "https://github.com/geniza-ai/pyprycd/issues",
"Repository": "https://github.com/geniza-ai/pyprycd"
},
"split_keywords": [
"real estate",
"data",
"analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23ca95df12ea001eabb666414e8dca452429b01d9cac668624e2722382f2c0e5",
"md5": "7c72534fa911cfc7af320c66d25606c5",
"sha256": "7e43b6bc33421f3854f416ce01f0e1250fdc752f83c5e160fdc4621add8645ab"
},
"downloads": -1,
"filename": "pyprycd-0.1.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7c72534fa911cfc7af320c66d25606c5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 60628,
"upload_time": "2024-03-19T17:25:52",
"upload_time_iso_8601": "2024-03-19T17:25:52.924528Z",
"url": "https://files.pythonhosted.org/packages/23/ca/95df12ea001eabb666414e8dca452429b01d9cac668624e2722382f2c0e5/pyprycd-0.1.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "122f8d571670f814eec807454ee30b3cfd4fbfe1adb17d0d124202463173de0f",
"md5": "e6234ceb98814eeaf86c1e4fb0bd3439",
"sha256": "a7d292cdb5597bf08f6e61f61c4c71647a8cda62beec0e75b8446a2e680f234a"
},
"downloads": -1,
"filename": "pyprycd-0.1.13.tar.gz",
"has_sig": false,
"md5_digest": "e6234ceb98814eeaf86c1e4fb0bd3439",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 61780,
"upload_time": "2024-03-19T17:33:57",
"upload_time_iso_8601": "2024-03-19T17:33:57.515124Z",
"url": "https://files.pythonhosted.org/packages/12/2f/8d571670f814eec807454ee30b3cfd4fbfe1adb17d0d124202463173de0f/pyprycd-0.1.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 17:33:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "geniza-ai",
"github_project": "pyprycd",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "setuptools",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "pyarrow",
"specs": []
},
{
"name": "dateparser",
"specs": []
}
],
"lcname": "pyprycd"
}
