Merge pull request #138 from getyoti/release-2.10.0

Release 2.10.0

Author: MrBurtyyy

.dependabot/config.yml

@@ -0,0 +1,12 @@
+version: 1
+update_configs:
+  - package_manager: "python"
+    directory: "/"
+    update_schedule: "live"
+    target_branch: "development"
+
+    default_reviewers:
+      - "echarrod"
+      - "davidgrayston"
+      - "emmas-yoti"
+      - "MrBurtyyy"

.pre-commit-config.yaml

@@ -1,10 +1,12 @@
-- repo: https://github.com/ambv/black
-  rev: stable
-  hooks:
-      - id: black
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v1.2.3
-  hooks:
-      - id: flake8
-        args:
-          - --ignore=E501,W5
+exclude: protobuf/
+repos:
+ - repo: https://github.com/ambv/black
+   rev: stable
+   hooks:
+     - id: black
+ - repo: https://github.com/pre-commit/pre-commit-hooks
+   rev: v1.2.3
+   hooks:
+     - id: flake8
+       args:
+         - --ignore=E501,W5

.pylintrc

@@ -1,2 +1,3 @@
 [MASTER]
-ignore=yoti_python_sdk/tests/**,examples/**
+ignore=tests,protobuf
+disable=C0330

.travis.yml

@@ -5,29 +5,50 @@ dist: xenial
 # Only clone the most recent commit.
 git:
   depth: 1
-  
-python:
-  - "2.7"
-  - "3.4"
-  - "3.5"
-  - "3.5-dev"
-  - "3.6"
-  - "3.6-dev"
-  - "3.7"
-  - "3.7-dev"
-  - "3.8-dev"
-
-cache: pip
 
-before_install:
-  - pip install -U setuptools
-  
-install:
-  - pip install -r requirements.txt
-  - python setup.py develop
-  
-script:
-  - py.test -v
+jobs:
+  include:
+    - &test
+      stage: Test
+      python: "2.7"
+      cache: pip
+      before_install:
+        - pip install -U setuptools
+      install:
+        - pip install -r requirements.txt
+        - pip install -e .[dev]
+      script:
+        - py.test -v
+    - <<: *test
+      python: "3.4"
+    - <<: *test
+      python: "3.5"
+    - <<: *test
+      python: "3.5-dev"
+    - <<: *test
+      python: "3.6"
+    - <<: *test
+      python: "3.6-dev"
+    - <<: *test
+      python: "3.7"
+    - <<: *test
+      python: "3.7-dev"
+    - <<: *test
+      python: "3.8-dev"
+    - <<: *test
+      python: "3.8"
+    - <<: *test
+      stage: Coverage
+      name: Coveralls
+      python: "3.7"
+      install:
+        - pip install -r requirements.txt
+        - pip install -e .[dev]
+      script:
+        - pytest --cov=yoti_python_sdk yoti_python_sdk/tests
+      if: type = pull_request OR branch = master
+      after_success:
+        - coveralls
 
 matrix:
   allow_failures:

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing
+
+   1. Fork the repo, develop and test your code changes.
+   2. Ensure commit messages clearly define the changes that have been made.
+   3. Create a pull request.
+   
+## Adding Features
+
+Any features added must be fully tested and documented, with examples supplied in the pull request.
+The feature must support the lowest Python version that the SDK supports (see [the travis file](.travis.yml) for all supported versions).  The feature
+must not introduce any unnecessary dependencies (although introducing a new third party library
+is open for discussion if absolutely required).
+
+## Pre-commit Hook
+
+* Install the [pre-commit framework](https://pre-commit.com/)
+* Run `pre-commit install`
+
+## Testing
+
+After cloning the repository, run the following to install dependencies:
+
+```bash
+pip install -r requirements.txt
+pip install -e .[dev]
+```
+
+Running the tests:
+
+```bash
+pytest
+```
+
+## Coding Style
+
+* The pre-commit hook uses the `black` formatter to auto-format any code when committing,
+ along with `flake8` for style guide enforcement.

README.md

@@ -1,5 +1,8 @@
 # Yoti Python SDK #
 
+[![Build Status](https://travis-ci.com/getyoti/yoti-python-sdk.svg?branch=master)](https://travis-ci.com/getyoti/yoti-python-sdk)
+[![Coverage Status](https://coveralls.io/repos/github/getyoti/yoti-python-sdk/badge.svg?branch=master)](https://coveralls.io/github/getyoti/yoti-python-sdk?branch=master)
+
 Welcome to the Yoti Python SDK. This repo contains the tools and step by step instructions 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.
 
 ## Table of Contents
@@ -128,6 +131,7 @@ full_name = profile.full_name.value
 phone_number = profile.phone_number.value
 date_of_birth = profile.date_of_birth.value
 postal_address = profile.postal_address.value
+structured_postal_address = profile.structured_postal_address.value
 gender = profile.gender.value
 nationality = profile.nationality.value
 email_address = profile.email_address.value
@@ -274,7 +278,7 @@ To run the Flask or Django container:
 Running the tests is done by the following process, ensuring you are using Python 3.0+:
 
 1. Install dependencies: `pip install -r requirements.txt`
-1. Install the SDK: `python setup.py develop`
+1. Install the SDK and development dependencies: `pip install .[dev]`
 1. Execute in the main project dir: `py.test`
 
 ## API Coverage
@@ -293,6 +297,7 @@ Running the tests is done by the following process, ensuring you are using Pytho
         * [X] Email Address `email_address`
         * [X] Date of Birth `date_of_birth`
         * [X] Address `postal_address`
+        * [X] Structured Postal Address `structured_postal_address`
         * [X] Gender `gender`
         * [X] Nationality `nationality`
     * [X] Application Profile `application_profile`

examples/yoti_example_django/Dockerfile

@@ -5,12 +5,13 @@ ARG YOTI_KEY_FILE_PATH
 RUN if [ "$YOTI_SCENARIO_ID" = "yourScenarioId" ] ; then echo YOTI_SCENARIO_ID not set; exit 1; else echo YOTI_SCENARIO_ID is $YOTI_SCENARIO_ID ; fi
 RUN if [ "$YOTI_CLIENT_SDK_ID" = "yourClientSdkId" ] ; then echo YOTI_CLIENT_SDK_ID not set; exit 1; else echo YOTI_CLIENT_SDK_ID is $YOTI_CLIENT_SDK_ID ; fi
 RUN if [ "$YOTI_KEY_FILE_PATH" = "yourKeyFilePath" ] ; then echo YOTI_KEY_FILE_PATH not set; exit 1; else echo YOTI_KEY_FILE_PATH is $YOTI_KEY_FILE_PATH ; fi
-ADD . /code
-WORKDIR /code
+ADD . /yoti-sdk
+WORKDIR /yoti-sdk/examples/yoti_example_django/
+RUN pip install --no-cache-dir -r /yoti-sdk/requirements.txt && pip install /yoti-sdk
 RUN pip install --no-cache-dir -r requirements.txt
 ENV YOTI_SCENARIO_ID $YOTI_SCENARIO_ID
 ENV YOTI_CLIENT_SDK_ID $YOTI_CLIENT_SDK_ID
 ENV YOTI_KEY_FILE_PATH $YOTI_KEY_FILE_PATH
 
 RUN python manage.py migrate
-CMD ["python", "manage.py", "runsslserver", "0.0.0.0:5000"]
+CMD ["python", "manage.py", "runsslserver", "0.0.0.0:5000"]

examples/yoti_example_django/docker-compose.yml

@@ -2,7 +2,8 @@ version: '3.4'
 services:
   web:
     build:
-      context: ./
+      context: ../../
+      dockerfile: examples/yoti_example_django/Dockerfile
       args:
         YOTI_SCENARIO_ID: "${YOTI_SCENARIO_ID}"
         YOTI_CLIENT_SDK_ID: "${YOTI_CLIENT_SDK_ID}"

examples/yoti_example_django/requirements.in

@@ -1,5 +1,5 @@
 cryptography>=2.3
-Django==2.2.4
+Django==2.2.8
 django-sslserver>=0.2.0
 python-dotenv>=0.7.1
 requests>=2.20.0

examples/yoti_example_django/requirements.txt

@@ -11,7 +11,7 @@ cffi==1.11.5              # via cryptography
 chardet==3.0.4            # via requests
 cryptography==2.5
 django-sslserver==0.20
-django==2.2.4
+django==2.2.8
 future==0.16.0            # via yoti
 idna==2.7                 # via requests
 protobuf==3.6.0           # via yoti