Add Github Actions

Author: saintamh

.github/workflows/github-actions.yml

@@ -0,0 +1,40 @@
+name: Hublot
+
+on: [push, pull_request]
+
+jobs:
+  build-and-test:
+
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install pip==24.3.1
+        python -m pip install -r test/requirements.txt
+        python -m pip install .[pycurl]
+    - name: Lint
+      run: |
+        ruff check hublot/ test/
+        ruff format --check --line-length=132 hublot/ test/
+        pylint hublot/ test/
+        mypy --show-error-codes hublot/ test/
+    - name: Test
+      run: |
+        pytest --cov=hublot \
+            --cov-report json:coverage/ocerage.json \
+            --cov-report xml:coverage/coverage.xml \
+            --cov-report term \
+            test/
+    - name: Update Coverage Badge
+      #if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+      uses: we-cli/coverage-badge-action@main

.gitignore

@@ -1,4 +1,5 @@
 *.egg-info/
+coverage/
 .coverage
 __pycache__
 build/

.pre-commit-config.yaml

@@ -3,11 +3,19 @@ repos:
 
 - repo: local
   hooks:
-  - id: ruff
-    name: ruff
+  - id: ruff-check
+    name: ruff-check
     entry: ruff
     language: python
     types: [python]
+    args: [check]
+
+  - id: ruff-format
+    name: ruff-format
+    entry: ruff
+    language: python
+    types: [python]
+    args: [format]
 
   - id: pylint
     name: pylint
@@ -22,13 +30,6 @@ repos:
     types: [python]
     args: [--show-error-codes]
 
-  - id: black
-    name: black
-    entry: black
-    language: python
-    types: [python]
-    args: [--line-length=132]
-
   - id: pytest
     name: pytest
     entry: pytest

hublot/cache/cache.py

@@ -13,7 +13,6 @@
 
 
 class Cache:
-
     def __init__(
         self,
         storage: Storage,

hublot/cache/key.py

@@ -16,7 +16,6 @@
 
 @dataclass(frozen=True, order=True)
 class CacheKey:
-
     parts: Tuple[str, ...]
     sequence_num: int = 0
 

hublot/cache/storage.py

@@ -16,22 +16,24 @@
 
 
 class Storage(ABC):  # pragma: no-cover
-
     @abstractmethod
-    def read(self, key: CacheKey, max_age: Optional[timedelta] = None) -> Optional[Response]: ...
+    def read(self, key: CacheKey, max_age: Optional[timedelta] = None) -> Optional[Response]:
+        ...
 
     @abstractmethod
-    def write(self, key: CacheKey, response: Response) -> None: ...
+    def write(self, key: CacheKey, response: Response) -> None:
+        ...
 
     @abstractmethod
-    def iter_all_keys(self) -> Iterable[CacheKey]: ...
+    def iter_all_keys(self) -> Iterable[CacheKey]:
+        ...
 
     @abstractmethod
-    def prune(self, max_age: timedelta) -> None: ...
+    def prune(self, max_age: timedelta) -> None:
+        ...
 
 
 class DiskStorage(Storage):
-
     def __init__(self, root_path: Path) -> None:
         self.root_path = root_path
 

hublot/decorator.py

@@ -22,7 +22,6 @@ class ThreadLocalStackFrame:
 
 
 class ThreadLocalStack(threading.local):
-
     def __init__(self) -> None:
         super().__init__()
         # each thread will magically get a different stack

hublot/engines/base.py

@@ -10,7 +10,6 @@
 
 
 class Engine(ABC):
-
     id: ClassVar[str]
 
     @abstractmethod

hublot/engines/curlcmd.py

@@ -26,7 +26,6 @@ class CurlCmdEngineError(HublotException):
 
 
 class CurlCmdEngine(Engine):
-
     id = "curlcmd"
 
     def __init__(self, curl_cmd: str = "curl") -> None:

hublot/engines/pool.py

@@ -12,7 +12,6 @@
 
 
 class EnginePool(Engine):
-
     id = "engine-pool"
 
     def __init__(self, engines: Sequence[Engine]):