Merge pull request #14 from suaaa7/13_python_ci

Python CI with flake8 and mypy

Author: suaaa7

.github/workflows/python_ci.yml

@@ -0,0 +1,32 @@
+name: Python CI
+on: [pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-18.04
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+        architecture: 'x64'
+    - name: Install Library
+      run: |
+        cd python_ci
+        python3 -m pip install --upgrade pip
+        pip install -r requirements-dev.txt
+        pip install -r requirements.txt
+    - name: Run flake8
+      run: |
+        cd python_ci
+        make flake8
+    - name: Run mypy
+      run: |
+        cd python_ci
+        make mypy
+    - name: Run unittest
+      run: |
+        cd python_ci
+        make test

python_ci/Dockerfile

@@ -0,0 +1,8 @@
+FROM python:3.8-slim
+
+COPY requirements.txt .
+COPY requirements-dev.txt .
+
+RUN pip install --no-cache-dir --upgrade pip setuptools wheel \
+  && pip install --no-cache-dir -r requirements.txt \
+  && pip install --no-cache-dir -r requirements-dev.txt

python_ci/Makefile

@@ -0,0 +1,27 @@
+image = python-ci
+tag = 0.1.0
+curdir := `pwd`
+
+.PHONY: dbuild
+dbuild:
+	docker build -t $(image):$(tag) .
+
+.PHONY: drun
+drun:
+	docker run --rm -it -v $(curdir):/opt -w /opt $(image):$(tag) bash
+
+.PHONY: drmi
+drmi:
+	docker rmi -f $(image):$(tag)
+
+.PHONY: flake8
+flake8:
+	flake8 --config=config/tox.ini src
+
+.PHONY: mypy
+mypy:
+	mypy --config=config/mypy.ini src
+
+.PHONY: test
+test:
+	python3 -m unittest discover --verbose src

python_ci/config/mypy.ini

@@ -0,0 +1,9 @@
+[mypy]
+python_version = 3.8
+disallow_untyped_defs = True
+ignore_missing_imports = True
+warn_redundant_casts = True
+no_implicit_optional = True
+
+[mypy-src.tests.*]
+disallow_untyped_defs = False

python_ci/config/tox.ini

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 79
+per-file-ignores =
+    src/tests/*:E501

python_ci/requirements-dev.txt

@@ -0,0 +1,2 @@
+flake8==3.8.3
+mypy==0.782

python_ci/requirements.txt

@@ -0,0 +1 @@
+requests==2.24.0

python_ci/src/__init__.py

@@ -0,0 +1,44 @@
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class BaseConfig:
+    version: str
+    model_path: str
+    model_s3_bucket: str
+    model_file_name: str
+
+    def generate_model_path(self) -> str:
+        return "{}/{}/{}".format(
+            self.model_path,
+            self.version,
+            self.model_file_name
+        )
+
+    def generate_model_s3_path(self) -> str:
+        return "s3://{}/{}/{}".format(
+            self.model_s3_bucket,
+            self.version,
+            self.model_file_name
+        )
+
+
+@dataclass(frozen=True)
+class Train:
+    batch_size: int = 16
+    epoch: int = 10
+
+
+@dataclass(frozen=True)
+class Test:
+    batch_size: int = 16
+
+
+@dataclass(frozen=True)
+class Config(BaseConfig):
+    version: str = "v1.0.0"
+    model_path: str = "/ops/models"
+    model_s3_bucket: str = "models"
+    model_file_name: str = "model.pth"
+    train: Train = Train()
+    test: Test = Test()

python_ci/src/config.py

@@ -0,0 +1,10 @@
+import requests
+
+
+class Sample:
+    def fetch_json(self, url: str) -> dict:
+        response = self._get_response(url)
+        return response.json()
+
+    def _get_response(self, url: str) -> requests.models.Response:
+        return requests.get(url)