chore: validate and correct all Python examples

EasyPost · Aug 31, 2022 · 1875512 · 1875512
1 parent 4c5bab1
commit 1875512
Show file tree

Hide file tree

Showing 89 changed files with 317 additions and 111 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,9 +1,10 @@
 .DS_Store
 .env
 .idea
-bin
+*.egg-info
 /checkstyle.jar
 /easypost_java_style.xml
 /vendor
+bin
 node_modules
 venv
diff --git a/Makefile b/Makefile
@@ -36,7 +36,7 @@ install-php:
 ## install-python - install Python dependencies
 install-python:
 	$(PYTHON_BINARY) -m venv $(PYTHON_VIRTUAL_ENV)
-	$(PYTHON_VIRTUAL_BIN)/pip install -r requirements.txt
+	$(PYTHON_VIRTUAL_BIN)/pip install -e ."[dev]"
 
 ## install-ruby - installs Ruby dependencies
 install-ruby:

diff --git a/community/golang/concurrent_label_buy.go b/community/golang/concurrent_label_buy.go
@@ -14,7 +14,7 @@ import (
 /*
 * Concurrently buy EasyPost Shipments via a CSV file
 *
-* Usage: EASYPOST_TEST_API_KEY=123... CSV=report.csv CARRIER_ACCOUNT_ID=ca_123... SERVICE=FEDEX_2_DAY CARRIER=FedEx go run concurrent_label_buy.go
+* Usage: EASYPOST_API_KEY=123... CSV=report.csv CARRIER_ACCOUNT_ID=ca_123... SERVICE=FEDEX_2_DAY CARRIER=FedEx go run concurrent_label_buy.go
 * Inspiration: https://stackoverflow.com/questions/33104192/how-to-run-10000-goroutines-in-parallel-where-each-routine-calls-an-api
 * CSV Format: Do not include a header row. Match up the rows with the current-line indexes below (eg: Name: lines[current][0])
 * Rate Limiting: Do not use more than 50 goroutines, do not try CSV's larger than 2000 records, pass Go, do not collect $200... ;)
@@ -32,7 +32,7 @@ func main() {
 	total := int32(0)
 
 	// Make request here
-	apiKey := os.Getenv("EASYPOST_TEST_API_KEY")
+	apiKey := os.Getenv("EASYPOST_API_KEY")
 
 	client := easypost.New(apiKey)
 

diff --git a/community/golang/concurrent_refund.go b/community/golang/concurrent_refund.go
@@ -13,7 +13,7 @@ import (
 /*
 * Concurrently refund EasyPost Shipments via a CSV file
 *
-* Usage: EASYPOST_TEST_API_KEY=123... CSV=report.csv go run concurrent_refund.go
+* Usage: EASYPOST_API_KEY=123... CSV=report.csv go run concurrent_refund.go
 * Inspiration: https://stackoverflow.com/questions/33104192/how-to-run-10000-goroutines-in-parallel-where-each-routine-calls-an-api
 * CSV Format: Provide a single shipment ID per line in column 0 (1st column) with no other data
 * Rate Limiting: Do not use more than 50 goroutines, do not try CSV's larger than 2000 records, pass Go, do not collect $200... ;)
@@ -30,7 +30,7 @@ func main() {
 	total := int32(0)
 
 	// Setup the EasyPost API Client
-	apiKey := os.Getenv("EASYPOST_TEST_API_KEY")
+	apiKey := os.Getenv("EASYPOST_API_KEY")
 
 	client := easypost.New(apiKey)
 

diff --git a/community/golang/concurrent_shipment_scanform.go b/community/golang/concurrent_shipment_scanform.go
@@ -12,7 +12,7 @@ import (
 /*
 * Concurrently scanform shipments from a batch. Great for bypassing scanform errors when there are only a couple of troubled shipments in a large batch
 *
-* Usage: EASYPOST_TEST_API_KEY=123... BATCH=batch_123... go run concurrent_shipment_scanform.go
+* Usage: EASYPOST_API_KEY=123... BATCH=batch_123... go run concurrent_shipment_scanform.go
 * Inspiration: https://stackoverflow.com/questions/33104192/how-to-run-10000-goroutines-in-parallel-where-each-routine-calls-an-api
  */
 
@@ -27,7 +27,7 @@ func main() {
 	total := int32(0)
 
 	// Setup EasyPost API key
-	apiKey := os.Getenv("EASYPOST_TEST_API_KEY")
+	apiKey := os.Getenv("EASYPOST_API_KEY")
 
 	client := easypost.New(apiKey)
 

diff --git a/official/docs/curl/pickups/create-pickup.sh b/official/docs/curl/pickups/create-pickup.sh
@@ -4,8 +4,8 @@ curl -X POST https://api.easypost.com/v2/pickups \
   -d '{
     "pickup": {
       "reference": "my-first-pickup",
-      "min_datetime": "2014-10-20 17:10:00",
-      "max_datetime": "2014-10-21 10:30:00",
+      "min_datetime": "2022-10-01 10:30:00",
+      "max_datetime": "2022-10-02 10:30:00",
       "shipment": "shp_...",
       "address": "adr_...",
       "is_account_address": "false",

diff --git a/official/docs/curl/reports/create-report.sh b/official/docs/curl/reports/create-report.sh
@@ -2,6 +2,6 @@ curl -X POST https://api.easypost.com/v2/reports/payment_log \
   -u "$EASYPOST_API_KEY": \
   -H 'Content-Type: application/json' \
   -d '{
-    "start_date": "2016-10-01",
-    "end_date": "2016-10-31"
+    "start_date": "2022-10-01",
+    "end_date": "2022-10-31"
   }'
diff --git a/official/docs/python/addresses/create_address.py b/official/docs/python/addresses/create_address.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 address = easypost.Address.create(
     street1="417 MONTGOMERY ST",

diff --git a/official/docs/python/addresses/create_and_verify_address.py b/official/docs/python/addresses/create_and_verify_address.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 address = easypost.Address.create_and_verify(
     street1="417 Montgomery Street",

diff --git a/official/docs/python/addresses/create_verified_address.py b/official/docs/python/addresses/create_verified_address.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 address = easypost.Address.create(
     verify=True,

diff --git a/official/docs/python/addresses/retrieve_address.py b/official/docs/python/addresses/retrieve_address.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 address = easypost.Address.retrieve("adr_...")
 

diff --git a/official/docs/python/addresses/retrieve_address_list.py b/official/docs/python/addresses/retrieve_address_list.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 addresses = easypost.Address.all(page_size=5)
 

diff --git a/official/docs/python/addresses/strict_verify_address_on_create.py b/official/docs/python/addresses/strict_verify_address_on_create.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 address = easypost.Address.create(
     verify_strict=True,

diff --git a/official/docs/python/addresses/verify_existing_address.py b/official/docs/python/addresses/verify_existing_address.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 address = easypost.Address.create(
     street1="417 MONTGOMERY ST",

diff --git a/official/docs/python/api_keys/retrieve_api_keys.py b/official/docs/python/api_keys/retrieve_api_keys.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 api_keys = easypost.User.all_api_keys()
 

diff --git a/official/docs/python/batches/add_shipments_to_batch.py b/official/docs/python/batches/add_shipments_to_batch.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 batch = easypost.Batch.retrieve("batch_...")
 

diff --git a/official/docs/python/batches/buy_batch.py b/official/docs/python/batches/buy_batch.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 batch = easypost.Batch.retrieve("batch_...")
 

diff --git a/official/docs/python/batches/create_batch.py b/official/docs/python/batches/create_batch.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 batch = easypost.Batch.create(
     shipments=[

diff --git a/official/docs/python/batches/create_label_for_batch.py b/official/docs/python/batches/create_label_for_batch.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 batch = easypost.Batch.retrieve("batch_...")
 

diff --git a/official/docs/python/batches/manifest_batch.py b/official/docs/python/batches/manifest_batch.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 batch = easypost.Batch.retrieve("batch_...")
 

diff --git a/official/docs/python/batches/remove_shipment_from_batch.py b/official/docs/python/batches/remove_shipment_from_batch.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 batch = easypost.Batch.retrieve("batch_...")
 

diff --git a/official/docs/python/batches/retrieve_batch.py b/official/docs/python/batches/retrieve_batch.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 batch = easypost.Batch.retrieve("batch_...")
 

diff --git a/official/docs/python/batches/retrieve_batch_list.py b/official/docs/python/batches/retrieve_batch_list.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 batches = easypost.Batch.all(page_size=5)
 

diff --git a/official/docs/python/billings/add_funds.py → official/docs/python/billing/add_funds.py b/official/docs/python/billings/add_funds.py → official/docs/python/billing/add_funds.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 billing = easypost.Billing.fund_wallet(
     amount="2000",

diff --git a/.../python/billings/delete_payment_method.py → ...s/python/billing/delete_payment_method.py b/.../python/billings/delete_payment_method.py → ...s/python/billing/delete_payment_method.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 success = easypost.Billing.delete_payment_method(primary_or_secondary="primary")
 

diff --git a/...ython/billings/retrieve_payment_method.py → ...python/billing/retrieve_payment_method.py b/...ython/billings/retrieve_payment_method.py → ...python/billing/retrieve_payment_method.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 payment_methods = easypost.Billing.retrieve_payment_methods()
 

diff --git a/official/docs/python/brand/update_brand.py b/official/docs/python/brand/update_brand.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 user = easypost.User.retrieve_me()
 

diff --git a/official/docs/python/carrier_accounts/create_carrier_account.py b/official/docs/python/carrier_accounts/create_carrier_account.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 carrier_account = easypost.CarrierAccount.create(
     type="DhlEcsAccount",

diff --git a/official/docs/python/carrier_accounts/delete_carrier_account.py b/official/docs/python/carrier_accounts/delete_carrier_account.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 carrier_account = easypost.CarrierAccount.retrieve("ca_...")
 carrier_account.delete()

diff --git a/official/docs/python/carrier_accounts/retrieve_carrier_account.py b/official/docs/python/carrier_accounts/retrieve_carrier_account.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 carrier_account = easypost.CarrierAccount.retrieve("ca_...")
 

diff --git a/official/docs/python/carrier_accounts/retrieve_list_of_accounts.py b/official/docs/python/carrier_accounts/retrieve_list_of_accounts.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 carrier_accounts = easypost.CarrierAccount.all()
 

diff --git a/official/docs/python/carrier_accounts/update_carrier_account.py b/official/docs/python/carrier_accounts/update_carrier_account.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 carrier_account = easypost.CarrierAccount.retrieve("ca_...")
 

diff --git a/official/docs/python/carrier_types/retrieve_carrier_type.py b/official/docs/python/carrier_types/retrieve_carrier_type.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 carrier_types = easypost.CarrierAccount.types()
 

diff --git a/official/docs/python/customs_info/create_customs_info.py b/official/docs/python/customs_info/create_customs_info.py
@@ -1,7 +1,9 @@
+import os
+
 import easypost
 
 
-easypost.api_key = "EASYPOST_API_KEY"
+easypost.api_key = os.getenv("EASYPOST_API_KEY")
 
 customs_info = easypost.CustomsInfo.create(
     eel_pfc="NOEEI 30.37(a)",
@@ -21,3 +23,5 @@
         }
     ],
 )
+
+print(customs_info)