Merge pull request #160 from EasyPost/modernize

chore: bump minimum Python version from 2.7 to 3.6

Author: Justintime50

.github/workflows/ci.yml

@@ -14,30 +14,22 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: 3.9
-      - name: install dependencies
-        run: python -m pip install -r requirements-dev.txt -e .
-      - name: lint with flake8
-        run: flake8 --statistics easypost/ tests/ examples/
-      - name: Check formatting with Black
-        run: black easypost/ tests/ examples/ --check
-      - name: Check formatting with iSort
-        run: isort easypost/ tests/ examples/ --check-only
+      - name: Install Dependencies
+        run: make install
+      - name: Check format
+        run: make format-check
   run-tests:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        pythonversion:
-          ["2.7", "3.5", "3.6", "3.7", "3.8", "3.9", "pypy-2.7", "pypy-3.6"]
+        pythonversion: ["pypy-3.6", "3.6", "3.7", "3.8", "3.9", "3.10"]
     steps:
       - uses: actions/checkout@v2
       - name: set up python
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.pythonversion }}
-      - name: install dependencies
-        run: "python -m pip install -r requirements-tests.txt -e ."
-      - name: test with pytest
-        run: pytest --cov=easypost --cov-report=term-missing --vcr-record=none --cov-fail-under=60 tests/
-        env:
-          TEST_API_KEY: ${{ secrets.TEST_API_KEY }}
-          PROD_API_KEY: ${{ secrets.PROD_API_KEY }}
+      - name: Install Dependencies
+        run: make install
+      - name: Run Tests
+        run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 make test

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ### NEXT RELEASE
 
+* Bumps minimum Python version from 2.7 to 3.6
+* Bumps all dependencies
 * Add the `update_brand()` method to the User object
 * Removes `_max_timeout` and instead uses a flat 60 second timeout for requests
 * Adds Python version to user-agent header on requests

Makefile

@@ -0,0 +1,62 @@
+PYTHON_BINARY := python3
+VIRTUAL_ENV := venv
+VIRTUAL_BIN := $(VIRTUAL_ENV)/bin
+PROJECT_NAME := easypost
+TEST_DIR := tests
+
+## help - Display help about make targets for this Makefile
+help:
+	@cat Makefile | grep '^## ' --color=never | cut -c4- | sed -e "`printf 's/ - /\t- /;'`" | column -s "`printf '\t'`" -t
+
+## build - Builds the project in preparation for release
+build:
+	$(PYTHON_BINARY) setup.py sdist bdist_wheel
+
+## coverage - Test the project and generate an HTML coverage report
+coverage:
+	$(VIRTUAL_BIN)/pytest --cov=$(PROJECT_NAME) --cov-branch --cov-report=html --cov-report=term-missing
+
+## clean - Remove the virtual environment and clear out .pyc files
+clean:
+	rm -rf $(VIRTUAL_ENV)
+	find . -name '*.pyc' -delete
+	rm -rf dist
+	rm -rf build
+	rm -rf *.egg-info
+
+## black - Runs the Black Python formatter against the project
+black:
+	$(VIRTUAL_BIN)/black $(PROJECT_NAME)/ $(TEST_DIR)/
+
+## black-check - Checks if the project is formatted correctly against the Black rules
+black-check:
+	$(VIRTUAL_BIN)/black $(PROJECT_NAME)/ $(TEST_DIR)/ --check
+
+## format - Runs all formatting tools against the project
+format: black isort lint
+
+## format-check - Checks if the project is formatted correctly against all formatting rules
+format-check: black-check isort-check lint
+
+## install - Install the project locally
+install:
+	$(PYTHON_BINARY) -m venv $(VIRTUAL_ENV)
+	$(VIRTUAL_BIN)/pip install -e ."[dev]"
+
+## isort - Sorts imports throughout the project
+isort:
+	$(VIRTUAL_BIN)/isort $(PROJECT_NAME)/ $(TEST_DIR)/
+
+## isort-check - Checks that imports throughout the project are sorted correctly
+isort-check:
+	$(VIRTUAL_BIN)/isort $(PROJECT_NAME)/ $(TEST_DIR)/ --check-only
+
+## lint - Lint the project
+lint:
+	$(VIRTUAL_BIN)/flake8 $(PROJECT_NAME)/ $(TEST_DIR)/
+
+## test - Test the project
+test:
+	$(VIRTUAL_BIN)/pytest
+
+.PHONY: help build coverage clean black black-check format format-check install isort isort-check lint test

