Metadata-Version: 1.1
Name: WixInstance
Version: 1.0.0
Summary: This package is used to parse the Wix Instance in the backend of a Wix application.
Home-page: https://github.com/jeffreychan637/wix-instance
Author: Jeffrey Chan
Author-email: UNKNOWN
License: MIT
Description: ============
        Wix Instance
        ============
        
        .. image:: https://travis-ci.org/jeffreychan637/wix-instance.svg?branch=master
           :target: https://travis-ci.org/jeffreychan637/wix-instance
        
        This is a Python package that parses the `Wix Instance`_ for `Wix`_ applications
        that use a Python backend. This packages supports **Python 2.7**. 
        
        In your Wix app, send the unparsed instance along with each request from the
        client side to your server. On the server, use this package to verify that the
        instance actually came from Wix to guarentee that the request is valid.
        
        .. _Wix Instance: http://dev.wix.com/docs/display/DRAF/Using+the+Signed+App+Instance
        .. _Wix: http://www.wix.com/
        
        Installation
        ============
        
        This package is available on `Pypi`_. Install via `pip`_.
        
        .. _Pypi: https://pypi.python.org/pypi
        .. _pip: http://pip.readthedocs.org/en/latest/index.html
        
        ::
        
            pip install wixinstance
        
        Usage
        =====
        
        ::
        
            import wixinstance
        
            #Get the instance ID. 
            instance_ID = wixinstance.get_instance_ID(YOUR_APP_SECRET, INSTANCE, check_owner)
            if instance_ID:
                #process the request because it is valid
            else:
                #reject the request because it is invalid
        
            #Get the entire parsed instance object
            parsed_instance = wixinstance.instance_parser(YOUR_APP_SECRET, INSTANCE)
            if parsed_instance:
                #process the request because it is valid
            else:
                #reject the request because it is invalid
        
        Documentation
        =============
        
        **get_instance_ID**
        
        Use this function when you need the instance ID of the parsed instance. The
        instance ID is returned as a Unicode string.
        
        The function takes in a third argument called check_owner which is a boolean
        that tells the function whether or not to check if the instance was generated
        by the owner of the site or a site visitor. Use this to verify requests that
        only the owner of a site can make (e.g. changing app settings).
        
        The function returns false if the instance is invalid or if the instance was
        not generated by the site owner (assuming site_owner is set to True).
        
        **instance_parser**
        
        Use this function when you want the entire parsed instance. The parsed
        instance is returned as a dictionary. The keys to the dictionary are equivalent
        to the Instance properties in the `Wix Documentation`_.
        
        .. _Wix Documentation: http://dev.wix.com/docs/display/DRAF/Using+the+Signed+App+Instance
        
        Support
        =======
        
        File issues with this package `here`_.
        
        Feel free to contribute to this package by making a `pull request`_ on Github.
        
        .. _here: https://github.com/jeffreychan637/wix-instance/issues
        .. _pull request: https://github.com/jeffreychan637/wix-instance/pulls
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2.7
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
