{
    "info": {
        "author": "Ruairi Fahy",
        "author_email": "devteam@onepagecrm.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "===============================\nOnePageCRM Python Client\n===============================\n\nConnect and interface with the OnePageCRM REST API\n\nInstallation\n============\n\n::\n\n    pip install onepagecrm\n\nUsage\n=====\n\nThe first thing to do is to set up your client\n\n.. code-block:: python\n\n    from onepagecrm import OnePageCRMAPI, RequestError, UnknownError\n    client = OnePageCRMAPI.login(username, password)\n\n    # If you don't want to store the username and password. After you have a\n    # working client you can do the following\n    user_id = client.user_id\n    api_key = client.api_key\n    # Save these for later then to create a client\n    client = OnePageCRMAPI(user_id, api_key)\n\nOnce you have your client set up you can start making requests.\n\nGetting data:\n\n.. code-block:: python\n\n    contacts = client.get('contacts')['contacts']\n\n    # Limit returned data\n    email_addresses = []\n    for contact in client.get('contacts', fields='emails', sparse=True)['contacts']:\n        emails = contact['contact'].get('emails')\n        if emails:\n            email_addresses.extend([e.get('value') for e in emails])\n\n    # Filter data\n    contacts = client.get('contacts', if_modified_since='2014-07-10')\n\n    # Paginate\n    contacts = client.get('contacts', page=2, per_page=25)\n\n    # Sorting and Ordering\n    contacts = client.get('contacts', sort_by='modified_at', order='asc')\n\n\nCreate new resources:\n\n.. code-block:: python\n\n    contact = client.post('contacts', {'first_name': 'Michael',\n                                       'last_name': 'Fitzgerald',\n                                       'company_name': 'OnePageCRM'})['contact']\n    contact_id = contact['id']\n\n    text = 'Had a meeting today in cafe 47 with Michael to discuss new features'\n    note = client.post('notes', {'text': text,\n                                 'contact_id': contact_id,\n                                 'date': '2014-07-10'})['note']\n    note_id = note['id']\n    # Partial create to autofill missing fields\n    deal = client.post('deals', {'name': 'Lunch costs',\n                                 'amount': 12.50,\n                                 'status': 'won',\n                                 'contact_id': contact_id},\n                                partial=True)['deal']\n    deal_id = deal['id']\n\n\nUpdate existing resources:\n\n.. code-block:: python\n\n    contact['background'] = 'CEO of OnePage'\n    contact = client.put('contacts', contact_id, contact)['contact']\n\n    # To do a partial update\n    update = {'background': 'CEO of OnePageCRM'}\n    contact = client.patch('contacts', contact_id, update)['contact']\n\n    # To attach a note to a deal\n    client.patch('notes', note_id, {'linked_deal_id': deal_id'})\n\nDelete resources you no longer need:\n\n.. code-block:: python\n\n    client.delete('deals', deal_id)\n    client.delete('contacts', contact_id)\n    # To undo the deletion of a contact\n    client.delete('contacts', contact_id, undo=True)\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/onepagecrm/python-client",
        "keywords": null,
        "license": "MIT",
        "maintainer": null,
        "maintainer_email": null,
        "name": "onepagecrm",
        "package_url": "https://pypi.org/project/onepagecrm/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/onepagecrm/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/onepagecrm/python-client"
        },
        "release_url": "https://pypi.org/project/onepagecrm/0.1.1/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Connect and interface with the OnePageCRM REST API",
        "version": "0.1.1"
    },
    "last_serial": 1646342,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1b0fc6cde0078313faa7ddb9e199c320",
                    "sha256": "9cf87ac3991f94da764fe72ef6b2abcfdabe0b7343246f86a79cedf383ed37e8"
                },
                "downloads": -1,
                "filename": "onepagecrm-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "1b0fc6cde0078313faa7ddb9e199c320",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5637,
                "upload_time": "2015-07-16T09:10:49",
                "url": "https://files.pythonhosted.org/packages/a9/60/6537eb2e0db46917915412a96e2307786326bc021c7e267473db066f39a4/onepagecrm-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5ab15d4155fd545ec80734253ee16736",
                    "sha256": "46e904471bcf0f4d4dd5644088938557959cc5d2d23e4c9883c5262452a57fc2"
                },
                "downloads": -1,
                "filename": "onepagecrm-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "5ab15d4155fd545ec80734253ee16736",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5665,
                "upload_time": "2015-07-23T09:49:28",
                "url": "https://files.pythonhosted.org/packages/17/2f/912354caf8b5cddc8133d60febc725ff93ed302a22942ecfe77cbf84d197/onepagecrm-0.1.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5ab15d4155fd545ec80734253ee16736",
                "sha256": "46e904471bcf0f4d4dd5644088938557959cc5d2d23e4c9883c5262452a57fc2"
            },
            "downloads": -1,
            "filename": "onepagecrm-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "5ab15d4155fd545ec80734253ee16736",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 5665,
            "upload_time": "2015-07-23T09:49:28",
            "url": "https://files.pythonhosted.org/packages/17/2f/912354caf8b5cddc8133d60febc725ff93ed302a22942ecfe77cbf84d197/onepagecrm-0.1.1.tar.gz"
        }
    ]
}