Updated readme and added some more example calls

pors · pors · commit 808723d796ce · 2017-06-28T15:52:29.000+03:00
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,7 @@
 *.py[cod]
 .env
+ve
+ve3
 # C extensions
 *.so
 
diff --git a/README.md b/README.md
@@ -1,29 +1,58 @@
-Python-Hackpad-API
-==================
+# Python-Hackpad-API
 
-A simple wrapper library for the Hackpad API. [Hackpad API Documentation](https://hackpad.com/Public-Hackpad-API-Draft-nGhsrCJFlP7)
 
-Installation 
-==================
+A simple wrapper library for the Hackpad API. [Hackpad API Documentation](https://hackpad.co/Hackpad-API-v1.0-KdHQhIEfGJG)
+
+## Installation 
+
+This works best from a virtualenv:
+
+```
+virtualenv -p python3 ve3
+. ve3/bin/activate
+```
 
 Navigate to the folder where you have downloaded this repo, and type
 
 ```
-easy_install .
+pip install -r requirements.txt
 ```
 
 into your terminal / command prompt.
 
-Usage
-==================
+# Usage
 
 ```python
-temp = Hackpad('your_hackpad_subdomain','your_hackpad_client_id','your_hackpad_secret')
+temp = Hackpad('the_hackpad_api_domain', 'your_hackpad_subdomain','your_hackpad_client_id','your_hackpad_secret')
 my_hackpads = temp.list_all()
-````
+```
 
-Note:
+Notes:
 
 * For `your_hackpad_subdomain`, just type the stem, not the full domain name (i.e. `mysubdomain`, not `http://mysubdomain.hackpad.com`, etc).
 * Your Client ID and Secret for the different subdomains you are signed into. Make sure to use the correct keys for the subdomain you are signing into.
 
+# Running the example
+
+First export the following environment vars (below in Mac OS style):
+
+```
+export HACKPAD_SUB_DOMAIN=your_hackpad_subdomain
+export HACKPAD_API_DOMAIN=the_hackpad_api_domain
+export HACKPAD_CLIENT_ID=your_hackpad_client_id
+export HACKPAD_SECRET=your_hackpad_secret
+```
+
+Then run it:
+
+```
+python example/example1.py
+```
+
+# Credits
+
+This repository is based on the work of [Kevin Marshall](https://github.com/Falicon). 
+
+An essential oAuth fix to the original library was made by [Jeremi Joslin](https://github.com/jeremi).
+
+Thanks guys!
diff --git a/example/example1.py b/example/example1.py
@@ -1,7 +1,19 @@
 import os
 from hackpad_api.hackpad import Hackpad
 
-hackpad = Hackpad(os.getenv('team') ,consumer_key = os.getenv('consumer_key'), consumer_secret = os.getenv('consumer_secret'))
+hackpad = Hackpad(api_domain = os.getenv('HACKPAD_API_DOMAIN'),
+                  sub_domain = os.getenv('HACKPAD_SUB_DOMAIN'),
+                  consumer_key = os.getenv('HACKPAD_CLIENT_ID'),
+                  consumer_secret = os.getenv('HACKPAD_SECRET'))
 
-print(hackpad.do_api_request('pads/all', 'GET'))
+new_html_pad = hackpad.create_hackpad('HTML Pad Title Here', '<html><body><h1>HTML Pad Title Here</h1><p></p><p>And some text in <b>HTML</b>.</p><p>Very cool no?</p></body></html>', '', 'text/html')
 
+new_txt_pad = hackpad.create_hackpad('Text Pad Title Here', 'And some plain text.\n\nVery cool no?\n', '', 'text/plain')
+
+all_pads = hackpad.list_all()
+
+for padId in all_pads:
+    #    hackpad.do_api_request()
+    pad = hackpad.get_pad_content(padId)
+    print(pad.decode('utf-8'))
+    print('-'*79)
diff --git a/example/hackpad_api b/example/hackpad_api
@@ -0,0 +1 @@
+../hackpad_api
