Metadata-Version: 1.1
Name: python-pipedrive
Version: 0.4.0
Summary: Light wrapper around Pipedrive API
Home-page: http://github.com/jscott1989/python-pipedrive
Author: Jonathan Scott
Author-email: jonathanscott1989@gmail.com
License: MIT
Download-URL: http://github.com/jscott1989/python-pipedrive/downloads
Description: python-pipedrive
        ================
        
        Python library for interacting with the pipedrive.com API
        
        
        This is being developed for my specific use so there's no guarantee I'll cover all of the aspects of the Pipedrive API. Feel free to add features though, I welcome pull requests.
        
        All features should be supported though as this is just a lightweight wrapper around the API.
        
        
        Usage:
        
        Create a Pipedrive object, passing either the api key or your username and password as the parameters
        
        ```python
        from pipedrive import Pipedrive
        pipedrive = Pipedrive(USERNAME, PASSSWORD)
        ```
        
        or
        
        ```python
        from pipedrive import Pipedrive
        pipedrive = Pipedrive(API_KEY)
        ```
        
        The rest of the functions relate to the URL as specified in the [API Docs](https://developers.pipedrive.com/v1).
        
        Do yourself a favor and try a few simple requests and look the raw responses to know what data Pipedrive's API gives you. This will aid in knowing how to deal with your responses in python code. For example, to find an organzation:
        
            
            curl 'https://api.pipedrive.com/v1/organizations/find?api_token=abcd1234abcd1234abcd1234abcd1234abcd1234&term=microsoft'
        
        which spits out something like:
        
            {"success":true,"data":[{"id":215,"name":"Microsoft Main Organization","visible_to":"3"},{"id":360,"name":"Microsoft Subdivision Company","visible_to":"3"}],"additional_data":{"pagination":{"start":0,"limit":100,"more_items_in_collection":false}}}
        
        
        The two things to note are the HTTP Method, and the path:
        
        Examples:
        
        1.  List the organizations
            ```python
                pipedrive.organizations(method='GET')
            ```
        
        2.  Add a New Deal
            ```python
                pipedrive.deals({
                    'title': 'Big Sucker',
                    'value': 1000000,
                    'org_id': 2045,
                    'status': 'open'
                }, method='POST')
            ```
        
        3.  Delete an Activity
            ```python
                pipedrive.activities({'id': 6789}, method='DELETE')
            ```
        
        4.  Find a person, and use the search results. The variable ```term``` is the search term that has been passed in.
            ```python
                import json
                ...
                response = pipedrive.persons_find({'term':term}, method='GET')
                results = response['data']
                suggestions = []
                if results != None:
                        for result in results:
                            suggestions.append({'value': result['name'], 'data': result})
                json_response = {'query': term, 'suggestions': suggestions}
                data = json.dumps(json_response)
        
            ```
            And return ```data``` to some kind of javascript search result autocomplete thing (this example is formatted for devbridge's simple and easy-to-use [jquery.autocomplete.js](https://github.com/devbridge/jQuery-Autocomplete))
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Framework :: Django
