Python SDK for HOUSES API
Project description
HOUSES Client
A Python Client SDK for the Mayo Clinic HOUSES API
Requirements
Python 3.9+
Installation
pip install houses-client
Example Usage
from houses_client import client
#Create a client passing in your API client id and client secret
client = client.HousesClient(api_endpoint="https://houses.konfidential.io",
client_id="my oidc client id",
client_secret="my oidc client secret",
log_level="INFO")
# Submit batch request reading from myinput.csv and writing results to myoutput.csv
# year is applied to records if the csv format doesn not include year
client.batch(input_path="myinput.csv", output_path="myoutput.csv", year=2021, delimiter=',')
Input Data Schema
Single Address Format
- id: user defined unique id
- address: single address string; e.g. 123 main st anycity NY 12345. The address should contain one of the following combinations:
- city and state
- city
- state
- zipcode
- year: the requested year. This is an optional field and if provided overrides the request level year
- referenceAddress: the requested reference address. This is an optional field and if provided overrides the request level reference address
Example:
id,address,year
1,"123 main st anytown ny 5555",2019
2,"456 main st anytown ny 55555",2018
Example With referenceAddress:
id,address,year,referenceAddress
1,"123 main st anytown ny 5555",2019,"789 main st anytown y 55555"
2,"456 main st anytown ny 55555",2018,"678 main st anytown y 55555"
Full Component Address Format
- id: user defined unique id
- address: Street Address
- secondary: Optional Secondary Street Address; e.g. Apartment or Suite number
- city
- state
- zip
- year: the requested year. This is an optional field and if provided overrides the request level year
- referenceAddress: the requested reference address. This is an optional field and if provided overrides the request level reference address
Build
python3 -m pip install --upgrade build
python3 -m build
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for houses_client-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97be18c45379d3f8c8fa1d0f042cfdc103c6e298b0fa2732d15327d83313ae54 |
|
MD5 | bef51ab2a0fdd182928a8e79ec8b66d7 |
|
BLAKE2b-256 | 4d5ceb2c68d1ff2266d91118ff29f0d2c50d0449f31d7314203bff91946cac08 |