Skip to content
This repository was archived by the owner on Oct 3, 2021. It is now read-only.

Commit 4009f0e

Browse files
authored
Create README.md
1 parent d844361 commit 4009f0e

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# PDL Wrapper
2+
3+
This utility logs calls to PDL API into DynamoDB.
4+
5+
## Installation
6+
7+
Add this line to your requirements.txt:
8+
```
9+
git+git://github.com/tfc-code/pdl-wrapper@master#egg=pdlwrapper
10+
```
11+
12+
## Usage
13+
14+
```py
15+
pdl_client = pdlwrapper.Client(
16+
account_id="bernie2020",
17+
env="prod", # can be dev, test or prod
18+
pdl_api_key="pdl_key",
19+
aws_access_key_id="aws_key",
20+
aws_secret_access_key="aws_secret",
21+
aws_region_name="us-east-2",
22+
)
23+
24+
# See https://github.com/peopledatalabs/docs for valid attributes
25+
payload = {
26+
"required": "emails AND phone_numbers",
27+
"country": "United States",
28+
"name": "Tom Steyer",
29+
"locality": "New York"
30+
}
31+
32+
resp = pdl_client.get_person(params=payload)
33+
```
34+
35+
The `resp` object is simply the return value of `requests.get()`.

0 commit comments

Comments
 (0)