feat(Quality): Add Quality Tools: iSort (#4)

Automatic import ordering.

PR: #4

.flake8

@@ -16,3 +16,4 @@ ignore =
 
 require-plugins =
     flake8-bugbear
+    flake8-isort

QUALITY.md

@@ -1,6 +1,15 @@
-# Run Quality Checks
+# Quality Checks
+
+### Running the Checks
 
 To run the code quality checks, run the following command:
+
 ```bash
 flake8
-```
+```
+
+### Fixing Code Quality Issues
+
+- If you have `isort` installed, you can run `isort .` to automatically fix import order issues.
+    - `flake8` will report `isort` related issues as `I` errors.
+- You may fix other issues manually.

generator/scripts/add-imports.py

@@ -17,8 +17,8 @@
 
 """Add imports to all generated models."""
 
-import pathlib
 import ast
+import pathlib
 import sys
 
 

openworld/sdk/core/client/api.py

@@ -13,21 +13,22 @@
 # limitations under the License.
 
 import logging
+from datetime import datetime
 from enum import Enum
-import requests
+from http import HTTPStatus
 from typing import Any, Dict, Optional
-from datetime import datetime
 
+import requests
+
+from openworld.sdk.core.client.auth_client import _AuthClient
+from openworld.sdk.core.configuration.client_config import ClientConfig
 from openworld.sdk.core.constant import header as header_constant
-from openworld.sdk.core.util import log as log_util
 from openworld.sdk.core.constant import log as log_constant
-from http import HTTPStatus
 from openworld.sdk.core.constant.constant import OK_STATUS_CODES_RANGE
-from openworld.sdk.core.client.auth_client import _AuthClient
 from openworld.sdk.core.model.authentication import HttpBearerAuth
-from openworld.sdk.core.configuration.client_config import ClientConfig
-from openworld.sdk.core.model.exception import service as service_exception
 from openworld.sdk.core.model.error import Error
+from openworld.sdk.core.model.exception import service as service_exception
+from openworld.sdk.core.util import log as log_util
 
 LOG = logging.getLogger(__name__)
 

openworld/sdk/core/client/auth_client.py

@@ -13,21 +13,19 @@
 # limitations under the License.
 
 import logging
-
 from http import HTTPStatus
 
 from requests import Response, post
 from requests.auth import HTTPBasicAuth
 
-from openworld.sdk.core.constant import (body as body_constant,
-                                         url as url_constant,
-                                         log as log_constant)
-from openworld.sdk.core.util import log as log_util
+from openworld.sdk.core.constant import body as body_constant
+from openworld.sdk.core.constant import log as log_constant
+from openworld.sdk.core.constant import url as url_constant
 from openworld.sdk.core.constant.constant import OK_STATUS_CODES_RANGE
 from openworld.sdk.core.constant.message import UNABLE_TO_AUTHENTICATE
-from openworld.sdk.core.model.authentication import Credentials
-from openworld.sdk.core.model.authentication import Token
+from openworld.sdk.core.model.authentication import Credentials, Token
 from openworld.sdk.core.model.exception import service as service_exception
+from openworld.sdk.core.util import log as log_util
 
 LOG = logging.getLogger(__name__)
 

openworld/sdk/core/configuration/auth_config.py

@@ -12,12 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from dataclasses import dataclass
+
 from openworld.sdk.core.constant import message
-from openworld.sdk.core.model.authentication import Credentials
 from openworld.sdk.core.constant.constant import EMPTY_STRING
 from openworld.sdk.core.constant.url import AUTH_ENDPOINT
-from dataclasses import dataclass
-
+from openworld.sdk.core.model.authentication import Credentials
 from openworld.sdk.core.model.exception import client as client_exception
 
 DEFAULT_CREDENTIALS = Credentials(key=EMPTY_STRING, secret=EMPTY_STRING)

openworld/sdk/core/configuration/client_config.py

@@ -12,10 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Optional
 from dataclasses import dataclass
+from typing import Optional
+
 from openworld.sdk.core.configuration.auth_config import AuthConfig
-from openworld.sdk.core.constant import url, message
+from openworld.sdk.core.constant import message, url
 from openworld.sdk.core.model.authentication import Credentials
 from openworld.sdk.core.model.exception import client as client_exception
 

openworld/sdk/core/constant/body.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 from typing import Dict
+
 from openworld.sdk.core.constant import header
 
 TOKEN_REQUEST: Dict = {header.GRANT_TYPE: header.CLIENT_CREDENTIALS}

openworld/sdk/core/model/authentication.py

@@ -12,18 +12,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import requests
 import datetime
 import logging
-from openworld.sdk.core.constant import log
 from dataclasses import dataclass
-from dataclasses_json import dataclass_json
-from typing import Dict, Optional
 from multiprocessing import Lock
+from typing import Dict, Optional
 
+import requests
+from dataclasses_json import dataclass_json
 from requests.auth import AuthBase
 
-from openworld.sdk.core.constant import header
+from openworld.sdk.core.constant import header, log
 from openworld.sdk.core.constant.constant import REFRESH_TOKEN_TIME_GAP_IN_SECONDS
 
 LOG = logging.getLogger(__name__)

openworld/sdk/core/model/error.py

@@ -12,9 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Optional
-from enum import Enum
 from dataclasses import dataclass
+from enum import Enum
+from typing import Optional
+
 from dataclasses_json import dataclass_json
 
 

pyproject.toml

@@ -0,0 +1,3 @@
+[tool.isort]
+profile = "black"
+multi_line_output = 1

requirements.txt

@@ -6,4 +6,5 @@ setuptools
 virtualenv
 coverage
 flake8~=6.0.0
-flake8-bugbear~=22.12.6
+flake8-bugbear~=22.12.6
+flake8-isort~=6.0.0