Merge pull request #4 from tzengerink/feature/add-to-pypi

Allow adding to PyPI

Author: shuisman

CHANGES.md

@@ -0,0 +1,22 @@
+Changelog
+=========
+
+Here you find a full list of changes.
+
+Version 1.2.1
+-------------
+
+- Add usabilla to PyPi
+
+Version 1.2.0
+-------------
+
+- Added In-Page resource
+
+Version 1.1.0
+-------------
+
+- Resources are now retrieved by providing the following:
+	- A scope
+	- A product name
+	- A resource type

README.MD

@@ -20,98 +20,42 @@ It makes use of the API to request the following products and resources:
 
 ###Usabilla for Apps
   - Apps
-  - Feedback items 
+  - Feedback items
 
 For more information on resources, authorization and available API calls, please visit out [documentation](https://usabilla.com/api).
 
-Changes in version 1.2
-- Added In-Page resource
-
-Changes in version 1.1
-Resources are now retrieved by providing the following:
-  - A scope
-  - A product name
-  - A resource type
-
 # Installation:
-Requires Python 2.7. (Need Collections.OrderedDict)
+
+Requires Python 2.7
 
 ```bash
-python setup.py install
+pip install usabilla-api
 ```
 
-# Usage:
-## sample command:
+# Buttons example:
 ```python
 >>> import usabilla as ub
->>> api = ub.APIClient('CLIENT-API-KEY', 'CLIENT-SECRET-KEY')
+>>> api = ub.APIClient('YOUR-ACCESS-KEY', 'YOUR-SECRET-KEY')
 >>> api.set_query_parameters({'limit' : 1})
 >>> buttons = api.get_resource(api.SCOPE_LIVE, api.PRODUCT_WEBSITES,api.RESOURCE_BUTTON)
 >>> print buttons
 ```
 
-## output
-```json
-{
-  "count": 1,
-  "items": [
-    {
-      "_id" : "8d73568ac2be",
-      "name" : "My button",
-    }
-  ],
-  "hasMore": true,
-  "lastTimestamp": 1421232571909752
-}
-```
-
-###Iterators:
+### Iterators
 
 When working with the <code>limit</code> parameters (default value is **100**) you can request resources using the <code>item_iterator()</code> function.
 The API returns data in pages. This function returns a [Generator](https://wiki.python.org/moin/Generators) which
 traverses these pages for you and yields each result in the current page before retrieving the next page.
 
-##Example usage:
+## Feedback example
 
 ```python
 >>> import usabilla as ub
 >>> import json
->>> api = ub.APIClient('CLIENT-API-KEY', 'CLIENT-SECRET-KEY')
+>>> api = ub.APIClient('YOUR-ACCESS-KEY', 'YOUR-SECRET-KEY')
 >>> api.set_query_parameters({'limit' : 1})
 >>> feedbackItems = api.get_resource(api.SCOPE_LIVE, api.PRODUCT_WEBSITES,api.RESOURCE_FEEDBACK,'*',iterate=True)
 >>> print json.dumps([item for item in feedbackItems], indent=4)
 ```
 
 Where <code>id</code> is the button id from which the feedback originates.
-
-## output
-```json
-{
-  "id" : "5499612ec4698839368b4573",
-  "userAgent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.95 Safari/537.36",    
-  "comment" : "A random comment.",    
-  "location" : "Amsterdam, Netherlands",
-  "date" : "2014-01-15T19:48:06.003Z",
-  "custom" : {
-      "form_name" : "form1"
-  },
-  "email" : "dev@usabilla",
-  "htmlSnippet" : "<a href=\"#\">An anchor element</a>",    
-  "image" : "http://usabilla-feedback-dev.s3.amazonaws.com/5499612ec4698839368b4573/detail",
-  "labels" : [ 
-      "label 1", 
-      "label 2"
-  ],  
-  "nps" : 10,
-  "publicUrl" : "http://usabilla.dev/feedback/item/a5cadaf3febf44393401a4be3ebbbf155d9f8d2c",
-  "rating" : 5,    
-  "buttonId" : "8d73568ac2be",
-  "tags" : [ 
-      "interesting", 
-      "unattractive"
-  ],
-  "url" : "http://usabilla.com/member/live/site/8d73568ac2be"
-}
-```
-
-**Note:** Every response is in json format.

examples/buttons_example.py

@@ -5,7 +5,7 @@
 
 if __name__ == '__main__':
     # Create an API client with client and secret keys
-    api = ub.APIClient('CLIENT-API-KEY', 'CLIENT-SECRET-KEY')
+    api = ub.APIClient('YOUR-ACCESS-KEY', 'YOUR-SECRET-KEY')
 
     # Set the limit of buttons to retrieve to 1
     api.set_query_parameters({'limit': 1})

examples/feedback_iterator_example.py

@@ -5,7 +5,7 @@
 
 if __name__ == '__main__':
     # Create an API client with client and secret keys
-    api = ub.APIClient('CLIENT-API-KEY', 'CLIENT-SECRET-KEY')
+    api = ub.APIClient('YOUR-ACCESS-KEY', 'YOUR-SECRET-KEY')
 
     # Set the limit of feedback items to retrieve to 1
     api.set_query_parameters({'limit': 1})

setup.cfg

@@ -3,3 +3,6 @@
 # 3. If at all possible, it is good practice to do this. If you cannot, you
 # will need to generate wheels for each Python version that you support.
 universal=1
+
+[metadata]
+description-file = README.MD

setup.py

@@ -3,16 +3,19 @@
 except ImportError:
     from distutils.core import setup
 
+VERSION = '1.2.1'
+
 setup(
-    name='usabilla',
-    version='1.1',
+    name='usabilla-api',
+    version=VERSION,
     description="Python client for Usabilla API",
     license='MIT',
     install_requires=['urllib3', 'requests'],
     packages=find_packages(),
     py_modules=['usabilla'],
-    author='George V.',
-    author_email='george@usabilla.com',
-    url='http://usabilla.com/api',
+    author='Usabilla',
+    author_email='development@usabilla.com',
+    url='https://github.com/usabilla/api-python',
+    download_url='https://github.com/usabilla/api-python/tarball/%s' % VERSION,
     test_suite='tests'
 )

tests.py

@@ -8,7 +8,7 @@
 
 
 import logging
- 
+
 logging.basicConfig(level=logging.DEBUG)
 
 class TestCredentials(TestCase):