Feature/full api stubs (#6)

* add boilerplate for all APIs, cleanup package layout
* remove config.API_KEY ref

Author: zachspar

src/fredapi/api/__init__.py

@@ -2,7 +2,18 @@
 """
 Fred API core.
 """
-from .category import FredAPICategory
-from .release import FredAPIRelease
+from .categories import FredAPICategories
+from .exceptions import BaseFredAPIError, FredAPIRequestError
+from .releases import FredAPIReleases
 from .series import FredAPISeries
-from .fred_py_api import FredAPI
+from .sources import FredAPISources
+from .tags import FredAPITags
+
+
+class FredAPI(FredAPISeries, FredAPIReleases, FredAPICategories, FredAPISources, FredAPITags):
+    """
+    Fred API.
+    https://fred.stlouisfed.org/docs/api/fred/
+    """
+
+    pass

src/fredapi/api/categories.py

@@ -0,0 +1,55 @@
+#!/usr/bin/env python3
+"""
+Fred API for Categories Namespace.
+"""
+from .fred_client import FredClient
+
+
+class FredAPICategories(FredClient):
+    """
+    Fred API Categories Namespace.
+
+    Endpoints:
+        fred/category - Get a category.
+        fred/category/children - Get the child categories for a specified parent category.
+        fred/category/related - Get the related categories for a category.
+        fred/category/series - Get the series in a category.
+        fred/category/tags - Get the tags for a category.
+        fred/category/related_tags - Get the related tags for a category.
+    """
+
+    def get_category(self, category_id: int = None, **kwargs) -> dict:
+        """Get category by ID."""
+        return self._get(f"category", {
+            "category_id": category_id,
+            **kwargs,
+        })
+
+    def get_category_series(self, category_id: int = None, **kwargs) -> dict:
+        """Get category series by ID."""
+        return self._get(f"category/series", {
+            "category_id": category_id,
+            **kwargs,
+        })
+
+    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,
+        })
+
+    def get_category_related(self, category_id: int = None, **kwargs) -> dict:
+        """Get category related by ID."""
+        return self._get(f"category/related", {
+            "category_id": category_id,
+            **kwargs,
+        })
+
+    def get_category_tags(self, category_id: int = None, **kwargs) -> dict:
+        """Get category tags by ID."""
+        raise NotImplementedError("get_category_tags endpoint is not yet implemented.")
+
+    def get_category_related_tags(self, category_id: int = None, **kwargs) -> dict:
+        """Get category related tags by ID."""
+        raise NotImplementedError("get_category_related_tags endpoint is not yet implemented.")

src/fredapi/api/category.py

@@ -0,0 +1,78 @@
+#!/usr/bin/env python3
+"""
+Fred API for Releases Namespace.
+"""
+from .fred_client import FredClient
+
+
+class FredAPIReleases(FredClient):
+    """
+    Fred API Releases Namespace.
+
+    Endpoints:
+        fred/releases - Get all releases of economic data.
+        fred/releases/dates - Get release dates for all releases of economic data.
+        fred/release - Get a release of economic data.
+        fred/release/dates - Get release dates for a release of economic data.
+        fred/release/series - Get the series on a release of economic data.
+        fred/release/sources - Get the sources for a release of economic data.
+        fred/release/tags - Get the tags for a release.
+        fred/release/related_tags - Get the related tags for a release.
+        fred/release/tables - Get the release tables for a given release.
+    """
+
+    def get_releases(self, **kwargs) -> dict:
+        """Get releases."""
+        return self._get(f"releases", {
+            **kwargs,
+        })
+
+    def get_releases_dates(self, **kwargs) -> dict:
+        """Get releases dates."""
+        return self._get(f"releases/dates", {
+            **kwargs,
+        })
+
+    def get_release(self, release_id: int = None, **kwargs) -> dict:
+        """Get release by ID."""
+        return self._get(f"release", {
+            "release_id": release_id,
+            **kwargs,
+        })
+
+    def get_release_dates(self, release_id: int = None, **kwargs) -> dict:
+        """Get release dates by ID."""
+        return self._get(f"release/dates", {
+            "release_id": release_id,
+            **kwargs,
+        })
+
+    def get_release_series(self, release_id: int = None, **kwargs) -> dict:
+        """Get release series by ID."""
+        return self._get(f"release/series", {
+            "release_id": release_id,
+            **kwargs,
+        })
+
+    def get_release_sources(self, release_id: int = None, **kwargs) -> dict:
+        """Get release sources by ID."""
+        return self._get(f"release/sources", {
+            "release_id": release_id,
+            **kwargs,
+        })
+
+    def get_release_tags(self, release_id: int = None, **kwargs) -> dict:
+        """Get release tags by ID."""
+        raise NotImplementedError("get_release_tags endpoint is not yet implemented.")
+
+    def get_release_related_tags(self, release_id: int = None, **kwargs) -> dict:
+        """Get release related tags by ID."""
+        raise NotImplementedError("get_release_related_tags endpoint is not yet implemented.")
+
+    def get_release_tables(self, release_id: int = None, 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,
+        })

src/fredapi/api/fred_py_api.py

@@ -1,13 +1,13 @@
 #!/usr/bin/env python3
 """
-Fred API Series Namespace.
+Fred API Sources Namespace.
 """
 from .fred_client import FredClient
 
 
-class FredAPISeries(FredClient):
+class FredAPISources(FredClient):
     """
-    Fred API Series Namespace.
+    Fred API Sources Namespace.
     
     Endpoints:
         fred/sources - Get all sources of economic data.
@@ -21,14 +21,14 @@ def get_sources(self, **kwargs) -> dict:
             **kwargs,
         })
 
-    def get_source(self, source_id: str = None, **kwargs) -> dict:
+    def get_source(self, source_id: int = None, **kwargs) -> dict:
         """Get source by ID."""
         return self._get(f"source", {
             "source_id": source_id,
             **kwargs,
         })
 
-    def get_source_releases(self, source_id: str = None, **kwargs) -> dict:
+    def get_source_releases(self, source_id: int = None, **kwargs) -> dict:
         """Get source releases by ID."""
         return self._get(f"source/releases", {
             "source_id": source_id,

src/fredapi/api/release.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 """
-Test the Fred API Category Namespace.
+Test the Fred API Categories Namespace.
 """
 import unittest
 
@@ -12,7 +12,7 @@ class TestFredAPICategory(unittest.TestCase):
 
     def setUp(self):
         """Setup the test."""
-        self.fred_api_category = FredAPICategory(config.API_KEY)
+        self.fred_api_category = FredAPICategory()
 
     def test_init_assertion_error(self):
         """Test the init assertion error."""