Feature/test suite (#11)

* basic tests for categories namespace

* add basic tests for tags api

* add basic tests for sources api namespace

* create basic tests for releases api namespace

* add basic tests for series api namespace

* create test for decorators

* use src for tests

* first full test-suite of basic API functionality, closes issue #8

* new CI for lint and test package

* upgrade black in CI, use fred api key from GH secrets

* reformat files

* update CI only test for 3.9 & 3.10

* only run CI with python 3.10.x

* run ci using coverage

* add coverage upload

* add new job skeleton to CI

* upload to PyPI when publishing new release/prerelease

Author: zachspar

.github/workflows/fred-py-api-package.yml

@@ -0,0 +1,66 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+
+name: Lint, Test & Upload fred-py-api
+
+on:
+  release:
+    types: [published]
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10"]
+    env:
+      FRED_API_KEY: ${{ secrets.FRED_API_KEY }}
+
+    steps:
+    - uses: actions/checkout@v3
+    - 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 --upgrade pip
+        python -m pip install requests coverage black==22.6.0
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with black
+      run: |
+        # Run black on all Python files
+        black --line-length 120 --check ./
+    - name: Test with coverage
+      run: |
+        coverage run -m unittest discover -s tests
+        coverage report -m
+    - name: Upload coverage report
+      uses: codecov/codecov-action@v2
+
+  pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release'
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fred_py_api"
-version = "0.0.5"
+version = "0.0.6"
 authors = [
   { name="Zachary Spar", email="[email protected]" },
 ]

src/fredapi/api/categories.py

@@ -22,7 +22,13 @@ class FredAPICategories(FredClient):
     @validate_api_args("api_key", "file_type", "category_id")
     def get_category(self, category_id: int = None, **kwargs) -> dict:
         """Get category by ID."""
-        return self._get(f"category", {"category_id": category_id, **kwargs,})
+        return self._get(
+            f"category",
+            {
+                "category_id": category_id,
+                **kwargs,
+            },
+        )
 
     @validate_api_args(
         "api_key",
@@ -41,17 +47,35 @@ def get_category(self, category_id: int = None, **kwargs) -> dict:
     )
     def get_category_series(self, category_id: int, **kwargs) -> dict:
         """Get category series by ID."""
-        return self._get(f"category/series", {"category_id": category_id, **kwargs,})
+        return self._get(
+            f"category/series",
+            {
+                "category_id": category_id,
+                **kwargs,
+            },
+        )
 
     @validate_api_args("api_key", "file_type", "category_id", "realtime_start", "realtime_end")
     def get_category_children(self, category_id: int = None, **kwargs) -> dict:
         """Get category children by ID."""
-        return self._get(f"category/children", {"category_id": category_id, **kwargs,})
+        return self._get(
+            f"category/children",
+            {
+                "category_id": category_id,
+                **kwargs,
+            },
+        )
 
     @validate_api_args("api_key", "file_type", "category_id", "realtime_start", "realtime_end")
     def get_category_related(self, category_id: int, **kwargs) -> dict:
         """Get category related by ID."""
-        return self._get(f"category/related", {"category_id": category_id, **kwargs,})
+        return self._get(
+            f"category/related",
+            {
+                "category_id": category_id,
+                **kwargs,
+            },
+        )
 
     @validate_api_args(
         "api_key",
@@ -75,7 +99,13 @@ def get_category_related(self, category_id: int, **kwargs) -> dict:
     )
     def get_category_tags(self, category_id: int, **kwargs) -> dict:
         """Get category tags by ID."""
-        return self._get(f"category/tags", {"category_id": category_id, **kwargs,})
+        return self._get(
+            f"category/tags",
+            {
+                "category_id": category_id,
+                **kwargs,
+            },
+        )
 
     @validate_api_args(
         "api_key",
@@ -100,4 +130,11 @@ def get_category_tags(self, category_id: int, **kwargs) -> dict:
     )
     def get_category_related_tags(self, category_id: int, tag_names: str, **kwargs) -> dict:
         """Get category related tags by ID."""
-        return self._get(f"category/related_tags", {"category_id": category_id, "tag_names": tag_names, **kwargs,})
+        return self._get(
+            f"category/related_tags",
+            {
+                "category_id": category_id,
+                "tag_names": tag_names,
+                **kwargs,
+            },
+        )

src/fredapi/api/fred_client.py

@@ -4,6 +4,7 @@
 """
 from http import HTTPStatus
 from os import environ
+from typing import Optional
 
 import requests
 
@@ -13,7 +14,7 @@
 class FredClient(object):
     """Base Fred API."""
 
-    def __init__(self, api_key: str = None, base_client=None):
+    def __init__(self, api_key: str = None, base_client: Optional["FredClient"] = None):
         """Init client."""
         if not base_client and not api_key:
             api_key = environ.get("FRED_API_KEY", None)
@@ -39,6 +40,8 @@ def get_api_key(self) -> str:
 
     def _get(self, endpoint: str = None, payload: dict = None) -> dict:
         """Invoke client get request."""
+        if not payload:
+            payload = {}
         try:
             resp = requests.get(f"{self.base_url}/{endpoint}", params={**self.base_params, **payload})
         except requests.exceptions.RequestException as e:

src/fredapi/api/releases.py

@@ -27,7 +27,12 @@ class FredAPIReleases(FredClient):
     )
     def get_releases(self, **kwargs) -> dict:
         """Get releases."""
-        return self._get(f"releases", {**kwargs,})
+        return self._get(
+            f"releases",
+            {
+                **kwargs,
+            },
+        )
 
     @validate_api_args(
         "api_key",
@@ -42,12 +47,23 @@ def get_releases(self, **kwargs) -> dict:
     )
     def get_releases_dates(self, **kwargs) -> dict:
         """Get releases dates."""
-        return self._get(f"releases/dates", {**kwargs,})
+        return self._get(
+            f"releases/dates",
+            {
+                **kwargs,
+            },
+        )
 
     @validate_api_args("api_key", "release_id", "file_type", "realtime_start", "realtime_end")
     def get_release(self, release_id: int, **kwargs) -> dict:
         """Get release by ID."""
-        return self._get(f"release", {"release_id": release_id, **kwargs,})
+        return self._get(
+            f"release",
+            {
+                "release_id": release_id,
+                **kwargs,
+            },
+        )
 
     @validate_api_args(
         "api_key",
@@ -62,7 +78,13 @@ def get_release(self, release_id: int, **kwargs) -> dict:
     )
     def get_release_dates(self, release_id: int, **kwargs) -> dict:
         """Get release dates by ID."""
-        return self._get(f"release/dates", {"release_id": release_id, **kwargs,})
+        return self._get(
+            f"release/dates",
+            {
+                "release_id": release_id,
+                **kwargs,
+            },
+        )
 
     @validate_api_args(
         "api_key",
@@ -81,12 +103,24 @@ def get_release_dates(self, release_id: int, **kwargs) -> dict:
     )
     def get_release_series(self, release_id: int, **kwargs) -> dict:
         """Get release series by ID."""
-        return self._get(f"release/series", {"release_id": release_id, **kwargs,})
+        return self._get(
+            f"release/series",
+            {
+                "release_id": release_id,
+                **kwargs,
+            },
+        )
 
     @validate_api_args("api_key", "file_type", "release_id", "realtime_start", "realtime_end")
     def get_release_sources(self, release_id: int, **kwargs) -> dict:
         """Get release sources by ID."""
-        return self._get(f"release/sources", {"release_id": release_id, **kwargs,})
+        return self._get(
+            f"release/sources",
+            {
+                "release_id": release_id,
+                **kwargs,
+            },
+        )
 
     @validate_api_args(
         "api_key",
@@ -104,7 +138,13 @@ def get_release_sources(self, release_id: int, **kwargs) -> dict:
     )
     def get_release_tags(self, release_id: int, **kwargs) -> dict:
         """Get release tags by ID."""
-        return self._get(f"release/tags", {"release_id": release_id, **kwargs,})
+        return self._get(
+            f"release/tags",
+            {
+                "release_id": release_id,
+                **kwargs,
+            },
+        )
 
     @validate_api_args(
         "api_key",
@@ -123,11 +163,25 @@ def get_release_tags(self, release_id: int, **kwargs) -> dict:
     )
     def get_release_related_tags(self, release_id: int, tag_names: str, **kwargs) -> dict:
         """Get release related tags by ID."""
-        return self._get(f"release/related_tags", {"release_id": release_id, "tag_names": tag_names, **kwargs,})
+        return self._get(
+            f"release/related_tags",
+            {
+                "release_id": release_id,
+                "tag_names": tag_names,
+                **kwargs,
+            },
+        )
 
     @validate_api_args(
         "api_key", "file_type", "release_id", "element_id", "include_observation_values", "observation_date"
     )
     def get_release_tables(self, release_id: int, element_id: int = None, **kwargs) -> dict:
         """Get release tables by ID."""
-        return self._get(f"release/tables", {"release_id": release_id, "element_id": element_id, **kwargs,})
+        return self._get(
+            f"release/tables",
+            {
+                "release_id": release_id,
+                "element_id": element_id,
+                **kwargs,
+            },
+        )