Metadata-Version: 1.0
Name: sugarcrm-python
Version: 0.1.5
Summary: API wrapper for SugarCRM written in Python
Home-page: https://github.com/GearPlug/sugarcrm-python
Author: Miguel Ferrer
Author-email: ingferrermiguel@gmail.com
License: MIT
Description: # sugarcrm-python
        Sugar CRM API wrapper written in python.
        
        ## Installing
        ```
        pip install sugarcrm-python
        ```
        
        ## Usage
        ```
        from sugarcrm.client import Client
        
        client = Client('SERVER_URL', 'USERNAME', 'PASSWORD')
        ```
        
        Get available modules
        ```
        client.get_available_modules('MODULE_NAME')
        ```
        
        Get entries
        ```
        client.get_entries('MODULE_NAME', ['ENTRY_ID'])
        ```
        
        Get entries count
        ```
        client.get_entries_count('MODULE_NAME')
        ```
        
        Get entry
        ```
        client.get_entries_count('MODULE_NAME', 'ENTRY_ID')
        ```
        
        Get entry list
        ```
        client.get_entry_list('MODULE_NAME')
        ```
        
        Get module fields
        ```
        client.get_module_fields('MODULE_NAME')
        ```
        
        Search by module
        ```
        client.search_by_module('SEARCH_STRING', ['MODULE_NAMES'])
        ```
        
        Get relationships
        ```
        client.get_relationships('MODULE_NAME', 'ENTRY_ID', 'RELATIONSHIP_NAME', 'WHERE_CLAUSE', 'RELATED_MODULE_FIELDS', 'RELATED_MODULE_LINK_FIELDS')
        ```
        
        Set relationship
        ```
        client.set_relationship('SOURCE_MODULE_NAME', 'SOURCE_ENTRY_ID', 'TARGET_MODULE', ['TARGET_IDS'])
        ```
        
        Set note attachment
        ```
        client.set_note_attachment('NOTE_ID', 'FILENAME', 'FILECONTENT')
        ```
        
        ## Requirements
        - requests
        
        ## Tests
        ```
        python tests/test_client.py
        ```
        
        ## TODO
        - get_document_revision
        - get_language_definition
        - get_last_viewed
        - get_modified_relationships
        - get_module_fields_md5
        - get_module_layout
        - get_module_layout_md5
        - get_note_attachment
        - get_quotes_pdf
        - get_report_entries
        - get_report_pdf
        - get_server_info
        - get_upcoming_activities
        - get_user_id
        - get_user_team_id
        - job_queue_cycle
        - job_queue_next
        - job_queue_run
        - logout
        - oauth_access
        - seamless_login
        - set_campaign_merge
        - set_document_revision
        - set_relationships
        - snip_import_emails
        - snip_update_contacts
        
        ## Contributing
        We are always grateful for any kind of contribution including but not limited to bug reports, code enhancements, bug fixes, and even functionality suggestions.
        
        #### You can report any bug you find or suggest new functionality with a new [issue](https://github.com/GearPlug/sugarcrm-python/issues).
        
        #### If you want to add yourself some functionality to the wrapper:
        1. Fork it ( https://github.com/GearPlug/sugarcrm-python )
        2. Create your feature branch (git checkout -b my-new-feature)
        3. Commit your changes (git commit -am 'Adds my new feature')
        4. Push to the branch (git push origin my-new-feature)
        5. Create a new Pull Request
        
Platform: UNKNOWN
