Skip to content

Commit 04fa845

Browse files
Update README.md (#2)
Added more clarity to initialization of the client.
1 parent 456d776 commit 04fa845

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

README.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,24 +52,24 @@ pip install -e fullcontact-python-client
5252
**PersonClient**
5353
[PersonClient](#personclient) can be initialized and used as below.
5454
```python
55-
import os
5655
from fullcontact import PersonClient
5756

58-
person_client = PersonClient(os.environ.get('FULLCONTACT_API_KEY'))
57+
person_client = PersonClient("<your_fullcontact_api_key>")
5958
person_response = person_client.enrich(email="[email protected]")
6059
```
60+
6161
More examples for [PersonClient](#personclient) usage can be found in [Examples](#personclient-1) section.
6262

6363
**CompanyClient**
6464
[CompanyClient](#companyclient) can be initialized and used as below.
6565
```python
66-
import os
6766
from fullcontact import CompanyClient
6867

69-
company_client = CompanyClient(os.environ.get('FULLCONTACT_API_KEY'))
68+
company_client = CompanyClient("<your_fullcontact_api_key>")
7069
company_enrich_response = company_client.enrich(domain="fullcontact.com")
7170
company_search_response = company_client.search(companyName="fullcontact")
7271
```
72+
7373
More examples for [CompanyClient](#companyclient) usage can be found in [Examples](#companyclient-1) section.
7474

7575
# PersonClient
@@ -271,6 +271,19 @@ For details on Future objects, please refer: https://docs.python.org/3/library/c
271271
## PersonClient
272272
* **Initialization**
273273
```python
274+
from fullcontact import PersonClient
275+
276+
person_client = PersonClient("q4pKoF4fRNk0WxfUn4S3vcKLJGgrXxGQ")
277+
```
278+
279+
You can also export the FullContact API key as an environment variable and then use it in the code.
280+
281+
Export it in terminal:
282+
```bash
283+
export FULLCONTACT_API_KEY="q4pKoF4fRNk0WxfUn4S3vcKLJGgrXxGQ"
284+
```
285+
Then use it in the code:
286+
```python
274287
import os
275288
from fullcontact import PersonClient
276289

@@ -394,6 +407,19 @@ for future in concurrent.futures.as_completed(futures):
394407
## CompanyClient
395408
* **Initialization**
396409
```python
410+
from fullcontact import CompanyClient
411+
412+
company_client = CompanyClient("q4pKoF4fRNk0WxfUn4S3vcKLJGgrXxGQ")
413+
```
414+
415+
You can also export the FullContact API key as an environment variable and then use it in the code.
416+
417+
Export it in terminal:
418+
```bash
419+
export FULLCONTACT_API_KEY="q4pKoF4fRNk0WxfUn4S3vcKLJGgrXxGQ"
420+
```
421+
Then use it in the code:
422+
```python
397423
import os
398424
from fullcontact import CompanyClient
399425

0 commit comments

Comments
 (0)