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)
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 Distribution
houses-client-0.0.9.tar.gz
(5.1 kB
view hashes)
Built Distribution
Close
Hashes for houses_client-0.0.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 350a41bb96b4abf511ed6abb204e9adc48ccd81ce2c743d5a8f5b332148a8754 |
|
MD5 | 2e5aade9093f3d1f4deef1a3aab73bb5 |
|
BLAKE2b-256 | c05d844bac6d423ad48f4643b89b11218c9ea8cc7405986f87b3de715b389d0c |