refactor(*): Removing code from setup.py and add dedicated config module

Author: malcolmrebughini

README.md

@@ -7,9 +7,9 @@ Shippo is a shipping API that connects you with [multiple shipping carriers](htt
 
 Print a shipping label in 10 mins using our default USPS and DHL Express accounts. No need to register for a carrier account to get started.
 
-You will first need to [register for a Shippo account](https://goshippo.com/) to use our API. It's free to sign up, free to use the API. Only pay to print a live label, test labels are free. 
+You will first need to [register for a Shippo account](https://goshippo.com/) to use our API. It's free to sign up, free to use the API. Only pay to print a live label, test labels are free.
 
-### How do I get set up? ###
+### How do I get set up?
 
 #### To install from the source file:
 
@@ -19,10 +19,11 @@ python setup.py install
 ```
 
 or pip (https://pip.pypa.io/en/latest/index.html):
+
 ```
 #!shell
 sudo pip install shippo
-``` 
+```
 
 #### To test:
 
@@ -38,7 +39,6 @@ Run the test with the following command:
 python setup.py test --test-suite=shippo
 ```
 
-
 #### Dependencies:
 
 ##### requests & mock
@@ -47,14 +47,14 @@ python setup.py test --test-suite=shippo
 #!shell
 sudo easy_install requests
 sudo easy_install mock
-``` 
+```
 
 #### Using the API:
 
 ```python
 
 import shippo
-shippo.api_key = "<API-KEY>"
+shippo.config.api_key = "shippo_test_d90f00698a0a8def0495fddb4212bb08051469d3"
 
 address1 = shippo.Address.create(
     name='John Smith',
@@ -76,13 +76,12 @@ print 'Success with Address 1 : %r' % (address1, )
 We've created a number of examples to cover the most common use cases. You can find the sample code files in the [examples folder](examples/).
 Some of the use cases we covered include:
 
-* [Basic domestic shipment](examples/basic-shipment.py)
-* [International shipment](examples/international-shipment.py)  - Custom forms, interntational destinations
-* [Price estimation matrix](examples/estimate-shipping-prices.py)
-* [Retrieve rates, filter by delivery time and purchase cheapest label](examples/filter-by-delivery-time.py)
-* [Retrieve rates, purchase label for fastest delivery option](examples/purchase-fastest-service.py)
-* [Retrieve rates so customer can pick preferred shipping method, purchase label](examples/get-rates-to-show-customer.py)
-
+- [Basic domestic shipment](examples/basic-shipment.py)
+- [International shipment](examples/international-shipment.py) - Custom forms, interntational destinations
+- [Price estimation matrix](examples/estimate-shipping-prices.py)
+- [Retrieve rates, filter by delivery time and purchase cheapest label](examples/filter-by-delivery-time.py)
+- [Retrieve rates, purchase label for fastest delivery option](examples/purchase-fastest-service.py)
+- [Retrieve rates so customer can pick preferred shipping method, purchase label](examples/get-rates-to-show-customer.py)
 
 ## Documentation
 
@@ -96,15 +95,14 @@ Connect with multiple different carriers, get discounted shipping labels, track
 
 The Shippo API provides in depth support of carrier and shipping functionalities. Here are just some of the features we support through the API:
 
-* Shipping rates & labels - [Docs](https://goshippo.com/docs/first-shipment)
-* Tracking for any shipment with just the tracking number - [Docs](https://goshippo.com/docs/tracking)
-* Batch label generation - [Docs](https://goshippo.com/docs/batch)
-* Multi-piece shipments - [Docs](https://goshippo.com/docs/multipiece)
-* Manifests and SCAN forms - [Docs](https://goshippo.com/docs/manifests)
-* Customs declaration and commercial invoicing - [Docs](https://goshippo.com/docs/international)
-* Address verification - [Docs](https://goshippo.com/docs/address-validation)
-* Consolidator support including:
-	* DHL eCommerce
-	* UPS Mail Innovations
-	* FedEx Smartpost
-* Additional services: cash-on-delivery, certified mail, delivery confirmation, and more - [Docs](https://goshippo.com/docs/reference#shipment-extras)
+- Shipping rates & labels - [Docs](https://goshippo.com/docs/first-shipment)
+- Tracking for any shipment with just the tracking number - [Docs](https://goshippo.com/docs/tracking)
+- Batch label generation - [Docs](https://goshippo.com/docs/batch)
+- Multi-piece shipments - [Docs](https://goshippo.com/docs/multipiece)
+- Manifests and SCAN forms - [Docs](https://goshippo.com/docs/manifests)
+- Customs declaration and commercial invoicing - [Docs](https://goshippo.com/docs/international)
+- Address verification - [Docs](https://goshippo.com/docs/address-validation)
+- Consolidator support including:
+  _ DHL eCommerce
+  _ UPS Mail Innovations \* FedEx Smartpost
+- Additional services: cash-on-delivery, certified mail, delivery confirmation, and more - [Docs](https://goshippo.com/docs/reference#shipment-extras)

examples/basic-shipment.py

@@ -6,7 +6,7 @@
 """
 
 # Replace <API-KEY> with your key
-shippo.api_key = "<API-KEY>"
+shippo.config.api_key = "<API-KEY>"
 
 # Example address_from object dict
 # The complete refence for the address object is available here: https://goshippo.com/docs/reference#addresses

examples/batch.py

@@ -6,7 +6,7 @@
 """
 
 # Replace <API-KEY> with your key
-shippo.api_key = "<API-KEY>"
+shippo.config.api_key = "<API-KEY>"
 
 example_batch = {
     # replace with your carrier account

examples/estimate-shipping-prices.py

@@ -35,7 +35,7 @@
 DESTINATION_ADDRESSES_ZIP_CODES = [10007, 60290, 95122]
 
 # replace <API-KEY> with your key
-shippo.api_key = "<API-KEY>"
+shippo.config.api_key = "<API-KEY>"
 
 # sample address_from
 # The complete refence for the address object is available here: https://goshippo.com/docs/reference#addresses

examples/filter-by-delivery-time.py

@@ -13,7 +13,7 @@
 MAX_TRANSIT_TIME_DAYS = 3
 
 # Replace <API-KEY> with your key
-shippo.api_key = "<API-KEY>"
+shippo.config.api_key = "<API-KEY>"
 
 # Example address_from object dict
 # The complete refence for the address object is available here: https://goshippo.com/docs/reference#addresses

examples/get-rates-to-show-customer.py

@@ -11,7 +11,7 @@
 MAX_TRANSIT_TIME_DAYS = 3
 
 # replace <API-KEY> with your key
-shippo.api_key = "<API-KEY>"
+shippo.config.api_key = "<API-KEY>"
 
 # Example address_from object dict
 # The complete refence for the address object is available here: https://goshippo.com/docs/reference#addresses

examples/international-shipment.py

@@ -11,7 +11,7 @@
 """
 
 # replace <API-KEY> with your key
-shippo.api_key = "<API-KEY>"
+shippo.config.api_key = "<API-KEY>"
 
 # Example address_from object dict
 # The complete reference for the address object is available here: https://goshippo.com/docs/reference#addresses

examples/purchase-fastest-service.py

@@ -12,7 +12,7 @@
 MAX_TRANSIT_TIME_DAYS = 3
 
 # Replace <API-KEY> with your key
-shippo.api_key = "<API-KEY>"
+shippo.config.api_key = "<API-KEY>"
 
 # Example address_from object dict
 # The complete refence for the address object is available here: https://goshippo.com/docs/reference#addresses

examples/tracking.py

@@ -6,10 +6,10 @@
 '''
 
 # Replace <API-KEY> with your key
-shippo.api_key = "<API-KEY>"
+shippo.config.api_key = "<API-KEY>"
 
 # Tracking based on a Shippo transaction
-transaction_id = '7774eff962dd4ae3ad125dceed5c4858'
+transaction_id = '<TRANSACTION-ID>'
 transaction = shippo.Transaction.retrieve(transaction_id)
 
 if transaction:

setup.py

@@ -1,71 +1,40 @@
-from version import VERSION
 import os
 import sys
 import warnings
+from setuptools import setup
 
-try:
-    from setuptools import setup
-except ImportError:
-    from distutils.core import setup
 
-try:
-    from distutils.command.build_py import build_py_2to3 as build_py
-except ImportError:
-    from distutils.command.build_py import build_py
+version_contents = {}
 
-path, script = os.path.split(sys.argv[0])
-os.chdir(os.path.abspath(path))
-
-install_requires = []
-
-if sys.version_info < (2, 6):
-    warnings.warn(
-        'Python 2.5 is not officially supported by Shippo. '
-        'If you have any questions, please file an issue on Github or '
-        'contact us at support@goshippo.com.',
-        DeprecationWarning)
-    install_requires.append('requests >= 0.9.0, < 0.10.1')
-    install_requires.append('ssl')
-else:
-    install_requires.append('requests >= 0.9.0')
-
-
-# Don't import shippo module here, since deps may not be installed
-sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'shippo'))
-
-# Get simplejson if we don't already have json
-if sys.version_info < (3, 0):
-    try:
-        from util import json
-    except ImportError:
-        install_requires.append('simplejson')
+here = os.path.abspath(os.path.dirname(__file__))
+with open(os.path.join(here, "shippo", "version.py"), encoding="utf-8") as f:
+    exec(f.read(), version_contents)
 
 setup(
     name='shippo',
-    cmdclass={'build_py': build_py},
-    version=VERSION,
+    version=version_contents['VERSION'],
     description='Shipping API Python library (USPS, FedEx, UPS and more)',
     author='Shippo',
     author_email='support@goshippo.com',
     url='https://goshippo.com/',
     packages=['shippo', 'shippo.test', 'shippo.test.integration'],
     package_data={'shippo': ['../VERSION']},
-    install_requires=install_requires,
+    install_requires=[
+        'requests == 2.21.0',
+        'simplejson == 3.16.0',
+    ],
     test_suite='shippo.test.all',
     tests_require=['unittest2', 'mock', 'vcrpy'],
-    use_2to3=True,
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
         "Programming Language :: Python",
-        "Programming Language :: Python :: 2",
-        "Programming Language :: Python :: 2.6",
-        "Programming Language :: Python :: 2.7",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.2",
-        "Programming Language :: Python :: 3.3",
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3 :: Only",
         "Programming Language :: Python :: Implementation :: PyPy",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ]

shippo/__init__.py

@@ -1,4 +1,3 @@
-# Configurable variables
 from shippo.resource import (
     Address,
     Batch,
@@ -13,8 +12,3 @@
     Track,
     Transaction,
 )
-api_key = None
-api_base = 'https://api.goshippo.com/'
-api_version = None
-verify_ssl_certs = True
-rates_req_timeout = 20.0  # seconds

shippo/api_requestor.py

@@ -59,7 +59,7 @@ class APIRequestor(object):
     def __init__(self, key=None, client=None):
         self.api_key = key
 
-        from shippo import verify_ssl_certs
+        from shippo.config import verify_ssl_certs
 
         self._client = client or http_client.new_default_http_client(
             verify_ssl_certs=verify_ssl_certs)
@@ -89,18 +89,18 @@ def request_raw(self, method, url, params=None):
         """
         Mechanism for issuing an API call
         """
-        from shippo import api_version
+        from shippo.config import api_version
 
         if self.api_key:
             my_api_key = self.api_key
         else:
-            from shippo import api_key
+            from shippo.config import api_key
             my_api_key = api_key
 
         if my_api_key is None:
             raise error.AuthenticationError(
                 'No API key provided. (HINT: set your API key using '
-                '"shippo.api_key = <API-KEY>"). You can generate API keys '
+                '"shippo.api_key = shippo_test_d90f00698a0a8def0495fddb4212bb08051469d3"). You can generate API keys '
                 'from the Shippo web interface.  See https://goshippo.com/api '
                 'for details, or email support@goshippo.comom if you have any '
                 'questions.')
@@ -109,7 +109,7 @@ def request_raw(self, method, url, params=None):
         if my_api_key.startswith('oauth.'):
             token_type = 'Bearer'
 
-        abs_url = '%s%s' % (shippo.api_base, url)
+        abs_url = '%s%s' % (shippo.config.api_base, url)
 
         if method == 'get' or method == 'delete':
             if params:
@@ -183,10 +183,10 @@ def _check_ssl_cert(self):
         the certificate before sending potentially sensitive data on the wire.
         This approach raises the bar for an attacker significantly."""
 
-        from shippo import verify_ssl_certs
+        from shippo.config import verify_ssl_certs
 
         if verify_ssl_certs and not self._CERTIFICATE_VERIFIED:
-            uri = urllib.parse.urlparse(shippo.api_base)
+            uri = urllib.parse.urlparse(shippo.config.api_base)
             try:
                 certificate = ssl.get_server_certificate(
                     (uri.hostname, uri.port or 443))

shippo/config.py

@@ -0,0 +1,6 @@
+# Configurable variables
+api_key = None
+api_base = 'https://api.goshippo.com/'
+api_version = None
+verify_ssl_certs = True
+rates_req_timeout = 20.0

shippo/resource.py

@@ -2,8 +2,10 @@
 import sys
 import time
 import warnings
+import shippo.config as config
+from shippo import api_requestor, error, util
+from shippo.config import rates_req_timeout
 
-from shippo import api_requestor, error, util, rates_req_timeout
 
 warnings.filterwarnings('always', category=DeprecationWarning, module='shippo')
 

shippo/test/helper.py

@@ -336,21 +336,24 @@ def setUp(self):
         self._shippo_original_attributes = {}
 
         for attr in self.RESTORE_ATTRIBUTES:
-            self._shippo_original_attributes[attr] = getattr(shippo, attr)
+            self._shippo_original_attributes[attr] = getattr(
+                shippo.config, attr)
 
         api_base = os.environ.get('SHIPPO_API_BASE')
         if api_base:
-            shippo.api_base = api_base
+            shippo.config.api_base = api_base
 
-        shippo.api_key = os.environ.get(
+        shippo.config.api_key = os.environ.get(
             'SHIPPO_API_KEY', '51895b669caa45038110fd4074e61e0d')
-        shippo.api_version = os.environ.get('SHIPPO_API_VERSION', '2017-03-29')
+        shippo.config.api_version = os.environ.get(
+            'SHIPPO_API_VERSION', '2017-03-29')
 
     def tearDown(self):
         super(ShippoTestCase, self).tearDown()
 
         for attr in self.RESTORE_ATTRIBUTES:
-            setattr(shippo, attr, self._shippo_original_attributes[attr])
+            setattr(shippo.config, attr,
+                    self._shippo_original_attributes[attr])
 
     # Python < 2.7 compatibility
     def assertRaisesRegexp(self, exception, regexp, callable, *args, **kwargs):

shippo/test/integration/test_integration.py

@@ -33,13 +33,13 @@ def tearDown(self):
         self.client_patcher.stop()
 
     def test_dns_failure(self):
-        api_base = shippo.api_base
+        api_base = shippo.config.api_base
         try:
-            shippo.api_base = 'https://my-invalid-domain.ireallywontresolve/v1'
+            shippo.config.api_base = 'https://my-invalid-domain.ireallywontresolve/v1'
             self.assertRaises(shippo.error.APIConnectionError,
                               shippo.Address.create)
         finally:
-            shippo.api_base = api_base
+            shippo.config.api_base = api_base
 
     def test_run(self):
         try:

shippo/version.py

@@ -1 +1 @@
-VERSION = '2.0.0'
+VERSION = '2.0.0rc1'