Feature/packaging (#37)

* Add tox setup POC

* Fix syntax to be compatible with Python >= 3.10

* No need to include py3.6 or 3.7 in tox because they reached EOL already

* Refactor syntax to be compatible with Python >= 3.9

* Remove no longer needed TODO

* Remove py3.8 from tox configuration

* Update Github workflow to run test matrix using tox

* Update requirements.txt after adding tox

* Update pyproject.toml file

* Update Github workflow to use pip caching

Author: ebram96

.github/actions/setup/action.yml

@@ -0,0 +1,28 @@
+name: 'Setup'
+description: 'Set up Python and install dependencies'
+inputs:
+  python-version:
+    description: 'Version of Python to set up'
+    required: true
+runs:
+  using: 'composite'
+  steps:
+    - name: Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Restore Dependencies Cache
+      uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip/
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
+    - name: Install Dependencies
+      run: |
+        pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install -e .
+      shell: bash

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Unit Tests, Test Coverage, and Pre-Commit Hooks
+name: CI
 
 on:
   pull_request:
@@ -10,27 +10,49 @@ on:
       - closed
 
 jobs:
-  build:
+  cache-dependencies:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-
-      - name: Setup Python
-        uses: actions/setup-python@v4
+      - uses: ./.github/actions/setup
         with:
-          python-version: "3.12"
+          python-version: "3.9"
 
-      - name: Install Dependencies
-        run: |
-          pip install -e .
-          pip install -r requirements.txt
-          pre-commit install
+  main:
+    needs: cache-dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ./.github/actions/setup
+        with:
+          python-version: "3.9"
 
-      - name: Run Unit Tests
+      - name: Unit Tests
         run: coverage run -m pytest -s tests
 
       - name: Test Coverage
         run: coverage report --fail-under=96
 
-      - name: Run Pre-Commit Hooks
-        run: pre-commit run --all-files
+      - name: Pre-Commit Hooks
+        run: |
+          pre-commit install
+          pre-commit run --all-files
+
+  test-matrix:
+    needs: cache-dependencies
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ "3.10", "3.11", "3.12" ]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ./.github/actions/setup
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run Test Matrix
+        run: |
+          pytest -s tests
+          pre-commit run mypy --all-files

.gitignore

@@ -12,3 +12,6 @@ __pycache__/
 
 # Coverage.py
 .coverage
+
+# Tox
+.tox

.pre-commit-config.yaml

@@ -6,8 +6,6 @@ repos:
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
 
-# TODO: Add check-hooks-apply and check-useless-excludes
-
 -   repo: https://github.com/PyCQA/flake8
     rev: 6.1.0
     hooks:

pyproject.toml

@@ -1,21 +1,37 @@
 [build-system]
 requires = ["setuptools>=68.2.2"]
 build-backend = "setuptools.build_meta"
+
 [project]
 name = "abstract-api"
-version = "0.0.1"
+version = "1.0.0"
+license = {file = "LICENSE"}
 authors = [
   { name="Ebram Shehata", email="ebram96@gmail.com" },
 ]
-description = "A Python SDK for using AbstractAPI services"
+maintainers = [
+  { name="Ebram Shehata", email="ebram96@gmail.com" },
+]
+keywords = ["sdk", "abstract", "api", "abstract api"]
+description = "Python SDK for using AbstractAPI services"
 readme = "README.md"
