Metadata-Version: 1.1
Name: mixnode-py-sdk
Version: 1.0.2
Summary: Mixnode Python SDK
Home-page: https://github.com/Mixnode/mixnode-py-sdk
Author: Mixnode Technologies Inc.
Author-email: devsteelcoder@gmail.com
License: UNKNOWN
Download-URL: https://github.com/Mixnode/mixnode-py-sdk
Description: Mixnode Python SDK
        ==================
        
        Overview
        --------
        
        The Mixnode `Python <https://www.python.org/>`__ SDK allows you to
        easily integrate the Mixnode REST APIs into your Python application.
        
        Requirements
        ~~~~~~~~~~~~
        
        -  Python2 and above.
        -  A Mixnode API key from a registered user on the `Mixnode
           portal <https://www.mixnode.com/account/api>`__.
        
        Installation
        ~~~~~~~~~~~~
        
        .. code:: sh
        
            pip install mixnode-py-sdk
        
        Tutorial
        --------
        
        Follow this tutorial to see a step-by-step guide and examples of how to
        use the Mixnode Python SDK.
        
        Get the API key from Mixnode portal
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        -  Create an account on `Mixnode <https://www.mixnode.com/signup>`__.
        -  If already registered, then login and navigate to api key page.
        -  Dashboard -> Choose API from left menu -> Note the API key.
        -  Or, directly navigate to https://www.mixnode.com/account/api to find
           your API key.
        
        Authentication
        ~~~~~~~~~~~~~~
        
        This SDK comes with Basic Authentication over HTTPS which requires you
        to pass your Mixnode API key using a config file or as a string during
        client instantiation.
        
        Basic Authentication
        ^^^^^^^^^^^^^^^^^^^^
        
        This type of token is given directly to the application.
        
        .. code:: Python
        
            from mixnode import Mixnode
        
            # Create an instance of the Mixnode Client
            client = Mixnode("Your API Key") #add your API KEY here; available at https://www.mixnode.com/account/api
        
        Note that ``api_key`` can also be passed as a JSON object in a config
        file to avoid specifying the key in the code. Please see
        `Examples <https://github.com/Mixnode/mixnode-py-sdk/blob/master/examples>`__
        
        Quick Start
        ^^^^^^^^^^^
        
        .. code:: Python
        
            from mixnode import Mixnode, MixnodeError
            try:
                query = "SELECT url, title from homepages LIMIT 10"
                response = Mixnode("Your API Key").execute(query)
                print(response)
            except MixnodeError as error:
                print(error)
        
        Mixnode's execute functionality
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        ``execute`` is a synchronous operation which builds response based on
        paging Mixnode SQL API.
        
        execute can accept upto two parameters : query, inputLimit (optional).
        ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
        
        Please see various
        `Examples <https://github.com/Mixnode/mixnode-py-sdk/blob/master/examples>`__
        for usage details.
        
        .. code:: Python
        
            from mixnode import Mixnode, MixnodeError
            try:
             response = Mixnode("Your API Key").execute(query)
             # Do something with response
            except MixnodeError as error:
             # Do something with error
        
        .. code:: Python
        
            from mixnode import Mixnode, MixnodeError
            try:
             # Fires a query and also sets the input limit on the data to be scanned
             response = Mixnode("Your API Key").execute(query, inputLimit)
             # Do something with response
            except MixnodeError as error:
             # Do something with error
        
        SDK debugging
        ^^^^^^^^^^^^^
        
        Turning on the debug mode logs the HTTP requests being sent to the
        Mixnode API. This is useful to verify if the queries being sent are
        correct or to verify if query execution is in progress.
        
        .. code:: Python
        
            # Setting debug to true logs the state of the application.
            # Do not use this in production.
            Mixnode("Your API Key").setDebug(True);
        
        Examples: Mixnode Python Client
        -------------------------------
        
        `Examples <https://github.com/Mixnode/mixnode-py-sdk/tree/master/examples>`__
        
        Support
        -------
        
        hi@mixnode.com
        
Platform: UNKNOWN
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
