{ "info": { "author": "Max Naude", "author_email": "maxnaude@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Internet :: WWW/HTTP :: Site Management", "Topic :: Office/Business", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "pardot-api-client\n==================\n\nA Python client for the Pardot API.\n\nIt provides object notation for interacting with resources on the API in clean and simple idiomatic statements like:\n\n.. code-block:: python\n\n >>> client.prospect.read('someone@example.com')\n >>> client.prospect.update('someone@example.com', first_name='John')\n\n\nFeatures\n--------\n\n* Supports Python 2 and 3\n* Supports API version 3\n* Supports all API entities: Account, Campaign, Custom Field, Custom Redirect, Dynamic Content, Email, Email Clicks, Form, Identified Company, Lifecycle History, Lifecycle Stage, List, List Membership, Opportunity, Profile, Profile Criteria, Prospect, Prospect Account, Tag, Tag Object, User, Visit, Visitor, Visitor Activity, Visitor Page View, Visitor Referrer\n* Supports most API operations: query, assign, unassign, create, read, update, upsert, delete\n* Supports un-setting of field values\n* Handles API session timeouts implicitly\n* Transparent API error feedback\n* Optional request retries with incremental back-off\n\n\nPlanned features\n----------------\n\n* Support for API version 4\n* Support for API batch operations: batchCreate, batchUpdate, batchUpsert\n* Supports result set manipulation, eg specifying fields, limit, offset, sort_by, sort_order\n* Implicit results pagination\n* Implicit chunking for batch operationss\n\n\nInstallation\n------------\n\n.. code-block:: bash\n\n $ pip install pardot-api-client\n\n\nUsage\n-----\n\n1. Obtain API authentication credentials from Pardot by following instructions at http://developer.pardot.com/#authentication - you'll need the following: email, password, user_key\n2. Review the supported Pardot API documentation at http://developer.pardot.com/#official-pardot-api-documentation\n3. Use the Python API client to interact with the API:\n\n .. code-block:: python\n\n >>> from pardot.client import APIClient\n >>> client = APIClient(\n ... 'pardot-email',\n ... 'pardot-password',\n ... 'pardot-user_key')\n ...\n >>> # read\n >>> r = client.prospect.read('someone@example.com')\n >>> print(r)\n >>> # update\n >>> r = client.prospect.update('someone@example.com', first_name='John')\n >>> print(r)\n >>> # query\n >>> for r in client.prospect.query(new=True):\n ... print(r)\n ...\n\n\nArguments vs keyword arguments\n------------------------------\n\nTo keep the client's API simple it makes educated guesses about the identifiers passed in resource operation calls.\n\nTo make this work all required parameters (except user_key and api_key, which are automatically added) must be passed as positional arguments and any optional parameters passed as keyword arguments.\n\nFor instance, the API documentation states that \"assign\" operations on \"prospect\" resources may use either \"email\" or \"id\" as identifiers and must supply one of the following parameters: \"user_email\" or \"user_id\" or \"group_id\". Any of the forms below could be used to make this call from the client:\n\n.. code-block:: python\n\n >>> # identify by email\n >>> client.prospect.update('someone@example.com', user_email='someone-else@example.com')\n >>> client.prospect.update('someone@example.com', user_id=2544897)\n >>> client.prospect.update('someone@example.com', group_id=5499876)\n >>> # identify by id\n >>> client.prospect.update(7142577, user_email='someone-else@example.com')\n >>> client.prospect.update(7142577, user_id=2544897)\n >>> client.prospect.update(7142577, group_id=5499876)\n\n\n\n", "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/maxnaude/pardot-api-client", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "pardot-api-client", "package_url": "https://pypi.org/project/pardot-api-client/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/pardot-api-client/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/maxnaude/pardot-api-client" }, "release_url": "https://pypi.org/project/pardot-api-client/0.0.1/", "requires_dist": null, "requires_python": null, "summary": "Pardot API Client", "version": "0.0.1" }, "last_serial": 2594201, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "c6282d05278b68b12978ef891476640f", "sha256": "3eaa54abeb5a1ae75175ff7f06d8039685467643ba53cddd5bcc9c1d3d2cfa22" }, "downloads": -1, "filename": "pardot_api_client-0.0.1-py2-none-any.whl", "has_sig": false, "md5_digest": "c6282d05278b68b12978ef891476640f", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 7932, "upload_time": "2017-01-24T00:35:23", "url": "https://files.pythonhosted.org/packages/58/71/55e7dd9c272e9bc8334bbe6272c393b18e271f5ecef0aebee2098ca2b152/pardot_api_client-0.0.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f479de9493d39cd8afc6df002988899c", "sha256": "85ce982bc394a84e5d3af426892806da8d8a00d6442693745a994d4fc26e8398" }, "downloads": -1, "filename": "pardot-api-client-0.0.1.tar.gz", "has_sig": false, "md5_digest": "f479de9493d39cd8afc6df002988899c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6674, "upload_time": "2017-01-24T00:35:20", "url": "https://files.pythonhosted.org/packages/b7/f3/cc50e5bba39facc88a7a12fb2119a735af0b8c2aa65e98eff3eef8b60bd0/pardot-api-client-0.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c6282d05278b68b12978ef891476640f", "sha256": "3eaa54abeb5a1ae75175ff7f06d8039685467643ba53cddd5bcc9c1d3d2cfa22" }, "downloads": -1, "filename": "pardot_api_client-0.0.1-py2-none-any.whl", "has_sig": false, "md5_digest": "c6282d05278b68b12978ef891476640f", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 7932, "upload_time": "2017-01-24T00:35:23", "url": "https://files.pythonhosted.org/packages/58/71/55e7dd9c272e9bc8334bbe6272c393b18e271f5ecef0aebee2098ca2b152/pardot_api_client-0.0.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f479de9493d39cd8afc6df002988899c", "sha256": "85ce982bc394a84e5d3af426892806da8d8a00d6442693745a994d4fc26e8398" }, "downloads": -1, "filename": "pardot-api-client-0.0.1.tar.gz", "has_sig": false, "md5_digest": "f479de9493d39cd8afc6df002988899c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6674, "upload_time": "2017-01-24T00:35:20", "url": "https://files.pythonhosted.org/packages/b7/f3/cc50e5bba39facc88a7a12fb2119a735af0b8c2aa65e98eff3eef8b60bd0/pardot-api-client-0.0.1.tar.gz" } ] }