Metadata-Version: 2.1
Name: python-cmixapi-client
Version: 0.1.1
Summary: A Python client for the Cmix API.
Home-page: https://github.com/dynata/python-cmixapi-client
Author: Bradley Wogsland
Author-email: bradley@wogsland.org
License: UNKNOWN
Description: # python-cmixapi-client
        
        [![PyPI version](https://badge.fury.io/py/python-cmixapi-client.svg)](https://pypi.org/project/python-cmixapi-client/)
        
        <a href="https://github.com/dynata/python-cmixapi-client/actions"><img alt="GitHub Actions status" src="https://github.com/dynata/python-cmixapi-client/workflows/python-tests/badge.svg"></a>
        
        A Python client library for the [Dynata Cmix API](https://wiki2.criticalmix.net/display/CA/Getting+started).
        
        ## Setup
        
            Something here
        rename src directory to facilitate library usage & improve documentation
        ## Example Usage
        
            cmix = CmixAPI(
                username="test_username",
                password="test_password",
                client_id="test_client_id",
                client_secret="test_client_secret"
            )
            cmix.authenticate()
            surveys = cmix.get_surveys('closed')
        
        ## Supported API Functions
        
            authenticate(*args, **kwargs)
            fetch_banner_filter(survey_id, question_a, question_b, response_id)
            fetch_raw_results(survey_id, payload)
            get_surveys(status, *args, **kwargs)
            get_survey_definition(survey_id)
            get_survey_xml(survey_id)
            get_survey_test_url(survey_id)
            get_survey_respondents(survey_id, respondent_type, live)
            get_survey_status(survey_id)
            get_survey_completes(survey_id)
            create_export_archive(survey_id, export_type)
            get_archive_status(survey_id, archive_id, layout_id)
            update_project(project_id, status=None)
            create_survey(xml_string)
        
        ## Contributing
        
        Information on [contributing](https://github.com/dynata/python-cmixapi-client/blob/dev/CONTRIBUTING.md) to this python library.
        
        ## Testing
        
        To run the tests,
        
            virtualenv venv
            . venv/bin/activate
            pip install -r requirements.txt
            pytest
            deactivate
        
        to run the tests for this project.
        
Keywords: cmix api dynata popresearch
Platform: Any
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
