async-customerio


Nameasync-customerio JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/healthjoy/async-customerio
SummaryAsync CustomerIO Client - a Python client to interact with CustomerIO in an async fashion.
upload_time2023-08-22 09:50:24
maintainerHealthjoy Developers
docs_urlNone
authorAleksandr Omyshev
requires_python>=3.7.15,<3.12
licenseMIT
keywords async asyncio customerio messaing python3 data-driven-emails push notifications in-app messages sms
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # async-customerio is a lightweight asynchronous client to interact with CustomerIO
[![PyPI download month](https://img.shields.io/pypi/dm/async-customerio.svg)](https://pypi.python.org/pypi/async-customerio/)
[![PyPI version fury.io](https://badge.fury.io/py/async-customerio.svg)](https://pypi.python.org/pypi/async-customerio/)
[![PyPI license](https://img.shields.io/pypi/l/async-customerio.svg)](https://pypi.python.org/pypi/async-customerio/)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/async-customerio.svg)](https://pypi.python.org/pypi/async-customerio/)
[![CI](https://github.com/healthjoy/async-customerio/actions/workflows/ci.yml/badge.svg)](https://github.com/healthjoy/async-customerio/actions/workflows/ci.yml)
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/3629b50827ef4e89ba0eaa5c09584273)](https://www.codacy.com/gh/healthjoy/async-customerio/dashboard?utm_source=github.com&utm_medium=referral&utm_content=healthjoy/async-customerio&utm_campaign=Badge_Coverage)

  * Free software: MIT license
  * Requires: Python 3.7+

## Features

  * Fully async
  * Interface preserved as Official Python Client `customerio` has
  * Send push notification
  * Send messages

## Installation
```shell script
$ pip install async-customerio
```

## Getting started
```python
import asyncio

from async_customerio import AsyncCustomerIO, Regions


async def main():
    site_id = "Some-id-gotten-from-CustomerIO"
    api_key = "Some-key-gotten-from-CustomerIO"
    cio = AsyncCustomerIO(site_id, api_key, region=Regions.US)
    await cio.identify(id=5, email="customer@example.com", first_name="John", last_name="Doh", subscription_plan="premium")
    await cio.track(customer_id=5, name="product.purchased", product_sku="XYZ-12345", price=23.45)


if __name__ == "__main__":
    asyncio.run(main())
```

#### Instantiating `AsyncCustomerIO` object

Create an instance of the client with your [Customer.io credentials](https://fly.customer.io/settings/api_credentials).

```python

from async_customerio import AsyncCustomerIO, Regions


cio = AsyncCustomerIO(site_id, api_key, region=Regions.US)
```

`region` is optional and takes one of two values — `Regions.US` or `Regions.EU`. If you do not specify your region, we assume
that your account is based in the US (`Regions.US`). If your account is based in the EU and you do not provide the correct region
(`Regions.EU`), we'll route requests to our EU data centers accordingly, however this may cause data to be logged in the US.

## License

``async-customerio`` is offered under the MIT license.

## Source code

The latest developer version is available in a GitHub repository:
[https://github.com/healthjoy/async-customerio](https://github.com/healthjoy/async-customerio)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/healthjoy/async-customerio",
    "name": "async-customerio",
    "maintainer": "Healthjoy Developers",
    "docs_url": null,
    "requires_python": ">=3.7.15,<3.12",
    "maintainer_email": "developers@healthjoy.com",
    "keywords": "async,asyncio,customerio,messaing,python3,data-driven-emails,push notifications,in-app messages,SMS",
    "author": "Aleksandr Omyshev",
    "author_email": "oomyshev@healthjoy.com",
    "download_url": "https://files.pythonhosted.org/packages/8a/d1/d1a88c7e6d12a39bfa777ea12420b550c0aeb8b7aa81816c0bac56f06600/async_customerio-1.1.0.tar.gz",
    "platform": null,
    "description": "# async-customerio is a lightweight asynchronous client to interact with CustomerIO\n[![PyPI download month](https://img.shields.io/pypi/dm/async-customerio.svg)](https://pypi.python.org/pypi/async-customerio/)\n[![PyPI version fury.io](https://badge.fury.io/py/async-customerio.svg)](https://pypi.python.org/pypi/async-customerio/)\n[![PyPI license](https://img.shields.io/pypi/l/async-customerio.svg)](https://pypi.python.org/pypi/async-customerio/)\n[![PyPI pyversions](https://img.shields.io/pypi/pyversions/async-customerio.svg)](https://pypi.python.org/pypi/async-customerio/)\n[![CI](https://github.com/healthjoy/async-customerio/actions/workflows/ci.yml/badge.svg)](https://github.com/healthjoy/async-customerio/actions/workflows/ci.yml)\n[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/3629b50827ef4e89ba0eaa5c09584273)](https://www.codacy.com/gh/healthjoy/async-customerio/dashboard?utm_source=github.com&utm_medium=referral&utm_content=healthjoy/async-customerio&utm_campaign=Badge_Coverage)\n\n  * Free software: MIT license\n  * Requires: Python 3.7+\n\n## Features\n\n  * Fully async\n  * Interface preserved as Official Python Client `customerio` has\n  * Send push notification\n  * Send messages\n\n## Installation\n```shell script\n$ pip install async-customerio\n```\n\n## Getting started\n```python\nimport asyncio\n\nfrom async_customerio import AsyncCustomerIO, Regions\n\n\nasync def main():\n    site_id = \"Some-id-gotten-from-CustomerIO\"\n    api_key = \"Some-key-gotten-from-CustomerIO\"\n    cio = AsyncCustomerIO(site_id, api_key, region=Regions.US)\n    await cio.identify(id=5, email=\"customer@example.com\", first_name=\"John\", last_name=\"Doh\", subscription_plan=\"premium\")\n    await cio.track(customer_id=5, name=\"product.purchased\", product_sku=\"XYZ-12345\", price=23.45)\n\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n```\n\n#### Instantiating `AsyncCustomerIO` object\n\nCreate an instance of the client with your [Customer.io credentials](https://fly.customer.io/settings/api_credentials).\n\n```python\n\nfrom async_customerio import AsyncCustomerIO, Regions\n\n\ncio = AsyncCustomerIO(site_id, api_key, region=Regions.US)\n```\n\n`region` is optional and takes one of two values \u2014 `Regions.US` or `Regions.EU`. If you do not specify your region, we assume\nthat your account is based in the US (`Regions.US`). If your account is based in the EU and you do not provide the correct region\n(`Regions.EU`), we'll route requests to our EU data centers accordingly, however this may cause data to be logged in the US.\n\n## License\n\n``async-customerio`` is offered under the MIT license.\n\n## Source code\n\nThe latest developer version is available in a GitHub repository:\n[https://github.com/healthjoy/async-customerio](https://github.com/healthjoy/async-customerio)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Async CustomerIO Client - a Python client to interact with CustomerIO in an async fashion.",
    "version": "1.1.0",
    "project_urls": {
        "Homepage": "https://github.com/healthjoy/async-customerio",
        "Repository": "https://github.com/healthjoy/async-customerio"
    },
    "split_keywords": [
        "async",
        "asyncio",
        "customerio",
        "messaing",
        "python3",
        "data-driven-emails",
        "push notifications",
        "in-app messages",
        "sms"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0824454c8866933344724c7f6639d2a9104702a1a52770a2e00290e88ce0418b",
                "md5": "330cd57e7664f56e1c27782c3ae48e97",
                "sha256": "e6774d7d3ab70d8e63c865c6e2ac061fd379d78647ce069494110d8fb0cd2a60"
            },
            "downloads": -1,
            "filename": "async_customerio-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "330cd57e7664f56e1c27782c3ae48e97",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7.15,<3.12",
            "size": 12066,
            "upload_time": "2023-08-22T09:50:22",
            "upload_time_iso_8601": "2023-08-22T09:50:22.651737Z",
            "url": "https://files.pythonhosted.org/packages/08/24/454c8866933344724c7f6639d2a9104702a1a52770a2e00290e88ce0418b/async_customerio-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8ad1d1a88c7e6d12a39bfa777ea12420b550c0aeb8b7aa81816c0bac56f06600",
                "md5": "06684329046d352cdeaf8d3f61927821",
                "sha256": "427dac434e766519f8b2def4a19482b6a2fbe4e02f438c09e3053b554705a082"
            },
            "downloads": -1,
            "filename": "async_customerio-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "06684329046d352cdeaf8d3f61927821",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7.15,<3.12",
            "size": 11083,
            "upload_time": "2023-08-22T09:50:24",
            "upload_time_iso_8601": "2023-08-22T09:50:24.676583Z",
            "url": "https://files.pythonhosted.org/packages/8a/d1/d1a88c7e6d12a39bfa777ea12420b550c0aeb8b7aa81816c0bac56f06600/async_customerio-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-22 09:50:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "healthjoy",
    "github_project": "async-customerio",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "async-customerio"
}
        
Elapsed time: 0.15142s