Improve CI with GitHub Actions (#1)

* Add type annotations

* Add pytest-cov

* Update CI

* Add black banner to README

* Disable Codecov

Author: Luca Valentini

.github/workflows/ci.yml

@@ -1,34 +1,37 @@
-name: Python package
+name: Continuous integration
 
 on: [push]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-    strategy:
-      max-parallel: 3
-      matrix:
-        python-version: [3.7]
-
     steps:
-    - uses: actions/checkout@v1
-    - name: Set up Python ${{ matrix.python-version }}
+    - name: Git checkout
+      uses: actions/checkout@v1
+    - name: Set up Python 3.7
       uses: actions/setup-python@v1
       with:
-        python-version: ${{ matrix.python-version }}
+        python-version: 3.7
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip poetry
         poetry install
     - name: Lint with flake8 and Black
       run: |
-        pip install flake8
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-        black --check .
+        poetry run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        poetry run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=88 --statistics
+        poetry run black --check .
+        poetry run mypy --ignore-missing-imports --disallow-untyped-defs .
+
     - name: Test with pytest
       run: |
-        pytest
+        poetry run pytest --cov=./ --cov-report=xml
+    - name: Upload coverage to Codecov
+      run: echo "Codecov disabled"
+      # NOTE: Disabled for now
+      #   uses: codecov/[email protected]
+      #   with:
+      #     token: ${{secrets.CODECOV_TOKEN}}
+      #     file: ./coverage.xml
+      #     flags: unittests
+      #     name: python-aws-ssm

README.md

@@ -1,2 +1,3 @@
 # python-aws-ssm
+<a href="https://github.com/ambv/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 Python package that interfaces with AWS System Manager

poetry.lock

@@ -22,6 +22,7 @@ mypy = "^0.720.0"
 isort = "^4.3"
 black = "==19.3b0"
 flake8 = "^3.7"
+pytest-cov = "^2.7"
 
 [build-system]
 requires = ["poetry>=0.12"]

pyproject.toml

@@ -76,7 +76,7 @@ def _tree_dict(key_list: List[Any], value: Optional[Any]) -> Dict[Any, Any]:
         return tree_dict
 
     @staticmethod
-    def _deep_merge(a, b):
+    def _deep_merge(a: Union[Dict, Any], b: Union[Dict, Any]) -> Union[Dict, Any]:
         # NOTE: Thanks to: https://stackoverflow.com/a/56177639/9563578
         if not isinstance(a, dict) or not isinstance(b, dict):
             return a if b is None else b