Added changes for works fine in pypi

claudiosanches · claudiosanches · commit e1de259cb15a · 2015-07-13T03:17:00.000-03:00
diff --git a/.editorconfig b/.editorconfig
@@ -9,5 +9,5 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.md]
+[*.rst]
 trim_trailing_whitespace = false
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,6 @@
 __pycache__
 build/
 dist/
-woocommerce.egg-info/
+*.egg-info/
 run.py
 run3.py
diff --git a/LICENSE.txt b/LICENSE.txt
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,105 @@
+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
diff --git a/setup.py b/setup.py
@@ -16,13 +16,13 @@
     raise RuntimeError("Cannot find version information")
 
 # Get long description
-README = open(os.path.join(os.path.dirname(__file__), "README.md")).read()
+README = open(os.path.join(os.path.dirname(__file__), "README.rst")).read()
 
 # allow setup.py to be run from any path
 os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
 
 setup(
-    name="woocommerce",
+    name="WooCommerce",
     version=VERSION,
     description="A Python wrapper for the WooCommerce REST API",
     long_description=README,
