Skip to content

Commit 5ae9b09

Browse files
authored
Merge pull request #42 from IABTechLab/aaq-UID2-3320-update-readme-official-guide
[UID2-3320] Clean up dependencies and point to official guide
2 parents 7dea42c + deb3381 commit 5ae9b09

File tree

3 files changed

+7
-57
lines changed

3 files changed

+7
-57
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

pyproject.toml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,15 @@ classifiers = [
1818
"License :: OSI Approved :: MIT License",
1919
"Operating System :: OS Independent",
2020
]
21+
requires-python = ">=3.6"
2122
dependencies = [
22-
"pycryptodome"
23+
"setuptools",
24+
"pycryptodome",
25+
"bitarray"
2326
]
24-
27+
keywords = ["uid2"]
28+
[project.license]
29+
file="LICENSE"
2530
[project.urls]
2631
"Homepage" = "https://github.com/IABTechLab/uid2-client-python"
2732
"Bug Tracker" = "https://github.com/IABTechLab/uid2-client-python/issues"

setup.cfg

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,7 @@ home_page = https://iabtechlab.com
66
description = Client for working with advertising UID2 services
77
long_description = file: README.md
88
long_description_content_type = text/markdown
9-
license = Apache 2.0
10-
license_file = LICENSE
119
platform = any
12-
keywords = uid2
1310
# Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
1411
classifiers =
1512
Development Status :: 3 - Alpha
@@ -31,9 +28,6 @@ classifiers =
3128
zip_safe = true
3229
packages = find:
3330
include_package_data = true
34-
python_requires = >= 3.6
35-
install_requires =
36-
pycryptodome
3731

3832
[options.packages.find]
3933
exclude = examples, tests

0 commit comments

Comments
 (0)