{ "info": { "author": "Viktor Petersson", "author_email": "v@viktopia.io", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Software Development :: Libraries" ], "description": "Agile CRM Python library\n========================\n\nPython library for `Agile CRM`_ based on the `rest-api documentation`_.\n\nStatus\n------\n\nWe use this in production for `Screenly`_, and it works fine. Still a\nbit rough around the corners, but it does indeed work.\n\nInstallation\n------------\n\nClone the repo as a sub-module inside your project.\n\nInstall the Python requirements.\n\n::\n\n $ pip install agilecrm\n\nConfiguration\n-------------\n\nIn order to use the module, you need to set the following environment\nvariables:\n\n- AGILECRM\\_APIKEY\n- AGILECRM\\_EMAIL\n- AGILECRM\\_DOMAIN\n\nUsage\n-----\n\nFirst, you need to import the module. This may vary depending on your\npaths etc, but something like:\n\n::\n\n import agilecrm\n\nCreating a user\n~~~~~~~~~~~~~~~\n\nSimply create a new user. Despite what is claimed in the documentation,\nall variables appear to be optional.\n\n::\n\n agilecrm.create_contact(\n first_name='John',\n last_name='Doe',\n email='john@doe.com',\n tags=['signed_up'],\n company='Foobar Inc')\n\nYou can also use custom fields (must be created in Agile CRM first):\n\n::\n\n agilecrm.create_contact(\n first_name='John',\n custom = {\n 'SomeField': 'Foobar'\n }\n\nUpdate a contact\n~~~~~~~~~~~~~~~~\n\nUpdate a user object.\n\n::\n\n agilecrm.update_contact(\n first_name='Steve',\n last_name='Smith',\n email='john@doe.com',\n tags=['name_updated'],\n company='Foobar2 Inc')\n\nGet a user (by email)\n---------------------\n\nThis will get the user by email and return the user object as JSON.\n\n::\n\n agilecrm.get_contact_by_email('john@doe.com')\n\nGet a user (by UUID)\n--------------------\n\nThis will get the user by UUID and return the user object as JSON.\n\n::\n\n agilecrm.get_contact_by_uuid(1234)\n\nAdd a tag\n---------\n\nThis will add the tag \u2018awesome\\_user\u2019 to the user \u2018john@doe.com\u2019. Both\nvariables are required.\n\n::\n\n agilecrm.add_tag('john@doe.com', 'awesome_user')\n\n.. _Agile CRM: https://www.agilecrm.com/\n.. _rest-api documentation: https://github.com/agilecrm/rest-api\n.. _Screenly: https://www.screenly.io\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/vpetersson/py-agilecrm", "keywords": "library crm development", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "agilecrm", "package_url": "https://pypi.org/project/agilecrm/", "platform": "", "project_url": "https://pypi.org/project/agilecrm/", "project_urls": { "Homepage": "https://github.com/vpetersson/py-agilecrm" }, "release_url": "https://pypi.org/project/agilecrm/0.0.3/", "requires_dist": [ "requests (>=2.10.0)", "check-manifest; extra == 'dev'", "coverage; extra == 'test'" ], "requires_python": "", "summary": "A python client for AgileCRM", "version": "0.0.3" }, "last_serial": 2483046, "releases": { "0.0.3": [ { "comment_text": "", "digests": { "md5": "f7d585de498c395196a365d66c885892", "sha256": "69192be85be995da73d3d48355b03f30e72d552e92b5851c0bf03dd7a0cd8beb" }, "downloads": -1, "filename": "agilecrm-0.0.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f7d585de498c395196a365d66c885892", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5906, "upload_time": "2016-11-25T17:59:02", "url": "https://files.pythonhosted.org/packages/c5/ca/b4e0f532784ba470e9c4daef33975edbcbea522aa8f628967682e9ed7f7b/agilecrm-0.0.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "73136d9cee95e455eabbbb15c55a0ac8", "sha256": "51c519d30aca52f4abfc899cad6570e77eaddb129c24d36b043d5a95e53535b1" }, "downloads": -1, "filename": "agilecrm-0.0.3.tar.gz", "has_sig": false, "md5_digest": "73136d9cee95e455eabbbb15c55a0ac8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4913, "upload_time": "2016-11-25T17:59:04", "url": "https://files.pythonhosted.org/packages/cc/58/5b9ecbc52da702ccc74b0d08a208e227dfe658b40d257223ab8ae3c0e0b5/agilecrm-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f7d585de498c395196a365d66c885892", "sha256": "69192be85be995da73d3d48355b03f30e72d552e92b5851c0bf03dd7a0cd8beb" }, "downloads": -1, "filename": "agilecrm-0.0.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f7d585de498c395196a365d66c885892", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5906, "upload_time": "2016-11-25T17:59:02", "url": "https://files.pythonhosted.org/packages/c5/ca/b4e0f532784ba470e9c4daef33975edbcbea522aa8f628967682e9ed7f7b/agilecrm-0.0.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "73136d9cee95e455eabbbb15c55a0ac8", "sha256": "51c519d30aca52f4abfc899cad6570e77eaddb129c24d36b043d5a95e53535b1" }, "downloads": -1, "filename": "agilecrm-0.0.3.tar.gz", "has_sig": false, "md5_digest": "73136d9cee95e455eabbbb15c55a0ac8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4913, "upload_time": "2016-11-25T17:59:04", "url": "https://files.pythonhosted.org/packages/cc/58/5b9ecbc52da702ccc74b0d08a208e227dfe658b40d257223ab8ae3c0e0b5/agilecrm-0.0.3.tar.gz" } ] }