Metadata-Version: 1.1
Name: agilecrm
Version: 0.0.3
Summary: A python client for AgileCRM
Home-page: https://github.com/vpetersson/py-agilecrm
Author: Viktor Petersson
Author-email: v@viktopia.io
License: BSD
Description: Agile CRM Python library
        ========================
        
        Python library for `Agile CRM`_ based on the `rest-api documentation`_.
        
        Status
        ------
        
        We use this in production for `Screenly`_, and it works fine. Still a
        bit rough around the corners, but it does indeed work.
        
        Installation
        ------------
        
        Clone the repo as a sub-module inside your project.
        
        Install the Python requirements.
        
        ::
        
            $ pip install agilecrm
        
        Configuration
        -------------
        
        In order to use the module, you need to set the following environment
        variables:
        
        -  AGILECRM\_APIKEY
        -  AGILECRM\_EMAIL
        -  AGILECRM\_DOMAIN
        
        Usage
        -----
        
        First, you need to import the module. This may vary depending on your
        paths etc, but something like:
        
        ::
        
            import agilecrm
        
        Creating a user
        ~~~~~~~~~~~~~~~
        
        Simply create a new user. Despite what is claimed in the documentation,
        all variables appear to be optional.
        
        ::
        
            agilecrm.create_contact(
                first_name='John',
                last_name='Doe',
                email='john@doe.com',
                tags=['signed_up'],
                company='Foobar Inc')
        
        You can also use custom fields (must be created in Agile CRM first):
        
        ::
        
            agilecrm.create_contact(
                first_name='John',
                custom = {
                  'SomeField': 'Foobar'
                }
        
        Update a contact
        ~~~~~~~~~~~~~~~~
        
        Update a user object.
        
        ::
        
            agilecrm.update_contact(
                first_name='Steve',
                last_name='Smith',
                email='john@doe.com',
                tags=['name_updated'],
                company='Foobar2 Inc')
        
        Get a user (by email)
        ---------------------
        
        This will get the user by email and return the user object as JSON.
        
        ::
        
            agilecrm.get_contact_by_email('john@doe.com')
        
        Get a user (by UUID)
        --------------------
        
        This will get the user by UUID and return the user object as JSON.
        
        ::
        
            agilecrm.get_contact_by_uuid(1234)
        
        Add a tag
        ---------
        
        This will add the tag ‘awesome\_user’ to the user ‘john@doe.com’. Both
        variables are required.
        
        ::
        
            agilecrm.add_tag('john@doe.com', 'awesome_user')
        
        .. _Agile CRM: https://www.agilecrm.com/
        .. _rest-api documentation: https://github.com/agilecrm/rest-api
        .. _Screenly: https://www.screenly.io
        
Keywords: library crm development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
