diff --git a/README.rst b/README.rst index 0461985..1b5d51c 100644 --- a/README.rst +++ b/README.rst @@ -1,151 +1,2 @@ Modified 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 `_ 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 `_. +Python wrapper for the WooCommerce REST API. Easily interact with the WooCommerce REST API using this library. diff --git a/setup.py b/setup.py index 9dae917..e780961 100644 --- a/setup.py +++ b/setup.py @@ -22,13 +22,13 @@ os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir))) setup( - name="WooCommerce", + name="WooCommerceMetorik", version=VERSION, description="A Python wrapper for the WooCommerce REST API", long_description=README, author="Claudio Sanches @ Automattic", author_email="claudio+pypi@automattic.com", - url="https://github.com/woocommerce/wc-api-python", + url="https://github.com/jakubactive/wc-api-python", license="MIT License", packages=[ "woocommerce"