| Name | versium-reach-sdk JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | https://github.com/VersiumAnalytics/reach-api-python-sdk |
| Summary | Python SDK for querying Versium Reach APIs |
| upload_time | 2023-05-24 18:19:46 |
| maintainer | |
| docs_url | None |
| author | Versium Analytics, Inc. |
| requires_python | ~=3.7 |
| license | Copyright 2022 Versium Analytics, Inc. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
versium
martech
api
sdk
data enrichment
data appends
marketing
b2b
b2c
audience
identity graph
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Versium Reach API Software Development Kit (SDK)
A simplified Python interface for appending data using [Versium Reach APIs](https://api-documentation.versium.com/docs/start-building-with-versium)
## Installation
It's recommended that you first create a virtual Python environment before installing using tools such as virtualenv or
conda. This is to prevent you from installing the package directly onto your system's base Python installation. Once
you have created and activated your virtual environment, proceed with one of the steps below.
## PyPI
```bash
pip install versium-reach-sdk
```
## Install from Source
1) Clone or download the codebase from the [GitHub Page](https://github.com/VersiumAnalytics/reach-api-python-sdk)
2) CD into the newly downloaded or cloned folder
```bash
cd reach-path-python-sdk
```
3) Now install the package with pip
```bash
pip install .
```
## Usage
1) Import ReachClient into your program
```python
from reach import ReachClient
```
2) Pass your [API Key](https://app.versium.com/account/manage-api-keys) to the ReachClient constructor.
```python
client = ReachClient('api-key-012345678')
```
3) Run the `append` method of your `ReachClient` object with the API name, input records, desired outputs (if applicable),
and any extra config parameters you wish to pass.
```python
records = [{"first": "John",
"last": "Smith",
"address": "123 Main St.",
"city": "New York",
"state": "NY"}]
results = client.append(api_name="contact",
input_records=records,
outputs=["phone", "email"],
config_params={"match_type": "indiv"})
```
## Returned Results
Results are returned as a list of QueryResult objects, which contain the following attributes:
- **body** :
The parsed body of the response from the Versium Reach API.
- **success** :
Indicates whether the request returned with a successful status code.
- **match_found** :
Indicates whether a match was found for the queried record
- **http_status** :
The http status code for the response.
- **reason**:
Explanation of the http status code (e.g. 200 => "OK", 404 => "Not Found", 401 => "Unauthorized", etc.)
- **headers**:
The headers of the response.
- **body_raw**:
The body of the response as raw bytes
- **request_error**:
If the client errored out during a request, this stores the error object
- **error_msg**:
Stores additional info about query errors.
# Things to keep in mind
- The default rate limit for Reach APIs is 20 queries per second
- You must have a provisioned API key for this function to work. If you are unsure where to find your API key,
look at our [API key documentation](https://api-documentation.versium.com/docs/find-your-api-key)
Raw data
{
"_id": null,
"home_page": "https://github.com/VersiumAnalytics/reach-api-python-sdk",
"name": "versium-reach-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "Versium,MarTech,API,SDK,Data Enrichment,Data Appends,Marketing,B2B,B2C,Audience,Identity Graph",
"author": "Versium Analytics, Inc.",
"author_email": "\"Versium Analytics, Inc.\" <opensource@versium.com>",
"download_url": "https://files.pythonhosted.org/packages/61/c6/6acb81e68238c9bab6491e81082a9685a6a5f72135dee71f6355362f45e3/versium-reach-sdk-1.1.0.tar.gz",
"platform": null,
"description": "# Versium Reach API Software Development Kit (SDK)\nA simplified Python interface for appending data using [Versium Reach APIs](https://api-documentation.versium.com/docs/start-building-with-versium)\n\n## Installation\nIt's recommended that you first create a virtual Python environment before installing using tools such as virtualenv or \nconda. This is to prevent you from installing the package directly onto your system's base Python installation. Once\nyou have created and activated your virtual environment, proceed with one of the steps below.\n\n## PyPI\n```bash\npip install versium-reach-sdk\n```\n## Install from Source\n1) Clone or download the codebase from the [GitHub Page](https://github.com/VersiumAnalytics/reach-api-python-sdk)\n2) CD into the newly downloaded or cloned folder\n```bash\ncd reach-path-python-sdk\n```\n3) Now install the package with pip\n```bash\npip install .\n```\n\n## Usage\n\n1) Import ReachClient into your program\n```python\nfrom reach import ReachClient\n```\n2) Pass your [API Key](https://app.versium.com/account/manage-api-keys) to the ReachClient constructor.\n```python\nclient = ReachClient('api-key-012345678')\n```\n3) Run the `append` method of your `ReachClient` object with the API name, input records, desired outputs (if applicable),\nand any extra config parameters you wish to pass.\n```python\nrecords = [{\"first\": \"John\", \n \"last\": \"Smith\",\n \"address\": \"123 Main St.\",\n \"city\": \"New York\",\n \"state\": \"NY\"}]\n\nresults = client.append(api_name=\"contact\",\n input_records=records,\n outputs=[\"phone\", \"email\"],\n config_params={\"match_type\": \"indiv\"})\n```\n\n## Returned Results\nResults are returned as a list of QueryResult objects, which contain the following attributes:\n\n- **body** : \n The parsed body of the response from the Versium Reach API.\n\n\n- **success** :\n Indicates whether the request returned with a successful status code.\n\n\n- **match_found** :\n Indicates whether a match was found for the queried record\n\n\n- **http_status** :\n The http status code for the response.\n\n\n- **reason**:\n Explanation of the http status code (e.g. 200 => \"OK\", 404 => \"Not Found\", 401 => \"Unauthorized\", etc.)\n\n\n- **headers**:\n The headers of the response.\n\n\n- **body_raw**:\n The body of the response as raw bytes\n\n\n- **request_error**:\n If the client errored out during a request, this stores the error object\n\n\n- **error_msg**:\n Stores additional info about query errors.\n\n# Things to keep in mind\n- The default rate limit for Reach APIs is 20 queries per second\n- You must have a provisioned API key for this function to work. If you are unsure where to find your API key, \nlook at our [API key documentation](https://api-documentation.versium.com/docs/find-your-api-key)\n",
"bugtrack_url": null,
"license": "Copyright 2022 Versium Analytics, Inc. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Python SDK for querying Versium Reach APIs",
"version": "1.1.0",
"project_urls": {
"API Trial Account": "https://app.versium.com/create-developer-account",
"Documentation": "https://api-documentation.versium.com/reference/welcome",
"Homepage": "https://api-documentation.versium.com/",
"Repository": "https://github.com/VersiumAnalytics/reach-api-python-sdk"
},
"split_keywords": [
"versium",
"martech",
"api",
"sdk",
"data enrichment",
"data appends",
"marketing",
"b2b",
"b2c",
"audience",
"identity graph"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eeec38ed22cad963fa5bec42bb81cd5353ae14f01c798518e05d14f8a4cce0cd",
"md5": "1bba00c188ae90cfcce9a7b0c4c5fec4",
"sha256": "05e64aef043aeae76ce1f57e96a8e32848c0a1deac7e672a4c4760c80c4fa010"
},
"downloads": -1,
"filename": "versium_reach_sdk-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1bba00c188ae90cfcce9a7b0c4c5fec4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 18844,
"upload_time": "2023-05-24T18:19:44",
"upload_time_iso_8601": "2023-05-24T18:19:44.637761Z",
"url": "https://files.pythonhosted.org/packages/ee/ec/38ed22cad963fa5bec42bb81cd5353ae14f01c798518e05d14f8a4cce0cd/versium_reach_sdk-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "61c66acb81e68238c9bab6491e81082a9685a6a5f72135dee71f6355362f45e3",
"md5": "4337701a4f6b52bc40b13b9a954262b7",
"sha256": "064e220c35913f89840f5fe425a05ee9eddf5ad97fed80ff7da97a7469d5494f"
},
"downloads": -1,
"filename": "versium-reach-sdk-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "4337701a4f6b52bc40b13b9a954262b7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 18867,
"upload_time": "2023-05-24T18:19:46",
"upload_time_iso_8601": "2023-05-24T18:19:46.246907Z",
"url": "https://files.pythonhosted.org/packages/61/c6/6acb81e68238c9bab6491e81082a9685a6a5f72135dee71f6355362f45e3/versium-reach-sdk-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-24 18:19:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VersiumAnalytics",
"github_project": "reach-api-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "versium-reach-sdk"
}