README.md

@@ -5,13 +5,6 @@
 
 EasyPost is the simple shipping API. You can sign up for an account at <https://easypost.com>.
 
-Requirements
-------------
-
-* [Python](https://www.python.org) 2.7 or 3.3+ (or corresponding [PyPy](https://pypy.org) versions). Note that we only test on Python 2.7 and 3.5+; we strongly recommend against using 3.3.x or 3.4.x as they are no longer supported by many libraries.
-* [requests](http://docs.python-requests.org/en/latest/) >= v2.4.3 (if not on Google App Engine) (will be installed automatically)
-* [six](https://pythonhosted.org/six/) (will be installed automatically)
-
 
 Looking for a client library for another language? Check out <https://www.easypost.com/docs/libraries>.
 
@@ -31,10 +24,10 @@ Alternatively, you can clone the EasyPost python client repository:
 git clone https://github.com/EasyPost/easypost-python
 ```
 
-Install:
+Install Locally:
 
 ```bash
-python setup.py install
+make install
 ```
 
 Import the EasyPost client:
@@ -153,12 +146,12 @@ Client Library Development
    1. Build sdist and wheel: `rm -rf build/ dist/ ./*.egg-info; python3 setup.py sdist bdist_wheel`
    1. Push to PyPI with `twine upload dist/*`
 
-### Running Tests
+## Development
 
-To run tests:
+```bash
+# Run tests
+EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make test
 
-   - Create a virtualenv for your version of Python (e.g., `python2.7 -m virtualenv venv`)
-   - Install dependencies in that virtualenv (`./venv/bin/pip install requests six`)
-   - Install test dependencies (`./venv/bin/pip install -r requirements-tests.txt`)
-   - Export `$TEST_API_KEY` and `$PROD_API_KEY` appropriately (these are set automatically for CI)
-   - Run the tests with `py.test` (`./venv/bin/py.test -vs tests`)
+# Run test coverage
+EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make coverage
+```

easypost/__init__.py

@@ -4,17 +4,15 @@
 import re
 import ssl
 import time
-
-import six
-from six.moves.urllib.parse import urlencode
+from urllib.parse import urlencode
 
 from .version import VERSION, VERSION_INFO
 
 __author__ = "EasyPost <[email protected]>"
 __version__ = VERSION
 version_info = VERSION_INFO
 SUPPORT_EMAIL = "[email protected]"
-USER_AGENT = "EasyPost/v2 PythonClient/{0} Python/{1}".format(VERSION, platform.python_version())
+USER_AGENT = f"EasyPost/v2 PythonClient/{VERSION} Python/{platform.python_version()}"
 TIMEOUT = 60
 
 # config
@@ -42,7 +40,7 @@
         raise ImportError(
             "EasyPost requires an up to date requests library. "
             'Update requests via "pip install -U requests" or '
-            "contact us at {}.".format(SUPPORT_EMAIL)
+            f"contact us at {SUPPORT_EMAIL}."
         )
 
     try:
@@ -52,14 +50,14 @@
         raise ImportError(
             "EasyPost requires an up to date requests library. "
             'Update requests via "pip install -U requests" or contact '
-            "us at {}.".format(SUPPORT_EMAIL)
+            f"us at {SUPPORT_EMAIL}."
         )
     else:
         if major < 1:
             raise ImportError(
                 "EasyPost requires an up to date requests library. Update "
                 'requests via "pip install -U requests" or contact us '
-                "at {}.".format(SUPPORT_EMAIL)
+                f"at {SUPPORT_EMAIL}."
             )
 
 
@@ -146,7 +144,7 @@ def convert_to_easypost_object(response, api_key, parent=None, name=None):
         response = response.copy()
         cls_name = response.get("object", EasyPostObject)
         cls_id = response.get("id", None)
-        if isinstance(cls_name, six.string_types):
+        if isinstance(cls_name, str):
             cls = types.get(cls_name, EasyPostObject)
         elif cls_id is not None:
             cls = prefixes.get(cls_id[0 : cls_id.find("_")], EasyPostObject)
@@ -159,14 +157,14 @@ def convert_to_easypost_object(response, api_key, parent=None, name=None):
 
 def _utf8(value):
     # Python3's str(bytestring) returns "b'bytestring'" so we use .decode instead
-    if isinstance(value, six.binary_type):
+    if isinstance(value, bytes):
         return value.decode("utf-8")
     return value
 
 
 def encode_url_params(params):
     converted_params = []
-    for key, value in sorted(six.iteritems(params)):
+    for key, value in sorted(params.items()):
         if value is None:
             continue  # don't add Nones to the query
         elif isinstance(value, datetime.datetime):
@@ -191,7 +189,7 @@ def _objects_to_ids(cls, param):
         if isinstance(param, Resource):
             return {"id": param.id}
         elif isinstance(param, dict):
-            return {k: cls._objects_to_ids(v) for k, v in six.iteritems(param)}
+            return {k: cls._objects_to_ids(v) for k, v in param.items()}
         elif isinstance(param, list):
             return [cls._objects_to_ids(v) for v in param]
         else:
@@ -213,7 +211,7 @@ def request_raw(self, method, url, params=None, apiKeyRequired=True):
             raise Error(
                 "No API key provided. Set an API key via \"easypost.api_key = 'APIKEY'. "
                 "Your API keys can be found in your EasyPost dashboard, or you can email us "
-                "at {} for assistance.".format(SUPPORT_EMAIL)
+                f"at {SUPPORT_EMAIL} for assistance."
             )
 
         abs_url = "%s%s" % (api_base, url or "")
@@ -251,9 +249,7 @@ def request_raw(self, method, url, params=None, apiKeyRequired=True):
         elif request_lib == "requests":
             http_body, http_status = self.requests_request(method, abs_url, headers, params)
         else:
-            raise Error(
-                "Bug discovered: invalid request_lib: {}. " "Please report to {}.".format(request_lib, SUPPORT_EMAIL)
-            )
+            raise Error(f"Bug discovered: invalid request_lib: {request_lib}. Please report to {SUPPORT_EMAIL}.")
 
         return http_body, http_status, my_api_key
 
@@ -274,9 +270,7 @@ def requests_request(self, method, abs_url, headers, params):
         elif method == "post" or method == "put":
             data = json.dumps(params, default=_utf8)
         else:
-            raise Error(
-                "Bug discovered: invalid request method: {}. " "Please report to {}.".format(method, SUPPORT_EMAIL)
-            )
+            raise Error(f"Bug discovered: invalid request method: {method}. Please report to {SUPPORT_EMAIL}.")
 
         try:
             result = requests_session.request(
@@ -292,7 +286,7 @@ def requests_request(self, method, abs_url, headers, params):
         except Exception as e:
             raise Error(
                 "Unexpected error communicating with EasyPost. If this "
-                "problem persists please let us know at {}.".format(SUPPORT_EMAIL),
+                f"problem persists please let us know at {SUPPORT_EMAIL}.",
                 original_exception=e,
             )
         return http_body, http_status
@@ -305,16 +299,14 @@ def urlfetch_request(self, method, abs_url, headers, params):
         elif method == "get" or method == "delete":
             fetch_args["url"] = add_params_to_url(abs_url, params)
         else:
-            raise Error(
-                "Bug discovered: invalid request method: {}. Please report " "to {}.".format(method, SUPPORT_EMAIL)
-            )
+            raise Error(f"Bug discovered: invalid request method: {method}. Please report to {SUPPORT_EMAIL}.")
 
         try:
             result = urlfetch.fetch(**fetch_args)
         except Exception as e:
             raise Error(
                 "Unexpected error communicating with EasyPost. "
-                "If this problem persists, let us know at {}.".format(SUPPORT_EMAIL),
+                f"If this problem persists, let us know at {SUPPORT_EMAIL}.",
                 original_exception=e,
             )
 
@@ -404,7 +396,7 @@ def construct_from(cls, values, api_key=None, parent=None, name=None):
     def refresh_from(self, values, api_key):
         self._api_key = api_key
 
-        for k, v in sorted(six.iteritems(values)):
+        for k, v in sorted(values.items()):
             if k == "id" and self.id != v:
                 self.id = v
             if k in self._immutable_values:
@@ -427,7 +419,7 @@ def flatten_unsaved(self):
     def __repr__(self):
         type_string = ""
 
-        if isinstance(self.get("object"), six.string_types):
+        if isinstance(self.get("object"), str):
             type_string = " %s" % self.get("object").encode("utf8")
 
         json_string = json.dumps(self.to_dict(), sort_keys=True, indent=2, cls=EasyPostObjectEncoder)