Metadata-Version: 1.2
Name: WooCommerce
Version: 3.0.0
Summary: A Python wrapper for the WooCommerce REST API
Home-page: https://github.com/woocommerce/wc-api-python
Author: Claudio Sanches @ Automattic
Author-email: claudio+pypi@automattic.com
License: MIT License
Project-URL: Documentation, https://woocommerce.github.io/woocommerce-rest-api-docs/?python#libraries-and-tools
Project-URL: Source, https://github.com/woocommerce/wc-api-python
Project-URL: Tracker, https://github.com/woocommerce/wc-api-python/issues
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://github.com/woocommerce/wc-api-python/actions/workflows/ci.yml/badge.svg?branch=trunk
            :target: https://github.com/woocommerce/wc-api-python/actions/workflows/ci.yml
        
        .. image:: https://img.shields.io/pypi/v/woocommerce.svg
            :target: https://pypi.python.org/pypi/WooCommerce
        
        
        Installation
        ------------
        
        .. code-block:: bash
        
            pip install woocommerce
        
        Getting started
        ---------------
        
        Generate API credentials (Consumer Key & Consumer Secret) following this instructions http://woocommerce.github.io/woocommerce-rest-api-docs/#rest-api-keys.
        
        Check out the WooCommerce API endpoints and data that can be manipulated in http://woocommerce.github.io/woocommerce-rest-api-docs/.
        
        Setup
        -----
        
        .. code-block:: python
        
            from woocommerce import API
        
            wcapi = API(
                url="http://example.com",
                consumer_key="ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
                consumer_secret="cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
                version="wc/v3"
            )
        
        Options
        ~~~~~~~
        
        +-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
        |         Option        |     Type    | Required |                                              Description                                              |
        +=======================+=============+==========+=======================================================================================================+
        | ``url``               | ``string``  | yes      | Your Store URL, example: http://woo.dev/                                                              |
        +-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
        | ``consumer_key``      | ``string``  | yes      | Your API consumer key                                                                                 |
        +-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
        | ``consumer_secret``   | ``string``  | yes      | Your API consumer secret                                                                              |
        +-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
        | ``version``           | ``string``  | no       | API version, default is ``wc/v3``                                                                     |
        +-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
        | ``timeout``           | ``integer`` | no       | Connection timeout, default is ``5``                                                                  |
        +-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
        | ``verify_ssl``        | ``bool``    | no       | Verify SSL when connect, use this option as ``False`` when need to test with self-signed certificates |
        +-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
        | ``query_string_auth`` | ``bool``    | no       | Force Basic Authentication as query string when ``True`` and using under HTTPS, default is ``False``  |
        +-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
        | ``user_agent``        | ``string``  | no       | Set a custom User-Agent, default is ``WooCommerce-Python-REST-API/3.0.0``                             |
        +-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
        | ``oauth_timestamp``   | ``integer`` | no       | Custom timestamp for requests made with oAuth1.0a                                                     |
        +-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
        | ``wp_api``            | ``bool``    | no       | Set to ``False`` in order to use the legacy WooCommerce API (deprecated)                              |
        +-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
        
        Methods
        -------
        
        +--------------+----------------+------------------------------------------------------------------+
        |    Params    |      Type      |                           Description                            |
        +==============+================+==================================================================+
        | ``endpoint`` | ``string``     | WooCommerce API endpoint, example: ``customers`` or ``order/12`` |
        +--------------+----------------+------------------------------------------------------------------+
        | ``data``     | ``dictionary`` | Data that will be converted to JSON                              |
        +--------------+----------------+------------------------------------------------------------------+
        | ``**kwargs`` | ``dictionary`` | Accepts ``params``, also other Requests arguments                |
        +--------------+----------------+------------------------------------------------------------------+
        
        GET
        ~~~
        
        - ``.get(endpoint, **kwargs)``
        
        POST
        ~~~~
        
        - ``.post(endpoint, data, **kwargs)``
        
        PUT
        ~~~
        
        - ``.put(endpoint, data), **kwargs``
        
        DELETE
        ~~~~~~
        
        - ``.delete(endpoint, **kwargs)``
        
        OPTIONS
        ~~~~~~~
        
        - ``.options(endpoint, **kwargs)``
        
        Response
        --------
        
        All methods will return `Response <http://docs.python-requests.org/en/latest/api/#requests.Response>`_ object.
        
        Example of returned data:
        
        .. code-block:: bash
        
            >>> r = wcapi.get("products")
            >>> r.status_code
            200
            >>> r.headers['content-type']
            'application/json; charset=UTF-8'
            >>> r.encoding
            'UTF-8'
            >>> r.text
            u'{"products":[{"title":"Flying Ninja","id":70,...' // Json text
            >>> r.json()
            {u'products': [{u'sold_individually': False,... // Dictionary data
        
        Request with `params` example
        -----------------------------
        
        .. code-block:: python
        
            from woocommerce import API
        
            wcapi = API(
                url="http://example.com",
                consumer_key="ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
                consumer_secret="cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
                version="wc/v3"
            )
        
            # Force delete example.
            print(wcapi.delete("products/100", params={"force": True}).json())
        
            # Query example.
            print(wcapi.get("products", params={"per_page": 20}).json())
        
        
        Changelog
        ---------
        
        See `CHANGELOG.md <https://github.com/woocommerce/wc-api-python/blob/trunk/CHANGELOG.md>`_.
        
Keywords: woocommerce rest api
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 :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