-requires-python = ">=3.6"
+requires-python = ">=3.9"
 classifiers = [
     "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+]
+dependencies = [
+    "requests>=2.31.0"
 ]
 
 [project.urls]
-"Homepage" = "https://github.com/ebram96/AbstractAPI-Python-SDK"
+Homepage = "https://github.com/ebram96/AbstractAPI-Python-SDK"
 "Bug Tracker" = "https://github.com/ebram96/AbstractAPI-Python-SDK/issues"
+Repository = "https://github.com/ebram96/AbstractAPI-Python-SDK.git"

requirements.txt

@@ -1,8 +1,12 @@
+cachetools==5.3.2
 certifi==2023.11.17
 cfgv==3.4.0
+chardet==5.2.0
 charset-normalizer==3.3.2
+colorama==0.4.6
 coverage==7.4.0
 distlib==0.3.8
+exceptiongroup==1.2.0
 filelock==3.13.1
 identify==2.5.33
 idna==3.6
@@ -12,12 +16,14 @@ packaging==23.2
 platformdirs==4.1.0
 pluggy==1.3.0
 pre-commit==3.6.0
+pyproject-api==1.6.1
 pytest==7.4.4
 pytest-mock==3.12.0
 PyYAML==6.0.1
 requests==2.31.0
 requests-mock==1.11.0
-setuptools==69.0.3
 six==1.16.0
+tomli==2.0.1
+tox==4.12.0
 urllib3==2.1.0
 virtualenv==20.25.0

src/abstract_api/avatars/avatars.py

@@ -1,4 +1,4 @@
-from typing import ClassVar
+from typing import ClassVar, Optional
 
 from ..core.bases import BaseService
 from ..core.exceptions import ClientRequestError
@@ -42,16 +42,16 @@ def _validate_params(**kwargs) -> None:
     def create(
         self,
         name: str,
-        image_size: int | None = None,
-        image_format: str | None = None,
-        font_size: float | None = None,
-        char_limit: int | None = None,
-        background_color: str | None = None,
-        font_color: str | None = None,
-        is_rounded: bool | None = None,
-        is_uppercase: bool | None = None,
-        is_italic: bool | None = None,
-        is_bold: bool | None = None
+        image_size: Optional[int] = None,
+        image_format: Optional[str] = None,
+        font_size: Optional[float] = None,
+        char_limit: Optional[int] = None,
+        background_color: Optional[str] = None,
+        font_color: Optional[str] = None,
+        is_rounded: Optional[bool] = None,
+        is_uppercase: Optional[bool] = None,
+        is_italic: Optional[bool] = None,
+        is_bold: Optional[bool] = None
     ) -> AvatarsResponse:
         """Create a new avatar with the given parameters.
 

src/abstract_api/company_enrichment/company_enrichment.py

@@ -1,4 +1,4 @@
-from typing import ClassVar, Iterable
+from typing import ClassVar, Iterable, Optional
 
 from ..core.bases import BaseService
 from ..core.mixins import ResponseFieldsMixin
@@ -25,7 +25,7 @@ class CompanyEnrichment(
     def check(
         self,
         domain: str,
-        fields: Iterable[str] | None = None
+        fields: Optional[Iterable[str]] = None
     ) -> CompanyEnrichmentResponse:
         """Finds a company's details using its domain.
 

src/abstract_api/company_enrichment/company_enrichment_response.py

@@ -1,4 +1,5 @@
 from functools import cached_property
+from typing import Optional
 
 from ..core.bases import JSONResponse
 
@@ -7,41 +8,41 @@ class CompanyEnrichmentResponse(JSONResponse):
     """Company enrichment service response."""
 
     @cached_property
-    def name(self) -> str | None:
+    def name(self) -> Optional[str]:
         """The name of the company."""
         return self._get_response_field("name")
 
     @cached_property
-    def domain(self) -> str | None:
+    def domain(self) -> Optional[str]:
         """The domain the company website is hosted on."""
         return self._get_response_field("domain")
 
     @cached_property
-    def year_founded(self) -> int | None:
+    def year_founded(self) -> Optional[int]:
         """The year the company was founded."""
         return self._get_response_field("year_founded")
 
     @cached_property
-    def industry(self) -> str | None:
+    def industry(self) -> Optional[str]:
         """The industry the company is operating in."""
         return self._get_response_field("industry")
 
     @cached_property
-    def employees_count(self) -> int | None:
+    def employees_count(self) -> Optional[int]:
         """The approximate number of employees of the company."""
         return self._get_response_field("employees_count")
 
     @cached_property
-    def locality(self) -> str | None:
+    def locality(self) -> Optional[str]:
         """The city or region the company headquarter is based in."""
         return self._get_response_field("locality")
 
     @cached_property
-    def country(self) -> str | None:
+    def country(self) -> Optional[str]:
         """The country the company is based in."""
         return self._get_response_field("country")
 
     @cached_property
-    def linkedin_url(self) -> str | None:
+    def linkedin_url(self) -> Optional[str]:
         """The LinkedIn URL of the company."""
         return self._get_response_field("linkedin_url")

src/abstract_api/core/bases/base_service.py

@@ -1,7 +1,16 @@
 import os
 from functools import lru_cache
 from io import BytesIO
-from typing import TYPE_CHECKING, Any, ClassVar, Final, Generic, Type, TypeVar
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    ClassVar,
+    Final,
+    Generic,
+    Optional,
+    Type,
+    TypeVar
+)
 
 import requests
 from requests import codes
@@ -34,7 +43,7 @@ class BaseService(Generic[BaseResponseT]):
     _service_name_env_var: ClassVar[str]
 
     @classmethod
-    def _read_api_key_from_env(cls) -> str | None:
+    def _read_api_key_from_env(cls) -> Optional[str]:
         """Reads service API key from environment variables.
 
         API key exposed as an environment variable must be exposed using a
@@ -50,7 +59,7 @@ def _read_api_key_from_env(cls) -> str | None:
             pattern.format(service_name=cls._service_name_env_var)
         )
 
-    def __init__(self, api_key: str | None = None) -> None:
+    def __init__(self, api_key: Optional[str] = None) -> None:
         """Constructs a BaseService.
 
         Args:
@@ -80,10 +89,10 @@ def __service_url(self, action: str = "") -> str:
     def _service_request(
         self,
         _response_class: Type[BaseResponseT],
-        _response_class_kwargs: dict[str, Any] | None = None,
+        _response_class_kwargs: Optional[dict[str, Any]] = None,
         _method: str = "GET",
-        _body: dict[str, Any] | None = None,
-        _files: dict[str, BytesIO] | None = None,
+        _body: Optional[dict[str, Any]] = None,
+        _files: Optional[dict[str, BytesIO]] = None,
         _action: str = "",
         **params
     ) -> BaseResponseT: