Metadata-Version: 1.1
Name: WooCommerce
Version: 1.0.0
Summary: A Python wrapper for the WooCommerce REST API
Home-page: http://www.woothemes.com
Author: Claudio Sanches @ WooThemes
Author-email: UNKNOWN
License: MIT License
Description: WooCommerce API - Python Client
        ===============================
        
        A Python wrapper for the WooCommerce REST API. Easily interact with the WooCommerce REST API using this library.
        
        .. image:: https://secure.travis-ci.org/woothemes/wc-api-python.svg
            :target: http://travis-ci.org/woothemes/wc-api-python
        
        
        Installation
        ------------
        
        .. code-block:: bash
        
            pip install woocommerce
        
        Getting started
        ---------------
        
        Generate API credentials (Consumer Key & Consumer Secret) following this instructions http://docs.woothemes.com/document/woocommerce-rest-api/.
        
        Check out the WooCommerce API endpoints and data that can be manipulated in http://woothemes.github.io/woocommerce-rest-api-docs/.
        
        Setup
        -----
        
        .. code-block:: python
        
            from woocommerce import WooCommerce
        
            wcapi = woocommerce.api(
                url="http://example.com",
                consumer_key="ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
                consumer_secret="cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
            )
        
        
        Options
        ~~~~~~~
        
        +--------------------+------------+----------+-------------------------------------------------------------------------------------------------------+
        |       Option       |    Type    | Required |                                              Description                                              |
        +====================+============+==========+=======================================================================================================+
        | ``url``            | ``string`` | yes      | Your Store URL, example: http://woo.dev/                                                              |
        +--------------------+------------+----------+-------------------------------------------------------------------------------------------------------+
        | ``consumerKey``    | ``string`` | yes      | Your API consumer key                                                                                 |
        +--------------------+------------+----------+-------------------------------------------------------------------------------------------------------+
        | ``consumerSecret`` | ``string`` | yes      | Your API consumer secret                                                                              |
        +--------------------+------------+----------+-------------------------------------------------------------------------------------------------------+
        | ``version``        | ``string`` | no       | API version, default is ``v3``                                                                        |
        +--------------------+------------+----------+-------------------------------------------------------------------------------------------------------+
        | ``verify_ssl``     | ``bool``   | no       | Verify SSL when connect, use this option as ``false`` when need to test with self-signed certificates |
        +--------------------+------------+----------+-------------------------------------------------------------------------------------------------------+
        
        Methods
        -------
        
        +--------------+----------------+------------------------------------------------------------------+
        |    Params    |      Type      |                           Description                            |
        +==============+================+==================================================================+
        | ``endpoint`` | ``string``     | WooCommerce API endpoint, example: ``customers`` or ``order/12`` |
        +--------------+----------------+------------------------------------------------------------------+
        | ``data``     | ``dictionary`` | Data that will be converted to JSON                              |
        +--------------+----------------+------------------------------------------------------------------+
        
        GET
        ~~~
        
        - ``.get(endpoint)``
        
        POST
        ~~~~
        
        - ``.post(endpoint, data)``
        
        PUT
        ~~~
        
        - ``.put(endpoint, data)``
        
        DELETE
        ~~~~~~
        
        - ``.delete(endpoint)``
        
        Response
        --------
        
        All methods will return `Requests <http://docs.python-requests.org/en/latest/>`_ object.
        
        Example of returned data:
        
        .. code-block:: bash
        
            >>> woocommerce.get("products")
            >>> woocommerce.status_code
            200
            >>> woocommerce.headers['content-type']
            'application/json; charset=UTF-8'
            >>> woocommerce.encoding
            'UTF-8'
            >>> woocommerce.text
            u'{"products":[{"title":"Flying Ninja","id":70,...' // Json text
            >>> woocommerce.json()
            {u'products': [{u'sold_individually': False,... // Dictionary data
        
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development :: Libraries :: Python Modules
