Merge pull request #201 from trainerbill/master

Add and Update documentation and samples

Author: xiaoleih41

samples/README.md

@@ -0,0 +1,33 @@
+# Running Samples
+
+## System Requirements
+PayPal SDK depends on the following system libraries:
+
+* libssl-dev
+* libffi-dev
+
+On Debian-based systems, run:
+
+```sh
+apt-get install libssl-dev libffi-dev
+```
+# Installation
+```sh
+git clone https://github.com/paypal/PayPal-Python-SDK.git
+cd PayPal-Python-SDK
+pip install -e .
+```
+
+## Configuration
+```sh
+export PAYPAL_MODE=sandbox   # sandbox or live
+export PAYPAL_CLIENT_ID=YOUR_CLIENT_ID_FROM_PAYPAL # https://developer.paypal.com/docs/integration/admin/manage-apps/
+export PAYPAL_CLIENT_SECRET=YOUR_CLIENT_SECRET_FROM_PAYPAL # https://developer.paypal.com/docs/integration/admin/manage-apps/
+```
+
+## Run Sample
+There may be additional comments in the sample file that you must complete before running.
+
+```sh
+python samples/payment/create_with_paypal.py
+```

samples/invoice/cancel.py

@@ -1,8 +1,9 @@
 from paypalrestsdk import Invoice
 import logging
+import json
 logging.basicConfig(level=logging.INFO)
 
-invoice = Invoice.find("INV2-CJL7-PF4G-BLQF-5FWG")
+invoice = Invoice.find("INV2-V2QW-LCUV-RNRL-AQUE")
 options = {
     "subject": "Past due",
     "note": "Canceling invoice",
@@ -11,6 +12,6 @@
 }
 
 if invoice.cancel(options):  # return True or False
-    print("Invoice[%s] cancel successfully" % (invoice.id))
+    print(json.dumps(invoice.to_dict(), sort_keys=False, indent=4))
 else:
     print(invoice.error)

samples/invoice/create.py

@@ -1,11 +1,12 @@
 from paypalrestsdk import Invoice
 import logging
+import json
 
 logging.basicConfig(level=logging.INFO)
 
 invoice = Invoice({
     "merchant_info": {
-        "email": "jaypatel512-facilitator@hotmail.com",
+        "email": "jaypatel512-facilitator@hotmail.com",  # You must change this to your sandbox email account
         "first_name": "Dennis",
         "last_name": "Doctor",
         "business_name": "Medical Professionals, LLC",
@@ -61,6 +62,6 @@
 })
 
 if invoice.create():
-    print("Invoice[%s] created successfully" % (invoice.id))
+    print(json.dumps(invoice.to_dict(), sort_keys=False, indent=4))
 else:
     print(invoice.error)

samples/invoice/get.py

@@ -1,10 +1,11 @@
 from paypalrestsdk import Invoice, ResourceNotFound
 import logging
+import json
 logging.basicConfig(level=logging.INFO)
 
 try:
     invoice = Invoice.find("INV2-9DRB-YTHU-2V9Q-7Q24")
-    print("Got Invoice Details for Invoice[%s]" % (invoice.id))
+    print(json.dumps(invoice.to_dict(), sort_keys=False, indent=4))
 
 except ResourceNotFound as error:
     print("Invoice Not Found")

samples/invoice/search.py

@@ -1,18 +1,21 @@
 from paypalrestsdk import Invoice
 import logging
+import json
 logging.basicConfig(level=logging.INFO)
 
+
+
 # status should pass array with below enum values
 # Allowed values: DRAFT, SENT, PAID, MARKED_AS_PAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, MARKED_AS_REFUNDED.
 
 options = {
     "start_invoice_date": "2016-01-01 PST",
-    "end_invoice_date": "2017-03-26 PST",
-    "status": ["SENT", "DRAFT", "PAID", "CANCELLED"],
+    "end_invoice_date": "2030-03-26 PST",
+    "status": ["SENT", "DRAFT", "PAID", "CANCELLED"]
 }
 invoices = Invoice.search(options)
 
 if invoices.success():  # return True or False
-    print("Search Invoice[%s] successfully" % (invoices,))
+    print(json.dumps(invoices.to_dict(), sort_keys=False, indent=4))
 else:
-    print(invoices.error)
+    print(invoices.error)

samples/invoice/search_pages.py

@@ -0,0 +1,30 @@
+from paypalrestsdk import Invoice
+import logging
+import json
+logging.basicConfig(level=logging.INFO)
+
+
+my_invoices = []
+page_size = 2
+
+for i in range(3):
+    
+    options = {
+        "start_invoice_date": "2016-01-01 PST",
+        "end_invoice_date": "2030-03-26 PST",
+        "status": ["SENT", "DRAFT", "PAID", "CANCELLED"],
+        "total_count_required": True,
+        "page": i * page_size,
+        "page_size": page_size
+    }
+    
+    invoices = Invoice.search(options)
+
+    if invoices.success():  # return True or False
+        for inv in invoices.invoices:
+            my_invoices.append(inv.id)
+    else:
+        print(invoices.error)
+
+   
+print(json.dumps(my_invoices, sort_keys=False, indent=4))