Name | valued JSON |
Version |
0.2.2
JSON |
| download |
home_page | |
Summary | |
upload_time | 2023-04-12 00:42:10 |
maintainer | |
docs_url | None |
author | Support |
requires_python | >=3.10,<4.0 |
license | |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/7bf4ee4d616049658be2f1a6d12fb5c0)](https://app.codacy.com?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/7bf4ee4d616049658be2f1a6d12fb5c0)](https://app.codacy.com?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
![CI/CD Workflow](https://github.com/valued-app/valued.py/actions/workflows/ci-cd.yaml/badge.svg)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
# Valued Python Client
A Python client library for sending events to [Valued](https://valued.app).
## Installation
```bash
$ pip install valued
```
## Usage
You can create a `valued.Client` instance and call `action`, `sync` etc directly on the client.
```python
import os
import valued
# Get the token for authentication.
token = os.environ.get("VALUED_TOKEN") # or wherever you store credentials
# Create a client
client = valued.Client(token)
# Record an action
client.action("report.generated", {
"customer": { "id": 12 },
"user": { "id": 123 },
"attributes": { "format": "pdf" }
})
# Sync user data
client.sync_user({
"id": 123,
"name": "Josh Kalderimis",
"email": "josh@valued.app",
"location": { "country": "NZ", "region": "Wellington" }
})
```
## Contributing
All commits messages should be in the [Angluar commit style](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commit-message-format)
- feat: A new feature.
- fix: A bug fix.
- docs: Documentation changes.
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
- refactor: A code change that neither fixes a bug nor adds a feature.
- perf: A code change that improves performance.
- test: Changes to the test framework.
- build: Changes to the build process or tools.
Raw data
{
"_id": null,
"home_page": "",
"name": "valued",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Support",
"author_email": "hello@valued.app",
"download_url": "https://files.pythonhosted.org/packages/0b/63/4b1090683c4f3ae7d75ad6638d48032f866a1ee7fcb10f299e5ba6f2d290/valued-0.2.2.tar.gz",
"platform": null,
"description": "[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/7bf4ee4d616049658be2f1a6d12fb5c0)](https://app.codacy.com?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/7bf4ee4d616049658be2f1a6d12fb5c0)](https://app.codacy.com?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)\n![CI/CD Workflow](https://github.com/valued-app/valued.py/actions/workflows/ci-cd.yaml/badge.svg)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\n# Valued Python Client\n\nA Python client library for sending events to [Valued](https://valued.app).\n\n## Installation\n\n```bash\n$ pip install valued\n```\n\n## Usage\n\nYou can create a `valued.Client` instance and call `action`, `sync` etc directly on the client.\n\n```python\nimport os\nimport valued\n\n# Get the token for authentication.\ntoken = os.environ.get(\"VALUED_TOKEN\") # or wherever you store credentials\n\n# Create a client\nclient = valued.Client(token)\n\n# Record an action\nclient.action(\"report.generated\", {\n \"customer\": { \"id\": 12 },\n \"user\": { \"id\": 123 },\n \"attributes\": { \"format\": \"pdf\" }\n})\n\n# Sync user data\nclient.sync_user({\n \"id\": 123,\n \"name\": \"Josh Kalderimis\",\n \"email\": \"josh@valued.app\",\n \"location\": { \"country\": \"NZ\", \"region\": \"Wellington\" }\n})\n```\n\n## Contributing\n\nAll commits messages should be in the [Angluar commit style](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commit-message-format)\n\n- feat: A new feature.\n- fix: A bug fix.\n- docs: Documentation changes.\n- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).\n- refactor: A code change that neither fixes a bug nor adds a feature.\n- perf: A code change that improves performance.\n- test: Changes to the test framework.\n- build: Changes to the build process or tools.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "",
"version": "0.2.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "842df641973147ec252eb0411c8cd9738bdd8a384afe77eeb3c6d459ca172dad",
"md5": "3cc09b8829256df05186cab12e7092bc",
"sha256": "f15fe44a7b5fa2cc0cabeaa2eccfa5f2a0b59a8d284d2b35de3563726b951b88"
},
"downloads": -1,
"filename": "valued-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3cc09b8829256df05186cab12e7092bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 3710,
"upload_time": "2023-04-12T00:42:06",
"upload_time_iso_8601": "2023-04-12T00:42:06.829308Z",
"url": "https://files.pythonhosted.org/packages/84/2d/f641973147ec252eb0411c8cd9738bdd8a384afe77eeb3c6d459ca172dad/valued-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0b634b1090683c4f3ae7d75ad6638d48032f866a1ee7fcb10f299e5ba6f2d290",
"md5": "3615de51f6ab26f06a62ab7f89b957ce",
"sha256": "4e422de640bdcbd0b16774da63bf06a0c46f5fbda89451fb02777e5d93c187b6"
},
"downloads": -1,
"filename": "valued-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "3615de51f6ab26f06a62ab7f89b957ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 3668,
"upload_time": "2023-04-12T00:42:10",
"upload_time_iso_8601": "2023-04-12T00:42:10.395302Z",
"url": "https://files.pythonhosted.org/packages/0b/63/4b1090683c4f3ae7d75ad6638d48032f866a1ee7fcb10f299e5ba6f2d290/valued-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-12 00:42:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "valued"
}