CI and code formatting: add isort and flake8 checks to CI pipeline

.github/workflows/run-checks.yml

@@ -30,6 +30,14 @@ jobs:
       run: |
         pipenv check
 
+    - name: Check code formatting
+      run: |
+        pipenv run flake8 src/codemagic tests
+
+    - name: Check imports sort order
+      run: |
+        pipenv run isort src/codemagic tests --check-only
+
     - name: Static type checks with mypy
       env:
         MYPYPATH: stubs

Pipfile

@@ -13,6 +13,11 @@ pytest = "*"
 pytest-cov = "*"
 mdutils = "*"
 pipenv = "*"
+isort = "*"
+flake8 = "*"
+flake8-commas = "*"
+flake8-quotes = "*"
+pep8-naming = "*"
 
 [packages]
 pyopenssl = "~=19.0"

setup.cfg

@@ -0,0 +1,13 @@
+[isort]
+line_length=120
+force_single_line=True
+
+[flake8]
+max_line_length=120
+per-file-ignores =
+    # F401 imported but unused
+    __init__.py:F401
+    src/codemagic/apple/resources/__init__.py:F401
+    # N815 variable in class scope should not be mixedCase
+    src/codemagic/apple/resources/*.py:N815
+    src/codemagic/models/export_options.py:N815

src/codemagic/__version__.py

@@ -1,5 +1,5 @@
-__title__ = "codemagic-cli-tools"
-__description__ = "CLI tools used in Codemagic builds"
-__version__ = "0.4.6"
+__title__ = 'codemagic-cli-tools'
+__description__ = 'CLI tools used in Codemagic builds'
+__version__ = '0.4.6'
 __url__ = 'https://github.com/codemagic-ci-cd/cli-tools'
 __licence__ = 'GNU General Public License v3.0'

src/codemagic/apple/app_store_connect/api_client.py

@@ -11,6 +11,7 @@
 import jwt
 
 from codemagic.utilities import log
+
 from .api_session import AppStoreConnectApiSession
 from .builds import Builds
 from .provisioning import BundleIdCapabilities
@@ -86,7 +87,7 @@ def _get_jwt_payload(self) -> Dict:
         return {
             'iss': self._issuer_id,
             'exp': self._get_timestamp(),
-            'aud': AppStoreConnectApiClient.JWT_AUDIENCE
+            'aud': AppStoreConnectApiClient.JWT_AUDIENCE,
         }
 
     def generate_auth_headers(self) -> Dict[str, str]:

src/codemagic/apple/app_store_connect/api_session.py

@@ -6,6 +6,7 @@
 import requests
 
 from codemagic.utilities import log
+
 from .api_error import AppStoreConnectApiError
 
 

src/codemagic/apple/app_store_connect/provisioning/bundle_id_capabilities.py

@@ -35,7 +35,7 @@ def enable(self,
         if capability_settings is not None:
             attributes['settings'] = capability_settings.dict()
         relationships = {
-            'bundleId': {'data': self._get_attribute_data(bundle_id, ResourceType.BUNDLE_ID)}
+            'bundleId': {'data': self._get_attribute_data(bundle_id, ResourceType.BUNDLE_ID)},
         }
         payload = self._get_create_payload(
             ResourceType.BUNDLE_ID_CAPABILITIES, attributes=attributes, relationships=relationships)

src/codemagic/apple/app_store_connect/provisioning/bundle_ids.py

@@ -1,9 +1,9 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
+from typing import TYPE_CHECKING
 from typing import List
 from typing import Optional
-from typing import TYPE_CHECKING
 from typing import Type
 from typing import Union
 
@@ -61,7 +61,7 @@ def create(self,
             attributes['seedId'] = seed_id
         response = self.client.session.post(
             f'{self.client.API_URL}/bundleIds',
-            json=self._get_create_payload(ResourceType.BUNDLE_ID, attributes=attributes)
+            json=self._get_create_payload(ResourceType.BUNDLE_ID, attributes=attributes),
         ).json()
         return BundleId(response['data'], created=True)
 

src/codemagic/apple/app_store_connect/provisioning/devices.py

@@ -49,7 +49,7 @@ def create(self, name: str, platform: BundleIdPlatform, udid: str) -> Device:
         }
         response = self.client.session.post(
             f'{self.client.API_URL}/devices',
-            json=self._get_create_payload(ResourceType.DEVICES, attributes=attributes)
+            json=self._get_create_payload(ResourceType.DEVICES, attributes=attributes),
         ).json()
         return Device(response['data'], created=True)
 

src/codemagic/apple/app_store_connect/provisioning/profiles.py

@@ -61,18 +61,18 @@ def create(self,
             devices = []
         attributes = {
             'name': name,
-            'profileType': profile_type.value
+            'profileType': profile_type.value,
         }
         relationships = {
             'bundleId': {
-                'data': self._get_attribute_data(bundle_id, ResourceType.BUNDLE_ID)
+                'data': self._get_attribute_data(bundle_id, ResourceType.BUNDLE_ID),
             },
             'certificates': {
-                'data': [self._get_attribute_data(c, ResourceType.CERTIFICATES) for c in certificates]
+                'data': [self._get_attribute_data(c, ResourceType.CERTIFICATES) for c in certificates],
             },
             'devices': {
-                'data': [self._get_attribute_data(d, ResourceType.DEVICES) for d in devices]
-            }
+                'data': [self._get_attribute_data(d, ResourceType.DEVICES) for d in devices],
+            },
         }
         payload = self._get_create_payload(
             ResourceType.PROFILES, attributes=attributes, relationships=relationships)