the-datagarden 0.1.0__tar.gz → 1.2.1__tar.gz

the_datagarden-1.2.1/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.1
+Name: the-datagarden
+Version: 1.2.1
+Summary: Public data made easy.
+Author-email: Maarten de Ruyter <info@the-datagarden.io>
+License: MIT
+Project-URL: Read the Docs, https://the-datagarden.readthedocs.io/
+Project-URL: The-DataGarden, https://www.the-datagarden.io/
+Project-URL: API documentation, https://api.the-datagarden.io/api-docs
+Project-URL: Source, https://github.com/the-datagarden/the-datagarden
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Healthcare Industry
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+Requires-Dist: click>=8.1.7
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: polars>=1.15.0
+Requires-Dist: pydantic>=2.9.2
+Requires-Dist: pyjwt>=2.10.0
+Requires-Dist: python-decouple>=3.8
+Requires-Dist: requests>=2.32.3
+Requires-Dist: the-datagarden-models>=1.6.3
+
+==================
+the-datagarden SDK
+==================
+
+The-datagarden package is a Python SDK built on top of The-DataGarden API. It provides easy access to continent and country regional hierarchies, as well as public data related to these regions. Additionally, you can retrieve regional GeoJSONs using the SDK. It simplifies the process of converting regional data into DataFrames and/or GeoJSON Feature collections, enabling developers to build upon this data effortlessly.
+
+A quick example
+---------------
+If you have a user account at the-datagarden.io, you can start using the SDK right away:
+
+.. code-block:: python
+
+    # Retrieve a country object from the datagarden API
+    >>> from the-datagarden import TheDataGardenAPI
+    >>> the_datagarden_api = TheDataGardenAPI(email='your-email@example.com', password='your-password')
+    >>> nl = the_datagarden_api.netherlands()
+    >>> nl_demographics = nl.demographics(from_period="2010-01-01", source="united nations")
+    >>> nl_demographics
+        TheDataGardenRegionalDataModel : Demographics : (count=15)
+
+this returns a `TheDataGardenRegionalDataModel` containimg the demographics data in this case 15 records.
+Each of those records will contain a Demographics object for the region for the specified period.
+
+To work with this data, you can convert it to a pandas or polars dataframe and select the data from the demographics
+data model you need.
+
+.. code-block:: python
+
+    >>> df = nl_demographics.to_polars({"pop_count": "population.total"}) # or to_pandas(...)
+    >>> df["name", "source_name", "period", "data_model_name", "total"]
+        ┌─────────────┬────────────────┬─────────────────┬─────────────────┬─────────────┐
+        │ name        ┆ source_name    ┆ period          ┆ data_model_name ┆ pop_count   │
+        │ ---         ┆ ---            ┆ ---             ┆ ---             ┆ ---         │
+        │ str         ┆ str            ┆ str             ┆ str             ┆ f64         │
+        ╞═════════════╪════════════════╪═════════════════╪═════════════════╪═════════════╡
+        │ Netherlands ┆ United Nations ┆ 2010-01-010:00Z ┆ Demographics    ┆ 1.6729801e7 │
+        │ Netherlands ┆ United Nations ┆ 2011-01-010:00Z ┆ Demographics    ┆ 1.6812669e7 │
+        │ Netherlands ┆ United Nations ┆ 2012-01-010:00Z ┆ Demographics    ┆ 1.6889445e7 │
+        │ Netherlands ┆ United Nations ┆ 2013-01-010:00Z ┆ Demographics    ┆ 1.6940942e7 │
+        │ Netherlands ┆ United Nations ┆ 2014-01-010:00Z ┆ Demographics    ┆ 1.6993184e7 │
+        │ …           ┆ …              ┆ …               ┆ …               ┆ …           │
+        │ Netherlands ┆ United Nations ┆ 2020-01-010:00Z ┆ Demographics    ┆ 1.7601682e7 │
+        │ Netherlands ┆ United Nations ┆ 2021-01-010:00Z ┆ Demographics    ┆ 1.767178e7  │
+        │ Netherlands ┆ United Nations ┆ 2022-01-010:00Z ┆ Demographics    ┆ 1.7789347e7 │
+        │ Netherlands ┆ United Nations ┆ 2023-01-010:00Z ┆ Demographics    ┆ 1.8019495e7 │
+        │ Netherlands ┆ United Nations ┆ 2024-01-010:00Z ┆ Demographics    ┆ null        │
+        └─────────────┴────────────────┴─────────────────┴─────────────────┴─────────────┘
+
+
+Retrieving the GeoJSON for the Netherlands and its provinces is straightforward as well:
+
+.. code-block:: python
+
+    >>> nl_geojson = nl.geojsons()
+    >>> nl_geojson
+        TheDataGardenRegionGeoJSONModel : GeoJSON : (count=1)
+    >>> nl_geojson(region_level=2) # Retrieve GeoJSON for 2nd regional level (provinces)
+        TheDataGardenRegionGeoJSONModel : GeoJSON : (count=13)  # 12 provinces + 1 country
+    >>> df = nl_geojson.to_polars()
+    >>> df["name", "region_type", "local_region_code", "region_level", "feature"]
+        ┌───────────────┬─────────────┬───────────────┬──────────────┬────────────────────────┐
+        │ name          ┆ region_type ┆ local_region_c┆ region_level ┆ feature                │
+        │ ---           ┆ ---         ┆ ---           ┆ ---          ┆ ---                    │
+        │ str           ┆ str         ┆ str           ┆ i64          ┆ struct[3]              │
+        ╞═══════════════╪═════════════╪═══════════════╪══════════════╪════════════════════════╡
+        │ Netherlands   ┆ country     ┆ 528           ┆ 0            ┆ {"Feature",{"Netherland│
+        │ Drenthe       ┆ province    ┆ NL13          ┆ 2            ┆ {"Feature",{"Drenthe",2│
+        │ Flevoland     ┆ province    ┆ NL23          ┆ 2            ┆ {"Feature",{"Flevoland"│
+        │ Friesland     ┆ province    ┆ NL12          ┆ 2            ┆ {"Feature",{"Friesland"│
+        │ Gelderland    ┆ province    ┆ NL22          ┆ 2            ┆ {"Feature",{"Gelderland│
+        │ …             ┆ …           ┆ …             ┆ …            ┆ …                      │
+        │ Noord-Holland ┆ province    ┆ NL32          ┆ 2            ┆ {"Feature",{"Noord-Holl│
+        │ Overijssel    ┆ province    ┆ NL21          ┆ 2            ┆ {"Feature",{"Overijssel│
+        │ Utrecht       ┆ province    ┆ NL31          ┆ 2            ┆ {"Feature",{"Utrecht",2│
+        │ Zeeland       ┆ province    ┆ NL34          ┆ 2            ┆ {"Feature",{"Zeeland",2│
+        │ Zuid-Holland  ┆ province    ┆ NL33          ┆ 2            ┆ {"Feature",{"Zuid-Holla│
+        └───────────────┴─────────────┴───────────────┴──────────────┴────────────────────────┘
+
+For readability, the output only a limited number of dataframe columns are displayed.
+Attributes in both the demographics and geojson dataframes are available to connect the geojson to
+the demographics data. This allows you quickly make data sets that contain both demographics and geojson data
+for further analysis or visualisation in map applications.
+
+
+Read more
+---------
+
+* `The DataGarden Website <https://www.the-datagarden.io>`_
+* `API Documentation <https://www.the-datagarden.io/api-docs>`_
+* `The Datagarden Models <https://www.the-datagarden.io/data-docs>`_
+* `GitHub Repository <https://github.com/MaartendeRuyter/dg-the-datagarden>`_
+
+Access to The DataGarden API
+----------------------------
+To use the DataGarden SDK, you need access to the The DataGarden API. Simply register for free at https://www.the-datagarden.io
+and you will have an inital free access account to the API with access to country and continent data.
+
+Visit https://www.the-datagarden.io for to register for free.

the_datagarden-1.2.1/README.rst

@@ -0,0 +1,98 @@
+==================
+the-datagarden SDK
+==================
+
+The-datagarden package is a Python SDK built on top of The-DataGarden API. It provides easy access to continent and country regional hierarchies, as well as public data related to these regions. Additionally, you can retrieve regional GeoJSONs using the SDK. It simplifies the process of converting regional data into DataFrames and/or GeoJSON Feature collections, enabling developers to build upon this data effortlessly.
+
+A quick example
+---------------
+If you have a user account at the-datagarden.io, you can start using the SDK right away:
+
+.. code-block:: python
+
+    # Retrieve a country object from the datagarden API
+    >>> from the-datagarden import TheDataGardenAPI
+    >>> the_datagarden_api = TheDataGardenAPI(email='your-email@example.com', password='your-password')
+    >>> nl = the_datagarden_api.netherlands()
+    >>> nl_demographics = nl.demographics(from_period="2010-01-01", source="united nations")
+    >>> nl_demographics
+        TheDataGardenRegionalDataModel : Demographics : (count=15)
+
+this returns a `TheDataGardenRegionalDataModel` containimg the demographics data in this case 15 records.
+Each of those records will contain a Demographics object for the region for the specified period.
+
+To work with this data, you can convert it to a pandas or polars dataframe and select the data from the demographics
+data model you need.
+
+.. code-block:: python
+
+    >>> df = nl_demographics.to_polars({"pop_count": "population.total"}) # or to_pandas(...)
+    >>> df["name", "source_name", "period", "data_model_name", "total"]
+        ┌─────────────┬────────────────┬─────────────────┬─────────────────┬─────────────┐
+        │ name        ┆ source_name    ┆ period          ┆ data_model_name ┆ pop_count   │
+        │ ---         ┆ ---            ┆ ---             ┆ ---             ┆ ---         │
+        │ str         ┆ str            ┆ str             ┆ str             ┆ f64         │
+        ╞═════════════╪════════════════╪═════════════════╪═════════════════╪═════════════╡
+        │ Netherlands ┆ United Nations ┆ 2010-01-010:00Z ┆ Demographics    ┆ 1.6729801e7 │
+        │ Netherlands ┆ United Nations ┆ 2011-01-010:00Z ┆ Demographics    ┆ 1.6812669e7 │
+        │ Netherlands ┆ United Nations ┆ 2012-01-010:00Z ┆ Demographics    ┆ 1.6889445e7 │
+        │ Netherlands ┆ United Nations ┆ 2013-01-010:00Z ┆ Demographics    ┆ 1.6940942e7 │
+        │ Netherlands ┆ United Nations ┆ 2014-01-010:00Z ┆ Demographics    ┆ 1.6993184e7 │
+        │ …           ┆ …              ┆ …               ┆ …               ┆ …           │
+        │ Netherlands ┆ United Nations ┆ 2020-01-010:00Z ┆ Demographics    ┆ 1.7601682e7 │
+        │ Netherlands ┆ United Nations ┆ 2021-01-010:00Z ┆ Demographics    ┆ 1.767178e7  │
+        │ Netherlands ┆ United Nations ┆ 2022-01-010:00Z ┆ Demographics    ┆ 1.7789347e7 │
+        │ Netherlands ┆ United Nations ┆ 2023-01-010:00Z ┆ Demographics    ┆ 1.8019495e7 │
+        │ Netherlands ┆ United Nations ┆ 2024-01-010:00Z ┆ Demographics    ┆ null        │
+        └─────────────┴────────────────┴─────────────────┴─────────────────┴─────────────┘
+
+
+Retrieving the GeoJSON for the Netherlands and its provinces is straightforward as well:
+
+.. code-block:: python
+
+    >>> nl_geojson = nl.geojsons()
+    >>> nl_geojson
+        TheDataGardenRegionGeoJSONModel : GeoJSON : (count=1)
+    >>> nl_geojson(region_level=2) # Retrieve GeoJSON for 2nd regional level (provinces)
+        TheDataGardenRegionGeoJSONModel : GeoJSON : (count=13)  # 12 provinces + 1 country
+    >>> df = nl_geojson.to_polars()
+    >>> df["name", "region_type", "local_region_code", "region_level", "feature"]
+        ┌───────────────┬─────────────┬───────────────┬──────────────┬────────────────────────┐
+        │ name          ┆ region_type ┆ local_region_c┆ region_level ┆ feature                │
+        │ ---           ┆ ---         ┆ ---           ┆ ---          ┆ ---                    │
+        │ str           ┆ str         ┆ str           ┆ i64          ┆ struct[3]              │
+        ╞═══════════════╪═════════════╪═══════════════╪══════════════╪════════════════════════╡
+        │ Netherlands   ┆ country     ┆ 528           ┆ 0            ┆ {"Feature",{"Netherland│
+        │ Drenthe       ┆ province    ┆ NL13          ┆ 2            ┆ {"Feature",{"Drenthe",2│
+        │ Flevoland     ┆ province    ┆ NL23          ┆ 2            ┆ {"Feature",{"Flevoland"│
+        │ Friesland     ┆ province    ┆ NL12          ┆ 2            ┆ {"Feature",{"Friesland"│
+        │ Gelderland    ┆ province    ┆ NL22          ┆ 2            ┆ {"Feature",{"Gelderland│
+        │ …             ┆ …           ┆ …             ┆ …            ┆ …                      │
+        │ Noord-Holland ┆ province    ┆ NL32          ┆ 2            ┆ {"Feature",{"Noord-Holl│
+        │ Overijssel    ┆ province    ┆ NL21          ┆ 2            ┆ {"Feature",{"Overijssel│
+        │ Utrecht       ┆ province    ┆ NL31          ┆ 2            ┆ {"Feature",{"Utrecht",2│
+        │ Zeeland       ┆ province    ┆ NL34          ┆ 2            ┆ {"Feature",{"Zeeland",2│
+        │ Zuid-Holland  ┆ province    ┆ NL33          ┆ 2            ┆ {"Feature",{"Zuid-Holla│
+        └───────────────┴─────────────┴───────────────┴──────────────┴────────────────────────┘
+
+For readability, the output only a limited number of dataframe columns are displayed.
+Attributes in both the demographics and geojson dataframes are available to connect the geojson to
+the demographics data. This allows you quickly make data sets that contain both demographics and geojson data
+for further analysis or visualisation in map applications.
+
+
+Read more
+---------
+
+* `The DataGarden Website <https://www.the-datagarden.io>`_
+* `API Documentation <https://www.the-datagarden.io/api-docs>`_
+* `The Datagarden Models <https://www.the-datagarden.io/data-docs>`_
+* `GitHub Repository <https://github.com/MaartendeRuyter/dg-the-datagarden>`_
+
+Access to The DataGarden API
+----------------------------
+To use the DataGarden SDK, you need access to the The DataGarden API. Simply register for free at https://www.the-datagarden.io
+and you will have an inital free access account to the API with access to country and continent data.
+
+Visit https://www.the-datagarden.io for to register for free.

the_datagarden-1.2.1/pyproject.toml

@@ -0,0 +1,84 @@
+[project]
+name = "the-datagarden"
+version = "1.2.1"
+description = "Public data made easy."
+readme = "README.rst"
+requires-python = ">=3.10"
+license = { text = "MIT" }  # Specifies the MIT license
+authors = [
+    { name = "Maarten de Ruyter", email = "info@the-datagarden.io" }
+]
+dependencies = [
+    "click>=8.1.7",
+    "pandas>=2.2.3",
+    "polars>=1.15.0",
+    "pydantic>=2.9.2",
+    "pyjwt>=2.10.0",
+    "python-decouple>=3.8",
+    "requests>=2.32.3",
+    "the-datagarden-models>=1.6.3",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Financial and Insurance Industry",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Healthcare Industry",
+    "Topic :: Scientific/Engineering :: GIS",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+    "Topic :: Scientific/Engineering :: Visualization",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+
+]
+
+[dependency-groups]
+dev = [
+    "mypy>=1.13.0",
+    "pre-commit>=4.0.1",
+    "pytest>=8.3.3",
+    "ruff>=0.7.4",
+    "sphinx>=8.1.3",
+    "types-requests>=2.32.0.20241016",
+]
+
+[project.scripts]
+the-datagarden = "the_datagarden.cli:main"
+
+[project.urls]
+"Read the Docs" = "https://the-datagarden.readthedocs.io/"
+"The-DataGarden" = "https://www.the-datagarden.io/"
+"API documentation" = "https://api.the-datagarden.io/api-docs"
+"Source" = "https://github.com/the-datagarden/the-datagarden"
+
+
+[tool.ruff]
+line-length = 110
+
+[tool.ruff.lint]
+select = [
+    "C",  # mccabe rules
+    "F",  # pyflakes rules
+    "E",  # pycodestyle error rules
+    "W",  # pycodestyle warning rules
+    "B",  # flake8-bugbear rules
+    "I",  # isort rules
+]
+ignore = [
+    "C901",  # max-complexity-10
+]
+
+[tool.ruff.format]
+indent-style = "space"
+quote-style = "double"
+
+[tool.mypy]
+ignore_missing_imports = true

the_datagarden-1.2.1/src/the_datagarden/__init__.py

@@ -0,0 +1,8 @@
+from .api.authentication.environment import TheDatagardenLocalEnvironment
+from .api.base import TheDataGardenAPI, TheDatagardenProductionEnvironment
+
+__all__ = [
+    "TheDataGardenAPI",
+    "TheDatagardenProductionEnvironment",
+    "TheDatagardenLocalEnvironment",
+]

the_datagarden-1.2.1/src/the_datagarden/abc/__init__.py

@@ -0,0 +1,3 @@
+from .authentication import BaseDataGardenCredentials, DatagardenEnvironment
+
+__all__ = ["DatagardenEnvironment", "BaseDataGardenCredentials"]

the_datagarden-1.2.1/src/the_datagarden/abc/api.py

@@ -0,0 +1,19 @@
+from abc import ABC, abstractmethod
+
+from requests import Response
+
+from the_datagarden.abc.authentication import DatagardenEnvironment
+
+
+class BaseApi(ABC):
+    @abstractmethod
+    def __init__(self, environment: type[DatagardenEnvironment] | None = None): ...
+
+    @abstractmethod
+    def retrieve_from_api(
+        self,
+        url_extension: str,
+        method: str = "GET",
+        payload: dict | None = None,
+        params: dict | None = None,
+    ) -> Response | None: ...

the_datagarden-1.2.1/src/the_datagarden/abc/authentication.py

@@ -0,0 +1,42 @@
+from abc import ABC, abstractmethod
+from typing import TypedDict
+
+
+class TheDatagardenCredentialsDict(TypedDict):
+    email: str
+    password: str
+
+
+class BaseDataGardenCredentials(ABC):
+    """Protocol for the datagarden credentials"""
+
+    @classmethod
+    @abstractmethod
+    def credentials(
+        cls, the_datagarden_api_url: str, email: str | None = None, password: str | None = None
+    ) -> TheDatagardenCredentialsDict: ...
+
+
+class DatagardenEnvironment(ABC):
+    """Protocol for the datagarden environment"""
+
+    CREDENTIALS: type[BaseDataGardenCredentials]
+    THE_DATAGARDEN_URL: str
+    ECHO_INIT: bool = True
+
+    def __init__(self):
+        if self.ECHO_INIT:
+            print("Initializing :", self.__class__.__name__)
+            print("At :", self.the_datagarden_url)
+
+    def credentials(
+        self, email: str | None = None, password: str | None = None
+    ) -> TheDatagardenCredentialsDict:
+        return self.CREDENTIALS.credentials(self.the_datagarden_url, email, password)
+
+    @property
+    def the_datagarden_url(self) -> str:
+        url = self.THE_DATAGARDEN_URL
+        if url[-1] != "/":
+            return url + "/"
+        return url

the_datagarden-1.2.1/src/the_datagarden/api/__init__.py

@@ -0,0 +1,5 @@
+from .authentication import AccessToken
+from .authentication.environment import TheDatagardenProductionEnvironment
+from .base import TheDataGardenAPI
+
+__all__ = ["AccessToken", "TheDatagardenProductionEnvironment", "TheDataGardenAPI"]

the_datagarden-1.2.1/src/the_datagarden/api/authentication/__init__.py

@@ -0,0 +1,112 @@
+import json
+from datetime import UTC, datetime, timedelta
+
+import jwt
+import requests
+from requests import Response
+
+from ...abc.authentication import DatagardenEnvironment
+from .settings import (
+    BEARER_KEY,
+    DEFAULT_HEADER,
+    REFRESH_TOKEN_URL_EXTENSION,
+    REQ_TOKEN_URL_EXTENSION,
+)
+
+
+class AccessToken:
+    _instance = None
+    _tokens: dict = {}
+    TOKEN_LIFE_TIME_MARGIN: int = 20
+    ACCESS_TOKEN_KEY = "access"
+    REFRESH_TOKEN_KEY = "refresh"
+
+    def __new__(cls, *args, **kwargs):
+        if cls._instance is None:
+            cls._instance = super().__new__(cls)
+        return cls._instance
+
+    def __init__(
+        self,
+        environment: type[DatagardenEnvironment],
+        email: str | None = None,
+        password: str | None = None,
+    ) -> None:
+        self._environment = environment()
+        self._token_payload = self._environment.credentials(email, password)
+        self._token_header = DEFAULT_HEADER.copy()
+
+    @property
+    def _token_url(self) -> str:
+        return self._the_datagarden_url + REQ_TOKEN_URL_EXTENSION
+
+    @property
+    def _refresh_token_url(self) -> str:
+        return self._the_datagarden_url + REFRESH_TOKEN_URL_EXTENSION
+
+    @property
+    def _the_datagarden_url(self) -> str:
+        return self._environment.the_datagarden_url
+
+    def _access_token_expired(self) -> bool:
+        if self._token_expiry_time:
+            return datetime.now(tz=UTC) + timedelta(seconds=5) > self._token_expiry_time
+        return True
+
+    @property
+    def _access_token(self) -> str:
+        if not self._tokens:
+            self._request_tokens()
+        elif self._access_token_expired():
+            self._get_refresh_token()
+        return self._tokens.get(self.ACCESS_TOKEN_KEY, "")
+
+    @property
+    def header_with_access_token(self) -> dict[str, str]:
+        header = DEFAULT_HEADER.copy()
+        header["Authorization"] = BEARER_KEY + self._access_token
+        return header
+
+    def _request_tokens(self):
+        response = requests.request(
+            method="POST",
+            url=self._token_url,
+            headers=self._token_header,
+            data=json.dumps(self._token_payload),
+        )
+        if not response.status_code == 200:
+            print("Token request failed and returned error(s): ")
+            print("    Errorr : ", response.json().get("detail", "No error details provided"))
+            quit()
+
+        self._tokens = self._get_response_data(response)
+        self._set_token_expiry_time()
+
+    def _get_refresh_token(self):
+        response = requests.request(
+            method="POST",
+            url=self._refresh_token_url,
+            headers=self._token_header,
+            data=json.dumps(self._refresh_payload()),
+        )
+        if not response.status_code == 200:
+            raise ValueError("Token request failed and returned error: " f"{response.text}")
+        self._tokens = self._get_response_data(response)
+        self._set_token_expiry_time()
+
+    def _refresh_payload(self) -> dict:
+        refresh_token = self._tokens.get(self.REFRESH_TOKEN_KEY, "")
+        return {"refresh": refresh_token}
+
+    def _set_token_expiry_time(self):
+        if not self._tokens:
+            return
+        access_token = self._tokens.get(self.ACCESS_TOKEN_KEY, "")
+        if not access_token:
+            raise ValueError("Access token not found in response")
+        decoded_token = jwt.decode(access_token, options={"verify_signature": False})
+        exp_time_stamp = decoded_token["exp"]
+        self._token_expiry_time = datetime.fromtimestamp(timestamp=exp_time_stamp, tz=UTC)
+
+    def _get_response_data(self, response: Response) -> dict[str, str]:
+        return json.loads(response.text)

the_datagarden-1.2.1/src/the_datagarden/api/authentication/credentials/__init__.py

@@ -0,0 +1,120 @@
+import requests
+from decouple import config
+
+from the_datagarden.abc.authentication import BaseDataGardenCredentials, TheDatagardenCredentialsDict
+from the_datagarden.api.authentication.settings import REGISTRATION_URL_EXTENSION
+
+
+class CredentialsFromUserInput:
+    def get_missing_credentials(self, the_datagarden_api_url: str) -> TheDatagardenCredentialsDict:
+        print()
+        print("Welcome to The Data Garden API.")
+        print()
+        print("  You can start using the API with an account from The-Datagarden.io.")
+        print("  Please provide your credentials or create a new account.")
+        print("  Check www.the-datagarden.io for more information.")
+        print()
+        choice = input(
+            "Do you want to (1) create a new account or (2) provide existing credentials? " "Enter 1 or 2: "
+        )
+
+        if choice == "1":
+            credentials = self.enroll_to_api(the_datagarden_api_url)
+            if not credentials:
+                quit()
+            return credentials
+
+        elif choice == "2":
+            return self.provide_existing_credentials()
+        else:
+            print("Invalid choice. Please enter 1 or 2.")
+            return self.get_missing_credentials(the_datagarden_api_url)
+
+    def enroll_to_api(self, the_datagarden_api_url: str) -> TheDatagardenCredentialsDict | None:
+        print("Enrolling in The Data Garden API...")
+        print()
+        email = input("  Enter your email: ")
+        password = self.get_confirmed_password()
+        print()
+
+        data = {"email": email, "password": password}
+        registration_url = the_datagarden_api_url + REGISTRATION_URL_EXTENSION
+        response = requests.post(registration_url, data=data)
+        if response.status_code == 201:
+            print("Successfully enrolled in The Data Garden API.")
+            return TheDatagardenCredentialsDict(
+                email=email,
+                password=password,
+            )
+        else:
+            print("Enrollment failed with error(s):")
+            for field, message_list in response.json().items():
+                print(f"    {field}: {message_list[0]}")
+
+        return None
+
+    def get_confirmed_password(self) -> str:
+        while True:
+            password = input("  Enter your password: ")
+            confirm_password = input("  Confirm your password: ")
+
+            if password == confirm_password:
+                return password
+            else:
+                print("Passwords do not match. Please try again.")
+
+    def provide_existing_credentials(self) -> TheDatagardenCredentialsDict:
+        print("Please provide your existing credentials...")
+        print()
+        email = input("  Enter your email: ")
+        password = input("  Enter your password: ")
+        return TheDatagardenCredentialsDict(
+            email=email,
+            password=password,
+        )
+
+    def credentials(self, the_datagarden_api_url: str) -> TheDatagardenCredentialsDict:
+        return self.get_missing_credentials(the_datagarden_api_url)
+
+
+class TheDataGardenCredentials(BaseDataGardenCredentials):
+    """
+    Manages credentials for The Data Garden API in a production environment.
+
+    This class handles the retrieval of user credentials (email and password) for
+    authenticating with The Data Garden API. It first attempts to fetch credentials
+    from environment variables. If not found, it prompts the user for input.
+
+    Attributes:
+        ENV_EMAIL_KEY (str): Environment variable key for the user's email.
+        ENV_PASSWORD_KEY (str): Environment variable key for the user's password.
+        CREDENTIALS_FROM_USER_INPUT (CredentialsFromUserInput):
+                Instance to handle user input for credentials.
+
+    Methods:
+        credentials(): Retrieves and returns the user's credentials.
+    """
+
+    ENV_EMAIL_KEY: str = "THE_DATAGARDEN_USER_EMAIL"
+    ENV_PASSWORD_KEY: str = "THE_DATAGARDEN_USER_PASSWORD"
+    CREDENTIALS_FROM_USER_INPUT = CredentialsFromUserInput()
+
+    @classmethod
+    def credentials(
+        cls, the_datagarden_api_url: str, email: str | None = None, password: str | None = None
+    ) -> TheDatagardenCredentialsDict:
+        if email and password:
+            return TheDatagardenCredentialsDict(
+                email=email,
+                password=password,
+            )
+
+        datagarden_user_email = str(config(cls.ENV_EMAIL_KEY, default="", cast=str))
+        datagarden_user_password = str(config(cls.ENV_PASSWORD_KEY, default="", cast=str))
+        if datagarden_user_email and datagarden_user_password:
+            return TheDatagardenCredentialsDict(
+                email=datagarden_user_email,
+                password=datagarden_user_password,
+            )
+
+        return cls.CREDENTIALS_FROM_USER_INPUT.credentials(the_datagarden_api_url)

the_datagarden-1.2.1/src/the_datagarden/api/authentication/environment/__init__.py

@@ -0,0 +1,13 @@
+from the_datagarden.abc import DatagardenEnvironment
+
+from ..credentials import TheDataGardenCredentials
+
+
+class TheDatagardenProductionEnvironment(DatagardenEnvironment):
+    CREDENTIALS = TheDataGardenCredentials
+    THE_DATAGARDEN_URL = "https://api.the-datagarden.io"
+
+
+class TheDatagardenLocalEnvironment(DatagardenEnvironment):
+    CREDENTIALS = TheDataGardenCredentials
+    THE_DATAGARDEN_URL = "http://127.0.0.1:8000"