autonomize-core 0.1.0__tar.gz

autonomize_core-0.1.0/LICENSE

@@ -0,0 +1,3 @@
+Copyright (C) Autonomize AI - All Rights Reserved
+
+The contents of this repository cannot be copied and/or distributed without the explicit permission from Autonomize.ai

autonomize_core-0.1.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.1
+Name: autonomize-core
+Version: 0.1.0
+Summary: Autonomize Core contains the unified authentication source to access platform.
+Home-page: https://github.com/autonomize-ai/autonomize-core
+License: Proprietary
+Author: Varun Prakash
+Author-email: varun.prakash@autonomize.ai
+Requires-Python: >=3.12,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing
+Classifier: Typing :: Typed
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Project-URL: Documentation, https://github.com/autonomize-ai/autonomize-core
+Project-URL: Repository, https://github.com/autonomize-ai/autonomize-core
+Description-Content-Type: text/markdown
+
+# Autonomize Core
+
+![Python Version](https://img.shields.io/badge/Python-3.12+-blue?style=for-the-badge&logo=python)
+![PyPI Version](https://img.shields.io/pypi/v/autonomize-core?style=for-the-badge&logo=pypi)
+![Code Formatter](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)
+![Code Linter](https://img.shields.io/badge/linting-pylint-green.svg?style=for-the-badge)
+![Code Checker](https://img.shields.io/badge/mypy-checked-blue?style=for-the-badge)
+![Code Coverage](https://img.shields.io/badge/coverage-100%25-a4a523?style=for-the-badge&logo=codecov)
+
+## Overview
+
+Autonomize Core houses the core functionality about authentication of our in-house platform.
+
+## Features
+
+- **Authentication**: The SDK allows you to authenticate tokens for Modelhub.
+- **High scalability**: Built to handle large-scale data retrieval and generation, enabling robust, production-ready applications.
+
+## Installation
+
+1. Create a virtual environment, we recommend [Miniconda](https://docs.anaconda.com/miniconda/) for environment management:
+    ```bash
+    conda create -n autocore python=3.12
+    conda activate autocore
+    ```
+2. Install the package:
+    ```bash
+    pip install autonomize-core
+    ```
+
+To install with optional dependencies like Qdrant, Huggingface, OpenAI, Modelhub, etc., refer to the [Installation Guide](INSTALL.md).
+
+
+## Usage
+
+### Sync Usage
+
+```python
+import os
+from autonomize.core.credential import ModelhubCredential
+
+cred = ModelhubCredential(
+    auth_url=MODELHUB_AUTH_ENDPOINT,
+    client_id=MODELHUB_AUTH_CLIENT_ID,
+    client_secret=MODELHUB_AUTH_CLIENT_SECRET,
+)
+
+r = cred.get_token()
+```
+
+### Async Usage
+
+Simply use sync methods with `a` prefix and use `await` for each call. Example: `cred.get_token` becomes `await cred.aget_token` and everything else remains the same.
+
+```python
+import os
+from autonomize.core.credential import ModelhubCredential
+
+cred = ModelhubCredential(
+    auth_url=MODELHUB_AUTH_ENDPOINT,
+    client_id=MODELHUB_AUTH_CLIENT_ID,
+    client_secret=MODELHUB_AUTH_CLIENT_SECRET,
+)
+
+r = await cred.aget_token()
+```
+
+## Contribution
+
+To contribute in our Autonomize Core SDK, please refer to our [Contribution Guidelines](CONTRIBUTING.md).
+
+## License
+Copyright (C) Autonomize AI - All Rights Reserved
+
+The contents of this repository cannot be copied and/or distributed without the explicit permission from Autonomize.ai
+

autonomize_core-0.1.0/README.md

@@ -0,0 +1,75 @@
+# Autonomize Core
+
+![Python Version](https://img.shields.io/badge/Python-3.12+-blue?style=for-the-badge&logo=python)
+![PyPI Version](https://img.shields.io/pypi/v/autonomize-core?style=for-the-badge&logo=pypi)
+![Code Formatter](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)
+![Code Linter](https://img.shields.io/badge/linting-pylint-green.svg?style=for-the-badge)
+![Code Checker](https://img.shields.io/badge/mypy-checked-blue?style=for-the-badge)
+![Code Coverage](https://img.shields.io/badge/coverage-100%25-a4a523?style=for-the-badge&logo=codecov)
+
+## Overview
+
+Autonomize Core houses the core functionality about authentication of our in-house platform.
+
+## Features
+
+- **Authentication**: The SDK allows you to authenticate tokens for Modelhub.
+- **High scalability**: Built to handle large-scale data retrieval and generation, enabling robust, production-ready applications.
+
+## Installation
+
+1. Create a virtual environment, we recommend [Miniconda](https://docs.anaconda.com/miniconda/) for environment management:
+    ```bash
+    conda create -n autocore python=3.12
+    conda activate autocore
+    ```
+2. Install the package:
+    ```bash
+    pip install autonomize-core
+    ```
+
+To install with optional dependencies like Qdrant, Huggingface, OpenAI, Modelhub, etc., refer to the [Installation Guide](INSTALL.md).
+
+
+## Usage
+
+### Sync Usage
+
+```python
+import os
+from autonomize.core.credential import ModelhubCredential
+
+cred = ModelhubCredential(
+    auth_url=MODELHUB_AUTH_ENDPOINT,
+    client_id=MODELHUB_AUTH_CLIENT_ID,
+    client_secret=MODELHUB_AUTH_CLIENT_SECRET,
+)
+
+r = cred.get_token()
+```
+
+### Async Usage
+
+Simply use sync methods with `a` prefix and use `await` for each call. Example: `cred.get_token` becomes `await cred.aget_token` and everything else remains the same.
+
+```python
+import os
+from autonomize.core.credential import ModelhubCredential
+
+cred = ModelhubCredential(
+    auth_url=MODELHUB_AUTH_ENDPOINT,
+    client_id=MODELHUB_AUTH_CLIENT_ID,
+    client_secret=MODELHUB_AUTH_CLIENT_SECRET,
+)
+
+r = await cred.aget_token()
+```
+
+## Contribution
+
+To contribute in our Autonomize Core SDK, please refer to our [Contribution Guidelines](CONTRIBUTING.md).
+
+## License
+Copyright (C) Autonomize AI - All Rights Reserved
+
+The contents of this repository cannot be copied and/or distributed without the explicit permission from Autonomize.ai

autonomize_core-0.1.0/autonomize/core/credential.py

@@ -0,0 +1,261 @@
+"""ModelhubCredential Implementation"""
+
+# pylint: disable=line-too-long, invalid-name
+
+import base64
+import json
+import os
+import time
+from typing import Optional
+
+import httpx
+
+from autonomize.exceptions.core import (
+    ModelhubInvalidTokenException,
+    ModelhubMissingCredentialsException,
+    ModelhubTokenRetrievalException,
+    ModelhubUnauthorizedException,
+)
+from autonomize.utils.logger import setup_logger
+
+logger = setup_logger(__name__)
+
+
+class ModelhubCredential:
+    """
+    ModelhubCredential Class.
+
+    This class instantiates a ModelhubCredential client to authenticate request to Modelhub.
+
+    Example:
+    .. code-block:: python
+
+        from autonomize.core import ModelhubCredential
+
+        # Using modelhub_url (recommended)
+        modelhub_credential = ModelhubCredential(
+            modelhub_url="https://example.com",
+            client_id="modelhub-client",
+            client_secret="xxx"
+        )
+
+        # Using token directly
+        modelhub_credential = ModelhubCredential(
+            token="xxx"
+        )
+    """
+
+    def __init__(
+        self,
+        modelhub_url: Optional[str] = None,
+        client_id: Optional[str] = None,
+        client_secret: Optional[str] = None,
+        token: Optional[str] = None,
+        auth_url: Optional[str] = None,  # Kept for backward compatibility
+    ):
+        """
+        Initialize the ModelhubCredential instance.
+
+        Args:
+            modelhub_url (Optional[str]): The base URL for ModelHub services. Defaults to None.
+            client_id (Optional[str]): The client ID for authentication.
+            client_secret (Optional[str]): The client secret for authentication.
+            token (Optional[str]): An existing JWT token for authentication.
+            auth_url (Optional[str]): The direct authentication URL (legacy parameter).
+
+        Raises:
+            ModelhubMissingCredentialsException: If neither (client_id and client_secret) nor token is provided.
+        """
+        # Initialize base URL
+        self._modelhub_url = modelhub_url or (
+            os.getenv("MODELHUB_BASE_URL", "").strip() or None
+        )
+        self._client_id = client_id or (
+            os.getenv("MODELHUB_CLIENT_ID", "").strip() or None
+        )
+        self._client_secret = client_secret or (
+            os.getenv("MODELHUB_CLIENT_SECRET", "").strip() or None
+        )
+        self._token = token
+
+        # Derive auth_url from modelhub_url if available, otherwise use provided auth_url or default
+        if self._modelhub_url:
+            self._auth_url = f"{self._modelhub_url}/ums/api/v1/auth/get-token"
+        elif auth_url:
+            # Legacy support for direct auth_url
+            self._auth_url = auth_url
+            logger.warning(
+                "Using direct auth_url is deprecated. Please use modelhub_url instead."
+            )
+        else:
+            # Default URL as a fallback
+            self._auth_url = "https://auth.sprint.autonomize.dev/realms/autonomize/protocol/openid-connect/token"
+
+        # Validate credentials
+        if self._client_id is None or self._client_secret is None:
+            if self._token is None:
+                raise ModelhubMissingCredentialsException(
+                    "Either (`client_id` and `client_secret`) or `token` must be provided."
+                )
+            logger.warning(
+                "It is recommended to provide `client_id` and `client_secret` over `token` "
+                "because token gets expired within 24 hours. "
+                "You can use `ModelhubCredential.is_token_expired(your_token)` to check if it has expired or not."
+            )
+
+    @property
+    def auth_url(self) -> str:
+        """Get the authentication URL."""
+        return self._auth_url
+
+    def reset_token(self) -> None:
+        """Reset the token to force a new token fetch on next request."""
+        self._token = None  # pragma: no cover
+        logger.debug(
+            "Token reset, will fetch a new token on next request"
+        )  # pragma: no cover
+
+    @staticmethod
+    def is_token_expired(token: str) -> bool:
+        """
+        Checks whether the provided JWT token is expired or not.
+
+        Args:
+            token (str): The JWT token to check if its expired or not.
+
+        Returns:
+            bool: True if token has expired, otherwise False.
+
+        Raises:
+            ModelhubInvalidTokenException: When the token provided is ill-formatted.
+        """
+
+        # Split the token by `.` to get it in list
+        b64_components = token.split(".")
+
+        # The token should have three components: header, payload and signature.
+        if len(b64_components) != 3:
+            raise ModelhubInvalidTokenException(
+                "Ill-formatted token provided. Please recheck your token."
+            )
+
+        # Divide it into, header, payload and signature,
+        # but we don't need header and signature.
+        _, payload_b64, _ = b64_components
+
+        payload_json = base64.urlsafe_b64decode(payload_b64 + "==").decode("utf-8")
+        payload = json.loads(payload_json)
+
+        # Get expiry time in Unix-epoch time.
+        token_expiry_time = payload["exp"]
+
+        return token_expiry_time < int(time.time())
+
+    def get_token(self) -> str:
+        """
+        Obtains a JWT token for authorization if token is not provided or has expired.
+
+        Returns:
+            str: JWT token.
+        """
+        if not self._token or ModelhubCredential.is_token_expired(self._token):
+            if not self._client_id or not self._client_secret:
+                raise ModelhubMissingCredentialsException(  # pragma: no cover
+                    "client_id and client_secret must be provided to fetch JWT token."
+                )
+
+            # Setting verify=False, so our client doesn't check for SSL certificate.
+            with httpx.Client(verify=False, timeout=None) as client:
+                response = client.post(
+                    self.auth_url,
+                    headers={"Content-Type": "application/x-www-form-urlencoded"},
+                    data={
+                        "grant_type": "client_credentials",
+                        "client_id": self._client_id,
+                        "client_secret": self._client_secret,
+                        "scope": "openid",
+                    },
+                )
+
+                if response.status_code == 401:
+                    raise ModelhubUnauthorizedException(
+                        "Client Error `401 Unauthorized`: client_id or client_secret is invalid."
+                    )
+                response.raise_for_status()
+
+                # Handle different response formats
+                json_response = response.json()
+                if "id_token" in json_response:
+                    self._token = json_response["id_token"]
+                elif (
+                    "token" in json_response
+                    and "access_token" in json_response["token"]
+                ):
+                    self._token = json_response["token"]["access_token"]
+                elif "access_token" in json_response:
+                    self._token = json_response["access_token"]
+                else:
+                    raise ModelhubTokenRetrievalException(
+                        f"Could not find token in response: {json_response}"
+                    )
+
+        # Ensure token is not None before returning
+        if not self._token:
+            raise ModelhubTokenRetrievalException(  # pragma: no cover
+                "Token could not be retrieved."
+            )
+        return self._token
+
+    async def aget_token(self) -> str:
+        """
+        Asynchronously obtains a JWT token for authorization if token is not provided or has expired.
+
+        Returns:
+            str: JWT token.
+        """
+        if not self._token or ModelhubCredential.is_token_expired(self._token):
+            if not self._client_id or not self._client_secret:
+                raise ModelhubMissingCredentialsException(
+                    "client_id and client_secret must be provided to fetch JWT token."
+                )
+
+            async with httpx.AsyncClient(verify=False, timeout=None) as client:
+                response = await client.post(
+                    self.auth_url,
+                    headers={"Content-Type": "application/x-www-form-urlencoded"},
+                    data={
+                        "grant_type": "client_credentials",
+                        "client_id": self._client_id,
+                        "client_secret": self._client_secret,
+                        "scope": "openid",
+                    },
+                )
+
+                if response.status_code == 401:
+                    raise ModelhubUnauthorizedException(
+                        "Client Error `401 Unauthorized`: client_id or client_secret is invalid."
+                    )
+                response.raise_for_status()
+
+                # Handle different response formats
+                json_response = response.json()
+                if "id_token" in json_response:
+                    self._token = json_response["id_token"]
+                elif (
+                    "token" in json_response
+                    and "access_token" in json_response["token"]
+                ):
+                    self._token = json_response["token"]["access_token"]
+                elif "access_token" in json_response:
+                    self._token = json_response["access_token"]
+                else:
+                    raise ModelhubTokenRetrievalException(
+                        f"Could not find token in response: {json_response}"
+                    )
+
+        # Ensure token is not None before returning
+        if not self._token:
+            raise ModelhubTokenRetrievalException(
+                "Token could not be retrieved."
+            )  # pragma: no cover
+        return self._token

autonomize_core-0.1.0/autonomize/exceptions/__init__.py

@@ -0,0 +1,15 @@
+# pylint: disable=missing-module-docstring, duplicate-code
+
+from .core import (
+    ModelhubInvalidTokenException,
+    ModelhubMissingCredentialsException,
+    ModelhubTokenRetrievalException,
+    ModelhubUnauthorizedException,
+)
+
+__all__ = [
+    "ModelhubInvalidTokenException",
+    "ModelhubMissingCredentialsException",
+    "ModelhubTokenRetrievalException",
+    "ModelhubUnauthorizedException",
+]

autonomize_core-0.1.0/autonomize/exceptions/core/__init__.py

@@ -0,0 +1,15 @@
+# pylint: disable=missing-module-docstring, duplicate-code
+
+from .credentials import (
+    ModelhubInvalidTokenException,
+    ModelhubMissingCredentialsException,
+    ModelhubTokenRetrievalException,
+    ModelhubUnauthorizedException,
+)
+
+__all__ = [
+    "ModelhubInvalidTokenException",
+    "ModelhubMissingCredentialsException",
+    "ModelhubTokenRetrievalException",
+    "ModelhubUnauthorizedException",
+]

autonomize_core-0.1.0/autonomize/exceptions/core/credentials.py

@@ -0,0 +1,21 @@
+"""Exceptions for the modelhub module."""
+
+
+class ModelhubCredentialException(Exception):
+    """Base exception for ModelhubCredential exceptions."""
+
+
+class ModelhubMissingCredentialsException(ModelhubCredentialException):
+    """Raised when modelhub credentials are not provided."""
+
+
+class ModelhubInvalidTokenException(ModelhubCredentialException):
+    """Raised when an ill-formatted or invalid token is provided."""
+
+
+class ModelhubTokenRetrievalException(ModelhubCredentialException):
+    """Raised when the token could not be retrieved."""
+
+
+class ModelhubUnauthorizedException(ModelhubCredentialException):
+    """Raised when the modelhub credentials are invalid."""

autonomize_core-0.1.0/autonomize/utils/logger.py

@@ -0,0 +1,71 @@
+""" This module contains the logger setup function. """
+
+import logging
+import os
+import sys
+from datetime import datetime
+
+
+class CustomFormatter(logging.Formatter):
+    """
+    A custom log formatter that adds detailed context information to log records.
+
+    This formatter extends the base `logging.Formatter` class and overrides the `format` method
+    to add timestamp, app label, file name, function name, and line number to each log record.
+
+    Attributes:
+        None
+
+    Methods:
+        format(record): Formats the log record with enhanced contextual information.
+
+    Usage:
+        formatter = CustomFormatter()
+        handler.setFormatter(formatter)
+    """
+
+    def format(self, record):
+        record.timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S.%f")[:-3]
+        record.label = f"[{os.environ.get('APP_NAME', 'modelhub')}]"
+
+        # Add file location info
+        record.file_info = f"{record.pathname.split('/')[-1]}:{record.lineno}"
+
+        # Add function info if available
+        if record.funcName and record.funcName != "<module>":
+            record.file_info = f"{record.file_info} {record.funcName}()"
+
+        return super().format(record)
+
+
+def setup_logger(name):
+    """
+    Set up a logger with the specified name and enhanced contextual information.
+
+    Args:
+        name (str): The name of the logger.
+
+    Returns:
+        logging.Logger: The configured logger object.
+    """
+    logger = logging.getLogger(name)
+
+    # Set log level from environment variable
+    log_level = os.getenv("LOG_LEVEL", "INFO").upper()
+    logger.setLevel(log_level)
+
+    if not logger.hasHandlers():
+        log_handler = logging.StreamHandler(sys.stdout)  # pragma: no cover
+
+        # Enhanced format with file location and function information
+        formatter = CustomFormatter(  # pragma: no cover
+            fmt="%(timestamp)s %(label)s %(levelname)s [%(name)s] [%(file_info)s]: %(message)s"
+        )
+
+        log_handler.setFormatter(formatter)  # pragma: no cover
+        logger.addHandler(log_handler)  # pragma: no cover
+
+    # Prevent propagation to avoid duplicate logs
+    logger.propagate = False
+
+    return logger

autonomize_core-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[tool.poetry]
+name = "autonomize-core"
+version = "0.1.0"
+description = "Autonomize Core contains the unified authentication source to access platform."
+authors = ["Varun Prakash <varun.prakash@autonomize.ai>"]
+readme = "README.md"
+license = "Proprietary"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: Other/Proprietary License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Text Processing",
+    "Typing :: Typed"
+]
+packages = [
+    { include = "autonomize" },
+]
+homepage = "https://github.com/autonomize-ai/autonomize-core"
+repository = "https://github.com/autonomize-ai/autonomize-core"
+documentation = "https://github.com/autonomize-ai/autonomize-core"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+httpx = "^0.28.1"
+
+[tool.poetry.group.dev]
+optional = true
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.2"
+black = {version = "24.4.2", extras = ["jupyter"]}
+pylint = "^3.2.6"
+mypy = "^1.11.1"
+pytest-asyncio = "^0.24.0"
+pre-commit = "^3.8.0"
+pytest-cov = "^5.0.0"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"