# braze-client
A Python client for the Braze REST API
[](https://travis-ci.com/dtatarkin/braze-client)
[](https://codecov.io/gh/dtatarkin/braze-client)
### How to install
Make sure you have Python 2.7+ or 3.6+ installed and run:
```
$ pip install braze-client-p311
```
### How to use
```python
from braze.client import BrazeClient
client = BrazeClient(api_key='YOUR_API_KEY', use_auth_header=True)
r = client.user_track(
attributes=[{
'external_id': '1',
'first_name': 'First name',
'last_name': 'Last name',
'email': 'email@example.com',
'status': 'Active',
# And other fields ...
}],
events=None,
purchases=None,
)
if r['success']:
# do our magic here
print('Success!')
print(r)
else:
print(r['client_error'])
print(r['errors'])
```
For more examples, check `examples.py`.
### How to test
To run the unit tests, make sure you have the [tox](https://tox.readthedocs.io/en/latest/) module installed
and run the following from the repository root directory:
`$ tox`
Raw data
{
"_id": null,
"home_page": "https://github.com/kpeutcr8/braze-client",
"name": "braze-client-p311",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*",
"maintainer_email": "",
"keywords": "Appboy,Braze",
"author": "",
"author_email": "kpeutcr8@yandex.ru",
"download_url": "https://files.pythonhosted.org/packages/1e/c3/cd595f2fc506c17d214f57df6944e5834f456c8801c4de5614a1b6b719b7/braze-client-p311-0.0.5.tar.gz",
"platform": null,
"description": "# braze-client\nA Python client for the Braze REST API\n\n[](https://travis-ci.com/dtatarkin/braze-client)\n[](https://codecov.io/gh/dtatarkin/braze-client)\n\n### How to install\n\nMake sure you have Python 2.7+ or 3.6+ installed and run:\n\n```\n$ pip install braze-client-p311\n```\n\n### How to use\n\n```python\nfrom braze.client import BrazeClient\nclient = BrazeClient(api_key='YOUR_API_KEY', use_auth_header=True)\n\nr = client.user_track(\n attributes=[{\n 'external_id': '1',\n 'first_name': 'First name',\n 'last_name': 'Last name',\n 'email': 'email@example.com',\n 'status': 'Active',\n # And other fields ...\n }],\n events=None,\n purchases=None,\n)\nif r['success']:\n # do our magic here\n print('Success!')\n print(r)\nelse:\n print(r['client_error'])\n print(r['errors'])\n\n```\nFor more examples, check `examples.py`.\n\n### How to test\n\nTo run the unit tests, make sure you have the [tox](https://tox.readthedocs.io/en/latest/) module installed \nand run the following from the repository root directory:\n\n`$ tox`\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Braze Python Client",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/kpeutcr8/braze-client"
},
"split_keywords": [
"appboy",
"braze"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d7964f4fc00691d9955759bba0318dd07f43ced9e8bec91c26d7fb0f6a63b4d",
"md5": "49d926fc439518a38d8efaad30ca6842",
"sha256": "7459e2914cac19fee91ba905bb843d5d7d9ad90c5dba2c9d15d00ea8e1f3acd0"
},
"downloads": -1,
"filename": "braze_client_p311-0.0.5-py2-none-any.whl",
"has_sig": false,
"md5_digest": "49d926fc439518a38d8efaad30ca6842",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*",
"size": 8430,
"upload_time": "2024-01-24T10:08:38",
"upload_time_iso_8601": "2024-01-24T10:08:38.782642Z",
"url": "https://files.pythonhosted.org/packages/2d/79/64f4fc00691d9955759bba0318dd07f43ced9e8bec91c26d7fb0f6a63b4d/braze_client_p311-0.0.5-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1ec3cd595f2fc506c17d214f57df6944e5834f456c8801c4de5614a1b6b719b7",
"md5": "7e9190f663b7469e2e22f73e6f76df85",
"sha256": "0baa14f3fd1a8c7d0330bd72ffa897119e88b2b219f7e3f373330c5b25bd2113"
},
"downloads": -1,
"filename": "braze-client-p311-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "7e9190f663b7469e2e22f73e6f76df85",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*",
"size": 7289,
"upload_time": "2024-01-24T10:08:40",
"upload_time_iso_8601": "2024-01-24T10:08:40.008594Z",
"url": "https://files.pythonhosted.org/packages/1e/c3/cd595f2fc506c17d214f57df6944e5834f456c8801c4de5614a1b6b719b7/braze-client-p311-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-24 10:08:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kpeutcr8",
"github_project": "braze-client",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "braze-client-p311"
}
JSON
