SDK-977: Reformat Python SDK code base

Author: emmas-yoti

examples/aml/app.py

@@ -7,11 +7,11 @@
 from yoti_python_sdk import Client
 from yoti_python_sdk import aml
 
-dotenv_path = join(dirname(__file__), '.env')
+dotenv_path = join(dirname(__file__), ".env")
 load_dotenv(dotenv_path)
 
-YOTI_CLIENT_SDK_ID = environ.get('YOTI_CLIENT_SDK_ID')
-YOTI_KEY_FILE_PATH = environ.get('YOTI_KEY_FILE_PATH')
+YOTI_CLIENT_SDK_ID = environ.get("YOTI_CLIENT_SDK_ID")
+YOTI_KEY_FILE_PATH = environ.get("YOTI_KEY_FILE_PATH")
 
 
 # The following exits cleanly on Ctrl-C,
@@ -25,11 +25,7 @@ def cli_exception(exception_type, value, tb):
 family_name = "Heath"
 
 aml_address = aml.AmlAddress(country="GBR")
-aml_profile = aml.AmlProfile(
-    given_names,
-    family_name,
-    aml_address
-)
+aml_profile = aml.AmlProfile(given_names, family_name, aml_address)
 
 if sys.stdin.isatty():
     sys.excepthook = cli_exception

examples/yoti_example_django/app_settings.py

@@ -1,5 +1,5 @@
 from os import environ
 
-YOTI_SCENARIO_ID = environ.get('YOTI_SCENARIO_ID')
-YOTI_CLIENT_SDK_ID = environ.get('YOTI_CLIENT_SDK_ID')
-YOTI_KEY_FILE_PATH = environ.get('YOTI_KEY_FILE_PATH')
+YOTI_SCENARIO_ID = environ.get("YOTI_SCENARIO_ID")
+YOTI_CLIENT_SDK_ID = environ.get("YOTI_CLIENT_SDK_ID")
+YOTI_KEY_FILE_PATH = environ.get("YOTI_KEY_FILE_PATH")

examples/yoti_example_django/yoti_example/settings.py

@@ -21,7 +21,7 @@
 # See https://docs.djangoproject.com/en/1.10/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = 'p3dh1cx&ey8oesy-nj_md-ouo75xi548m22j^zrv((d1@k%%3!'
+SECRET_KEY = "p3dh1cx&ey8oesy-nj_md-ouo75xi548m22j^zrv((d1@k%%3!"
 
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
@@ -31,52 +31,52 @@
 # Application definition
 
 INSTALLED_APPS = [
-    'django.contrib.admin',
-    'django.contrib.auth',
-    'django.contrib.contenttypes',
-    'django.contrib.sessions',
-    'django.contrib.messages',
-    'django.contrib.staticfiles',
-    'sslserver'
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "sslserver",
 ]
 
 MIDDLEWARE = [
-    'django.middleware.security.SecurityMiddleware',
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'django.middleware.common.CommonMiddleware',
-    'django.middleware.csrf.CsrfViewMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'django.contrib.messages.middleware.MessageMiddleware',
-    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
 ]
 
-ROOT_URLCONF = 'yoti_example.urls'
+ROOT_URLCONF = "yoti_example.urls"
 
 TEMPLATES = [
     {
-        'BACKEND': 'django.template.backends.django.DjangoTemplates',
-        'DIRS': [join(BASE_DIR, 'yoti_example/templates')],
-        'APP_DIRS': True,
-        'OPTIONS': {
-            'context_processors': [
-                'django.template.context_processors.debug',
-                'django.template.context_processors.request',
-                'django.contrib.auth.context_processors.auth',
-                'django.contrib.messages.context_processors.messages',
-            ],
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [join(BASE_DIR, "yoti_example/templates")],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ]
         },
-    },
+    }
 ]
 
-WSGI_APPLICATION = 'yoti_example.wsgi.application'
+WSGI_APPLICATION = "yoti_example.wsgi.application"
 
 # Database
 # https://docs.djangoproject.com/en/1.10/ref/settings/#databases
 
 DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': join(BASE_DIR, 'db.sqlite3'),
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": join(BASE_DIR, "db.sqlite3"),
     }
 }
 
