{
"info": {
"author": "https://github.com/waveaccounting/vero-python/graphs/contributors",
"author_email": "opensource@waveaccounting.com",
"bugtrack_url": null,
"classifiers": [],
"description": "vero: Python client for Vero\n============================\n\n.. image:: https://circleci.com/gh/waveaccounting/vero-python.svg?style=svg\n :target: https://circleci.com/gh/waveaccounting/vero-python\n :alt: Circle CI\n\n.. image:: https://readthedocs.org/projects/pip/badge/?version=latest\n :target: https://vero.readthedocs.org/en/latest/\n :alt: Read the Docs\n\nFull documentation can be found on `ReadTheDocs `_\n\nVero is an API wrapper for event logging in your Python application.\nFetch your auth token from your `Vero `_ account and use the python interface instead of `API `_ web hooks.\n::\n\n >>> from vero import VeroEventLogger\n >>> logger = VeroEventLogger(auth_token)\n >>> user_id = 42\n >>> user_data = {\n 'full_name': 'Jane Doe'\n }\n >>> response = logger.add_user(user_id, user_data)\n >>> response.status_code\n 200\n\nFeatures\n--------\n\nModify user data and log events. Run in live or test mode.\n\n- Add user\n- Delete user\n- Edit user\n- Add user tags\n- Remove user tags\n- Unsubscribe user\n- Resubscribe user\n- Add event\n- Check heartbeat\n\nInstallation\n------------\nInstall the package from PyPI\n::\n\n pip install vero\n\nRun Tests\n------------\nRun Tests from command line.\n::\n\n VERO_AUTH_TOKEN=[ Your Token here ] python setup.py test\n\nUsage\n-----\n\nCreate instance\n~~~~~~~~~~~~~~~\nUse the authorization token from your Vero account page to create a VeroEventLogger object.\n::\n\n >>> from vero import VeroEventLogger\n >>> auth_token = \"foobar\"\n >>> logger = VeroEventLogger(auth_token)\n\nAfter creating an instance of VeroEventLogger as ``logger`` use any of the following methods to access Vero.\n\nAdd user\n~~~~~~~~\nCreate a new user with the information in ``user_data``. ``user_email`` is optional but is needed to trigger emails to the user.\n::\n\n >>> user_id = 1\n >>> user_email = 'johndoe@example.com'\n >>> user_data = {\n 'first name': 'John',\n 'last name': 'Doe'\n }\n >>> logger.add_user(user_id, user_data, user_email=user_email)\n\nEdit user\n~~~~~~~~~\nAdd or change fields in ``user_data`` for the user.\n::\n\n >>> user_id = 1\n >>> user_data = {\n 'first name': 'Jane'\n }\n >>> logger.edit_user(user_id, user_data)\n\nAdd user tags\n~~~~~~~~~~~~~\nAdd each tag in ``tag_list`` to the user.\n::\n\n >>> user_id = 1\n >>> tag_list = ['blue', 'red', 'yellow']\n >>> logger.add_tags(user_id, tag_list)\n\nRemove user tags\n~~~~~~~~~~~~~~~~\nRemove each tag in ``tag_list`` from the user.\n::\n\n >>> user_id = 1\n >>> tag_list = ['yellow']\n >>> logger.remove_tags(user_id, tag_list)\n\nUnsubscribe user\n~~~~~~~~~~~~~~~~\nUnsubscribe the user from triggering future events.\n::\n\n >>> user_id = 1\n >>> logger.unsubscribe_user(user_id)\n\nResubscribe user\n~~~~~~~~~~~~~~~~\nResubscribe the user to allow triggering future events.\n::\n\n >>> user_id = 1\n >>> logger.resubscribe_user(user_id)\n\nAdd event\n~~~~~~~~~\nNote: adding an event with a user id that doesn't exist will create the user.\n\nEvent data can contain whatever fields are needed.\n::\n\n >>> user_id = 2\n >>> user_email = 'janedoe@example.com'\n >>> event_name = 'Visited Website'\n >>> event_data = {\n 'date': 'today',\n 'visited': 'front page'\n }\n >>> logger.add_event(event_name, event_data, user_id, user_email=user_email)\n\nRe-identify a user\n~~~~~~~~~~~~~\nChange a user's ``identifier`` (or ID) in Vero. This method accept their current (old) ``identifier`` and the ``identifier`` to replace it.\n::\n\n >>> user_id = 1\n >>> new_user_id = 2 \n >>> logger.reidentify_user(user_id, new_user_id)\n\nDelete user\n~~~~~~~~~~~~~~~~\nDelete the user\n::\n\n >>> user_id = 1\n >>> logger.delete_user(user_id)",
"description_content_type": null,
"docs_url": null,
"download_url": "UNKNOWN",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/waveaccounting/vero-python",
"keywords": null,
"license": "BSD Simplified\n\nCopyright (c) 2013 Wave Accounting Inc., All rights reserved.\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\nRedistributions of source code must retain the above copyright notice, this list of conditions and the following\ndisclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and\nthe following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name\nof the nor the names of its contributors may be used to endorse or promote products derived from this software\nwithout specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\nMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;\nOR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\nOR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED\nOF THE POSSIBILITY OF SUCH DAMAGE.",
"maintainer": null,
"maintainer_email": null,
"name": "vero",
"package_url": "https://pypi.org/project/vero/",
"platform": "UNKNOWN",
"project_url": "https://pypi.org/project/vero/",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "https://github.com/waveaccounting/vero-python"
},
"release_url": "https://pypi.org/project/vero/2.0.1/",
"requires_dist": null,
"requires_python": null,
"summary": "Python wrapper for Vero API",
"version": "2.0.1"
},
"last_serial": 2723823,
"releases": {
"1.1.0": [
{
"comment_text": "",
"digests": {
"md5": "6d8cf8c57616b2dbe8a0c8bbb3e7d34d",
"sha256": "bc6a5e1117681d75b40b77fcbd85cd693484cbaeac987a2a648a2db943832f25"
},
"downloads": -1,
"filename": "vero-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "6d8cf8c57616b2dbe8a0c8bbb3e7d34d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4032,
"upload_time": "2013-06-28T22:15:05",
"url": "https://files.pythonhosted.org/packages/fc/02/6d74d6411ee1083bf880faddeed581552598797bb58d68047221e3fda85e/vero-1.1.0.tar.gz"
}
],
"1.1.1": [
{
"comment_text": "",
"digests": {
"md5": "24531722f5cbfcd003d5f2236b8d6e71",
"sha256": "2963ead6ac98405ba2c72491d746f7ed7a18a0e64df91c958b9cd8561d5eb8f7"
},
"downloads": -1,
"filename": "vero-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "24531722f5cbfcd003d5f2236b8d6e71",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4158,
"upload_time": "2013-07-02T16:12:53",
"url": "https://files.pythonhosted.org/packages/c7/91/1af26b8cf9f5d690b50efab0fec1fdfcad1c073189ba691eac905add7181/vero-1.1.1.tar.gz"
}
],
"1.1.2": [
{
"comment_text": "",
"digests": {
"md5": "0b872c6c4720133bd716b02c58ef90c4",
"sha256": "547d50bc185a2a9c6ae09b4ebdcf92897ccdea55a974df64a5bf4e9cfe7f606f"
},
"downloads": -1,
"filename": "vero-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "0b872c6c4720133bd716b02c58ef90c4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4363,
"upload_time": "2013-07-02T16:22:57",
"url": "https://files.pythonhosted.org/packages/d8/47/54fa343ef3e2aff2c3254e38251675ab5cdb4d53c12c0c59d7859d854dd0/vero-1.1.2.tar.gz"
}
],
"1.1.3": [
{
"comment_text": "",
"digests": {
"md5": "c3ccf2edc1336c0c270bf286aad474db",
"sha256": "f41107df5dcb45e058679f2739bb5c7e3a9d8c80a16f1c28d1e93f9eddde8a47"
},
"downloads": -1,
"filename": "vero-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "c3ccf2edc1336c0c270bf286aad474db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4539,
"upload_time": "2013-07-11T15:09:56",
"url": "https://files.pythonhosted.org/packages/af/c8/5a67e39931c1c51d72aff4cb064a87e23fbabff6c37f364a9ffb7450f1c0/vero-1.1.3.tar.gz"
}
],
"1.1.4": [
{
"comment_text": "",
"digests": {
"md5": "42d29b96b32046d513d18d2efb4678e4",
"sha256": "8cd65cef87f5dab34cba1a8823af7c11b597c47bdda8e75bcae525e1556c8eac"
},
"downloads": -1,
"filename": "vero-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "42d29b96b32046d513d18d2efb4678e4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4558,
"upload_time": "2015-06-05T15:37:10",
"url": "https://files.pythonhosted.org/packages/be/49/4657954cea35639e48bd9b08d36180046f5245f4195977a21bcafe9f4686/vero-1.1.4.tar.gz"
}
],
"1.3.0": [
{
"comment_text": "",
"digests": {
"md5": "ea7bb2edcc538d7713c16e777bb22fda",
"sha256": "57f9e164743767eacc354bd8c34acbd04aa59a849eae8d1c60e56125febc6015"
},
"downloads": -1,
"filename": "vero-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "ea7bb2edcc538d7713c16e777bb22fda",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5161,
"upload_time": "2015-09-18T20:09:43",
"url": "https://files.pythonhosted.org/packages/5a/65/da6cf89efaab8e2795b540a2cf4abb2d2940198096d912d1d3e34cfd1b95/vero-1.3.0.tar.gz"
}
],
"2.0.0": [
{
"comment_text": "",
"digests": {
"md5": "2e6b808c29ad80e1ab5692149f790a03",
"sha256": "8f9e0b070bf8e2634dc4177f6dbc12242607691d183e8e3b8892d52b06ada726"
},
"downloads": -1,
"filename": "vero-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "2e6b808c29ad80e1ab5692149f790a03",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5394,
"upload_time": "2016-03-01T02:20:12",
"url": "https://files.pythonhosted.org/packages/80/8b/93fe3fa7e3cc65499bd14f3dcfc7f56c14fead843a7b0edd4f67b49f0f9c/vero-2.0.0.tar.gz"
}
],
"2.0.1": [
{
"comment_text": "",
"digests": {
"md5": "8054337cb06908a211e56ef9ee79b609",
"sha256": "ccd0d1ea1b32adec383029de48927c989d8b770a33b78466b853bcfcbc1e5dc7"
},
"downloads": -1,
"filename": "vero-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8054337cb06908a211e56ef9ee79b609",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5428,
"upload_time": "2017-03-22T17:47:45",
"url": "https://files.pythonhosted.org/packages/45/27/5dc555227de8a1e82fff614ce70787806891cd871f26783e62c6c2fdaa89/vero-2.0.1.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "8054337cb06908a211e56ef9ee79b609",
"sha256": "ccd0d1ea1b32adec383029de48927c989d8b770a33b78466b853bcfcbc1e5dc7"
},
"downloads": -1,
"filename": "vero-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8054337cb06908a211e56ef9ee79b609",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5428,
"upload_time": "2017-03-22T17:47:45",
"url": "https://files.pythonhosted.org/packages/45/27/5dc555227de8a1e82fff614ce70787806891cd871f26783e62c6c2fdaa89/vero-2.0.1.tar.gz"
}
]
}