Skip to content

Commit f331be5

Browse files
committed
remove duplicate info and point to official guide
1 parent 7dea42c commit f331be5

File tree

1 file changed

+0
-49
lines changed

1 file changed

+0
-49
lines changed

README.md

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,55 +2,6 @@
22

33
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-
This document includes:
6-
* [Requirements](#requirements)
7-
* [Install](#install)
8-
* [Usage](#usage)
9-
* [Development](#development)
10-
* [Example Usage](#example-usage)
11-
12-
## Requirements
13-
14-
This SDK supports Python 3.6 and above.
15-
16-
## Install
17-
18-
The SDK can be installed using pip.
19-
```
20-
pip install uid2-client
21-
```
22-
235
## Usage
246

257
For documentation on usage, see the [UID2 SDK for Python Reference Guide](https://unifiedid.com/docs/sdks/uid2-sdk-ref-python).
26-
27-
## Example Usage
28-
29-
30-
You can run specific examples:
31-
32-
```
33-
python examples/sample_bidstream_client.py BASE_URL=https://operator-integ.uidapi.com AUTH_KEY=my-auth-key SECRET_KEY=my-secret-key
34-
DOMAIN_NAME=domain-name AD_TOKEN=ad-token
35-
```
36-
37-
## Development
38-
39-
First, build the Docker image with Python 3.6 and all dev dependencies. This is required for all subsequent commands. Run the following:
40-
41-
```
42-
make docker
43-
```
44-
45-
Build a bdist wheel:
46-
47-
```
48-
make wheel
49-
```
50-
51-
Get access to an interactive shell within the Python 3.6 Docker image:
52-
53-
```
54-
make shell
55-
```
56-
Run unit tests: Use PyCharm to run the test cases

0 commit comments

Comments
 (0)