@@ -85,25 +85,19 @@
 
 AUTH_PASSWORD_VALIDATORS = [
     {
-        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
-    },
-    {
-        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
-    },
-    {
-        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
-    },
-    {
-        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"
     },
+    {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"},
+    {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"},
+    {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},
 ]
 
 # Internationalization
 # https://docs.djangoproject.com/en/1.10/topics/i18n/
 
-LANGUAGE_CODE = 'en-us'
+LANGUAGE_CODE = "en-us"
 
-TIME_ZONE = 'UTC'
+TIME_ZONE = "UTC"
 
 USE_I18N = True
 
@@ -114,8 +108,8 @@
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/1.10/howto/static-files/
 
-STATIC_URL = '/static/'
-STATICFILES_FOLDER_NAME = 'static'
-PROJECT_DIR = 'yoti_example/'
+STATIC_URL = "/static/"
+STATICFILES_FOLDER_NAME = "static"
+PROJECT_DIR = "yoti_example/"
 STATIC_ROOT = os.path.join(BASE_DIR, STATICFILES_FOLDER_NAME)
-STATICFILES_DIRS = os.path.join(PROJECT_DIR, STATICFILES_FOLDER_NAME),
+STATICFILES_DIRS = (os.path.join(PROJECT_DIR, STATICFILES_FOLDER_NAME),)

setup.py

@@ -3,43 +3,56 @@
 
 from yoti_python_sdk import __version__
 
-long_description = 'This package contains the tools you need to quickly ' \
-                   'integrate your Python back-end with Yoti, so that your ' \
-                   'users can share their identity details with your ' \
-                   'application in a secure and trusted way.'
+long_description = (
+    "This package contains the tools you need to quickly "
+    "integrate your Python back-end with Yoti, so that your "
+    "users can share their identity details with your "
+    "application in a secure and trusted way."
+)
 
 setup(
-    name='yoti',
+    name="yoti",
     version=__version__,
     packages=find_packages(),
-    license='MIT',
-    description='The Yoti Python SDK, providing API support for Login, Verify (2FA) and Age Verification.',
+    license="MIT",
+    description="The Yoti Python SDK, providing API support for Login, Verify (2FA) and Age Verification.",
     long_description=long_description,
-    url='https://github.com/getyoti/yoti-python-sdk',
-    author='Yoti',
-    author_email='[email protected]',
-    install_requires=['cryptography>=2.2.1', 'protobuf>=3.1.0',
-                      'requests>=2.11.1', 'future>=0.11.0', 'asn1==2.2.0', 'pyopenssl>=18.0.0'],
+    url="https://github.com/getyoti/yoti-python-sdk",
+    author="Yoti",
+    author_email="[email protected]",
+    install_requires=[
+        "cryptography>=2.2.1",
+        "protobuf>=3.1.0",
+        "requests>=2.11.1",
+        "future>=0.11.0",
+        "asn1==2.2.0",
+        "pyopenssl>=18.0.0",
+    ],
     extras_require={
-        'examples': ['Django>1.11.16', 'Flask>=0.10', 'python-dotenv>=0.7.1', 'django-sslserver>=0.2',
-                     'Werkzeug==0.11.15'],
+        "examples": [
+            "Django>1.11.16",
+            "Flask>=0.10",
+            "python-dotenv>=0.7.1",
+            "django-sslserver>=0.2",
+            "Werkzeug==0.11.15",
+        ]
     },
     classifiers=[
-        'Development Status :: 5 - Production/Stable',
-        'License :: OSI Approved :: MIT License',
-        'Operating System :: OS Independent',
-        'Intended Audience :: Developers',
-        '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.3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
-        'Topic :: Software Development :: Libraries :: Python Modules',
+        "Development Status :: 5 - Production/Stable",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Intended Audience :: Developers",
+        "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.3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Topic :: Software Development :: Libraries :: Python Modules",
     ],
-    keywords='yoti sdk 2FA multifactor authentication verification identity login register verify 2Factor',
+    keywords="yoti sdk 2FA multifactor authentication verification identity login register verify 2Factor",
 )

yoti_python_sdk/__init__.py

@@ -6,27 +6,26 @@
 from yoti_python_sdk.client import Client
 
 DEFAULTS = {
-    'YOTI_API_URL': 'https://api.yoti.com',
-    'YOTI_API_PORT': 443,
-    'YOTI_API_VERSION': 'v1',
+    "YOTI_API_URL": "https://api.yoti.com",
+    "YOTI_API_PORT": 443,
+    "YOTI_API_VERSION": "v1",
 }
 
 main_ns = {}
 
 directory_name = os.path.dirname(__file__)
-version_path = os.path.join(directory_name, 'version.py')
+version_path = os.path.join(directory_name, "version.py")
 
 ver_path = convert_path(version_path)
 with open(ver_path) as ver_file:
     exec(ver_file.read(), main_ns)
 
-__version__ = main_ns['__version__']
-YOTI_API_URL = environ.get('YOTI_API_URL', DEFAULTS['YOTI_API_URL'])
-YOTI_API_PORT = environ.get('YOTI_API_PORT', DEFAULTS['YOTI_API_PORT'])
-YOTI_API_VERSION = environ.get('YOTI_API_VERSION', DEFAULTS['YOTI_API_VERSION'])
-YOTI_API_ENDPOINT = '{0}:{1}/api/{2}'.format(YOTI_API_URL, YOTI_API_PORT, YOTI_API_VERSION)
+__version__ = main_ns["__version__"]
+YOTI_API_URL = environ.get("YOTI_API_URL", DEFAULTS["YOTI_API_URL"])
+YOTI_API_PORT = environ.get("YOTI_API_PORT", DEFAULTS["YOTI_API_PORT"])
+YOTI_API_VERSION = environ.get("YOTI_API_VERSION", DEFAULTS["YOTI_API_VERSION"])
+YOTI_API_ENDPOINT = "{0}:{1}/api/{2}".format(
+    YOTI_API_URL, YOTI_API_PORT, YOTI_API_VERSION
+)
 
-__all__ = [
-    'Client',
-    __version__
-]
+__all__ = ["Client", __version__]

yoti_python_sdk/aml.py

@@ -7,14 +7,16 @@ def __init__(self, response_text):
             raise ValueError("AML Response is not valid")
 
         try:
-            self.on_pep_list = json.loads(response_text).get('on_pep_list')
-            self.on_fraud_list = json.loads(response_text).get('on_fraud_list')
-            self.on_watch_list = json.loads(response_text).get('on_watch_list')
+            self.on_pep_list = json.loads(response_text).get("on_pep_list")
+            self.on_fraud_list = json.loads(response_text).get("on_fraud_list")
+            self.on_watch_list = json.loads(response_text).get("on_watch_list")
 
         except (AttributeError, IOError, TypeError, OSError) as exc:
-            error = 'Could not parse AML result from response: "{0}"'.format(response_text)
-            exception = '{0}: {1}'.format(type(exc).__name__, exc)
-            raise RuntimeError('{0}: {1}'.format(error, exception))
+            error = 'Could not parse AML result from response: "{0}"'.format(
+                response_text
+            )
+            exception = "{0}: {1}".format(type(exc).__name__, exc)
+            raise RuntimeError("{0}: {1}".format(error, exception))
 
         self.__check_for_none_values(self.on_pep_list)
         self.__check_for_none_values(self.on_fraud_list)
@@ -23,12 +25,16 @@ def __init__(self, response_text):
     @staticmethod
     def __check_for_none_values(arg):
         if arg is None:
-            raise TypeError(str.format("{0} argument was unable to be retrieved from the response", arg))
+            raise TypeError(
+                str.format(
+                    "{0} argument was unable to be retrieved from the response", arg
+                )
+            )
 
     def __iter__(self):
-        yield 'on_pep_list', self.on_pep_list
-        yield 'on_fraud_list', self.on_fraud_list
-        yield 'on_watch_list', self.on_watch_list
+        yield "on_pep_list", self.on_pep_list
+        yield "on_fraud_list", self.on_fraud_list
+        yield "on_watch_list", self.on_watch_list
 
 
 class AmlAddress:

yoti_python_sdk/attribute.py

@@ -23,8 +23,12 @@ def anchors(self):
 
     @property
     def sources(self):
-        return list(filter(lambda a: a.anchor_type == config.ANCHOR_SOURCE, self.__anchors))
+        return list(
+            filter(lambda a: a.anchor_type == config.ANCHOR_SOURCE, self.__anchors)
+        )
 
     @property
     def verifiers(self):
-        return list(filter(lambda a: a.anchor_type == config.ANCHOR_VERIFIER, self.__anchors))
+        return list(
+            filter(lambda a: a.anchor_type == config.ANCHOR_VERIFIER, self.__anchors)
+        )