<commit_before>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="<KEY>",
        consumer_secret="<KEY>"
    )


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<commit_msg>Fixed examples on README.rst<commit_after>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 API

    wcapi = API(
        url="http://example.com",
        consumer_key="<KEY>",
        consumer_secret="<KEY>"
    )


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

    >>> wcapi.get("products")
    >>> wcapi.status_code
    200
    >>> wcapi.headers['content-type']
    'application/json; charset=UTF-8'
    >>> wcapi.encoding
    'UTF-8'
    >>> wcapi.text
    u'{"products":[{"title":"Flying Ninja","id":70,...' // Json text
    >>> wcapi.json()
    {u'products': [{u'sold_individually': False,... // Dictionary data
{'fraction_non_alphanumeric': 0.4413025843087264, 'fraction_numerical': 0.0023177656738903696, 'mean_word_length': 0.9135254988913526, 'pattern_counts': {'":': 6, '<': 9, '<?xml version=': 0, '>': 45, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 34, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '850220', 'n_tokens_mistral': 1687, 'n_tokens_neox': 1587, 'n_words': 382}