Better Tox Integration

.github/workflows/lint-test.yaml

@@ -1,5 +1,5 @@
-name: lint-and-test
-run-name: Lint and Test
+name: ci-regressions
+run-name: Run CI Regressions
 on:
   pull_request:
     branches:
@@ -9,28 +9,36 @@ on:
       - main
 
 jobs:
-  lint:
-    name: Build Lint and Test Code
+  regressions:
+    name: CI Regression Tests
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
       - name: Setup Python
         uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+          cache: 'pip'
 
-      - name: Setup Poetry
-        uses: abatilo/actions-poetry@v2
+      - name: Grab Tox and Poetry
+        run: pip install tox poetry
 
-      - name: Install Dependencies
-        run: |
-          poetry install
+      - name: Lint and Test
+        run: tox
+        env:
+          MARKETSTACK_TOKEN_TEST: "${{ secrets.MARKETSTACK_TOKEN_TEST }}"
 
-      - name: Build Lint and Test
+      - name: Run a Build
+        run: poetry build
+
+      - name: Create a build-artifacts tarball
         run: |
-          make ci-build-lint-test
-        env:
-          MARKETSTACK_TOKEN_TEST: "${{ secrets.MarketstackFreeTestToken }}"
+          tar -czf \
+            build-artifacts.tar.gz \
+            test-artifacts-* \
+            dist
 
       - name: Upload Artifacts
         uses: actions/upload-artifact@v3

.gitignore

@@ -160,4 +160,5 @@ cython_debug/
 #.idea/
 
 # Build Artifact ignores
-build-artifacts
+build-artifacts*/
+build-artifacts.tar.gz

Makefile

@@ -24,5 +24,4 @@ build:
 	rm -rf build-artifacts/dist
 	mv dist build-artifacts/dist
 
-ci-build-lint-test: build lint test
-	tar -czf build-artifacts.tar.gz build-artifacts
+build-lint-test: build lint test

README.md

@@ -1,5 +1,8 @@
 # aiomarketstack
 
+![Python 3.6-3.11](.github/res/badges/python-version.svg)
+![Code Style](.github/res/badges/code-style.svg)
+
 `aiomarketstack` is a thin-and-light, Python-only `asyncio`-based
 [marketsack](https://marketstack.com/) client.
 
@@ -11,7 +14,26 @@ To get started, grab yourself a copy of `aiomarketstack`:
 pip install aiomarketstack
 ```
 
+## Development
+
+To manually build `aiomarketstack` for development, we use `poetry`. Get
+started with:
+
+```bash
+git clone https://github.com/markovejnovic/aiomarketstack.git
+cd aiomarketstack
+poetry install && poetry build
+```
 
+### Unit Tests
+
+You can test your code against test suite via `tox`.
+
+```bash
+MARKETSTACK_TOKEN_TEST=<Your-Marketstack-Free-Token> tox
+```
 
+> [!CAUTION]
+> This will consume about 30 API requests.
 
-## Dependencies
+The code is tested against `py38-311`.

pyproject.toml

@@ -7,18 +7,18 @@ readme = "README.md"
 packages = [{ include = "aiomarketstack" }]
 
 [tool.poetry.dependencies]
-python = "^3.8"
 aiohttp = {version = "^3.9.1", python = "^3.8"}
+python = "^3.8"
 structlog = {version = "^23.2.0", python = "^3.8"}
 typing-extensions = {version = "^4.8.0", python = "^3.8"}
 
 [tool.poetry.group.test.dependencies]
 mypy = {version = "^1.7.1", python = "^3.8"}
+numpy = {version = "^1.24", python = "^3.8"}
 pytest = {version = "^7.4.3", python = "^3.8"}
 pytest-asyncio = {version = "^0.23.1", python = "^3.8"}
 pytest-cov = {version = "^4.1.0", python = "^3.8"}
 ruff = {version = "^0.1.6", python = "^3.8"}
-numpy = {version = "^1.24", python = "^3.8"}
 
 [build-system]
 requires = ["poetry-core"]

tox.ini

@@ -0,0 +1,21 @@
+[tox]
+isolated_build = True
+envlist = py38,py39,py310,py311
+
+[testenv]
+deps =
+    mypy
+    numpy
+    pytest
+    pytest-asyncio
+    pytest-cov
+    ruff
+commands =
+    pytest \
+        --cov=aiomarketstack \
+        --cov-report=html:test-artifacts-{envname} \
+        --cov-report=term tests/
+    mypy aiomarketstack tests
+    ruff check .
+passenv =
+    MARKETSTACK_TOKEN_TEST