Skip to content

Commit 61d9329

Browse files
committed
light copy edit on readme
1 parent b2e8c23 commit 61d9329

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
# Uid2 Client Python
1+
# UID2 SDK for Python
22

3-
The UID 2 Project is subject to Tech Lab IPR’s Policy and is managed by the IAB Tech Lab Addressability Working Group and Privacy & Rearc Commit Group. Please review the governance rules [here](https://github.com/IABTechLab/uid2-core/blob/master/Software%20Development%20and%20Release%20Procedures.md)
3+
The UID 2 Project is subject to Tech Lab IPR’s Policy and is managed by the IAB Tech Lab Addressability Working Group and Privacy & Rearc Commit Group. Please review [the governance rules](https://github.com/IABTechLab/uid2-core/blob/master/Software%20Development%20and%20Release%20Procedures.md).
44

5-
Client SDK for working with UID2 services.
5+
This SDK simplifies integration with UID2 for those using Python.
66

7-
SDK supports Python 3.6 and above.
7+
## Dependencies
8+
9+
This SDK supports Python 3.6 and above.
810

911
## Quick Start
1012

11-
Connect to the UID2 service, refresh encryption keys and use those to decrypt an advertising ID
12-
from an advertising token:
13+
Connect to the UID2 service, refresh the encryption keys, and then use the keys to decrypt an advertising token, to arrive at the corresponding advertising ID:
1314

1415
```
1516
from uid2_client import Uid2Client, decrypt_token
@@ -21,11 +22,14 @@ decrypted_token = decrypt_token(advertising_token, keys)
2122
print(decrypted_token.uid2)
2223
```
2324

24-
More examples can be found in the [examples] directory.
25+
Additional examples are in the [examples] directory:
26+
* [sample_auto_refresh.py](examples/sample_auto_refresh.py)
27+
* [sample_client.py](examples/sample_client.py)
28+
* [sample_encryption.py](examples/sample_encryption.py)
2529

2630
## Development
2731

28-
Required for all subsequent commands, build docker image with Python 3.6 and all dev dependencies:
32+
First, build the Docker image with Python 3.6 and all dev dependencies. This is required for all subsequent commands. Run the following:
2933

3034
```
3135
make docker
@@ -43,26 +47,26 @@ Build a bdist wheel:
4347
make wheel
4448
```
4549

46-
Get access to interactive shell within the Python 3.6 docker image:
50+
Get access to an interactive shell within the Python 3.6 Docker image:
4751

4852
```
4953
make shell
5054
```
5155

52-
Run all the example applications:
56+
## Example Usage
57+
58+
To run all the example applications:
5359

5460
```
5561
make examples BASE_URL=https://prod.uidapi.com AUTH_KEY=my-auth-key SECRET_KEY=my-secret-key \
5662
AD_TOKEN=AgAAAANRdREk+IWqqnQkZ2rZdK0TgSUP/owLryysSkUGZJT+Gy551L1WJMAZA/G2B1UMDQ20WAqwwTu6o9TexWyux0lg0HHIbmJjN6IYwo+42KC8ugaR+PX0y18qQ+3yzkxmJ/ee//4IGu/1Yq4AmO4ArXN6CeszPTxByTkysVqyQVNY2A==
5763
```
5864

59-
Or specific examples:
65+
Alternatively, you can run specific examples:
6066

6167
```
6268
make example_client BASE_URL=https://prod.uidapi.com AUTH_KEY=my-auth-key SECRET_KEY=my-secret-key \
6369
AD_TOKEN=AgAAAANRdREk+IWqqnQkZ2rZdK0TgSUP/owLryysSkUGZJT+Gy551L1WJMAZA/G2B1UMDQ20WAqwwTu6o9TexWyux0lg0HHIbmJjN6IYwo+42KC8ugaR+PX0y18qQ+3yzkxmJ/ee//4IGu/1Yq4AmO4ArXN6CeszPTxByTkysVqyQVNY2A==
6470
make example_auto_refresh BASE_URL=https://prod.uidapi.com AUTH_KEY=my-auth-key SECRET_KEY=my-secret-key \
6571
AD_TOKEN=AgAAAANRdREk+IWqqnQkZ2rZdK0TgSUP/owLryysSkUGZJT+Gy551L1WJMAZA/G2B1UMDQ20WAqwwTu6o9TexWyux0lg0HHIbmJjN6IYwo+42KC8ugaR+PX0y18qQ+3yzkxmJ/ee//4IGu/1Yq4AmO4ArXN6CeszPTxByTkysVqyQVNY2A==
6672
```
67-
68-

0 commit comments

Comments
 (0)