pyoso 0.1.0__tar.gz

pyoso-0.1.0/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.2
+Name: pyoso
+Version: 0.1.0
+Author-email: Icaro Guerra <icaro@karibalabs.co>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# pyoso
+
+_WARNING: THIS IS A WORK IN PROGRESS_
+
+`pyoso` is a Python package for fetching models and metrics from OSO. This package provides an easy-to-use interface to interact with oso and retrieve valuable data for analysis and monitoring.
+
+## Current Features
+
+- Execute custom SQL queries for analyzing the OSO dataset
+
+## Installation
+
+You can install `pyoso` using pip:
+
+```bash
+pip install pyoso
+```
+
+## Usage
+
+Here is a basic example of how to use `pyoso`:
+
+```python
+from pyoso import Client
+
+# Initialize the client
+os.environ["OSO_API_KEY"] = 'your_api_key'
+client = Client()
+
+# Fetch artifacts
+query = "SELECT * FROM artifacts_v1 LIMIT 5"
+artifacts = client.query(query)
+
+print(artifacts)
+```
+
+## Documentation
+
+For detailed documentation about the OSO dataset, please refer to the [official documentation](https://docs.opensource.observer/docs/integrate/datasets/).
+
+## Future Plans
+
+- Create DataFrame wrapper for creating SQL query from data transforms

pyoso-0.1.0/README.md

@@ -0,0 +1,43 @@
+# pyoso
+
+_WARNING: THIS IS A WORK IN PROGRESS_
+
+`pyoso` is a Python package for fetching models and metrics from OSO. This package provides an easy-to-use interface to interact with oso and retrieve valuable data for analysis and monitoring.
+
+## Current Features
+
+- Execute custom SQL queries for analyzing the OSO dataset
+
+## Installation
+
+You can install `pyoso` using pip:
+
+```bash
+pip install pyoso
+```
+
+## Usage
+
+Here is a basic example of how to use `pyoso`:
+
+```python
+from pyoso import Client
+
+# Initialize the client
+os.environ["OSO_API_KEY"] = 'your_api_key'
+client = Client()
+
+# Fetch artifacts
+query = "SELECT * FROM artifacts_v1 LIMIT 5"
+artifacts = client.query(query)
+
+print(artifacts)
+```
+
+## Documentation
+
+For detailed documentation about the OSO dataset, please refer to the [official documentation](https://docs.opensource.observer/docs/integrate/datasets/).
+
+## Future Plans
+
+- Create DataFrame wrapper for creating SQL query from data transforms

pyoso-0.1.0/pyoso/__init__.py

@@ -0,0 +1,8 @@
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("pyoso")
+except PackageNotFoundError:
+    __version__ = "unknown"
+
+__all__ = ["client", "exceptions"]

pyoso-0.1.0/pyoso/client.py

@@ -0,0 +1,47 @@
+import logging
+import os
+from dataclasses import dataclass
+from typing import List, Optional, TypedDict
+
+import requests
+from pyoso.exceptions import OsoError, OsoHTTPError
+
+_DEFAULT_BASE_URL = "https://opensource.observer/api/v1/"
+OSO_API_KEY = "OSO_API_KEY"
+
+
+@dataclass
+class ClientConfig:
+    base_url: Optional[str]
+
+
+class Client:
+    def __init__(
+        self, api_key: Optional[str] = None, client_opts: Optional[ClientConfig] = None
+    ):
+        self.__api_key = api_key if api_key else os.environ.get(OSO_API_KEY)
+        if not self.__api_key:
+            raise OsoError(
+                "API key is required. Either set it in the environment variable OSO_API_KEY or pass it as an argument."
+            )
+        self.__base_url = _DEFAULT_BASE_URL
+        if client_opts and client_opts.base_url:
+            self.__base_url = client_opts.base_url
+            if not self.__base_url.endswith("/"):
+                self.__base_url += "/"
+
+    def query(self, query: str):
+        headers = {}
+        if self.__api_key:
+            headers["Authorization"] = f"Bearer {self.__api_key}"
+        try:
+            response = requests.post(
+                f"{self.__base_url}sql",
+                headers=headers,
+                json={"query": query},
+                stream=True,
+            )
+            response.raise_for_status()
+            return response.json()
+        except requests.HTTPError as e:
+            raise OsoHTTPError(e, response=e.response) from None

pyoso-0.1.0/pyoso/exceptions.py

@@ -0,0 +1,12 @@
+from requests import HTTPError
+
+
+class OsoError(Exception):
+    pass
+
+
+class OsoHTTPError(HTTPError):
+    def __str__(self):
+        str = super().__str__()
+        response = self.response.json()
+        return f"{str} - {response["error"] if response["error"] else response}"

pyoso-0.1.0/pyoso.egg-info/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.2
+Name: pyoso
+Version: 0.1.0
+Author-email: Icaro Guerra <icaro@karibalabs.co>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# pyoso
+
+_WARNING: THIS IS A WORK IN PROGRESS_
+
+`pyoso` is a Python package for fetching models and metrics from OSO. This package provides an easy-to-use interface to interact with oso and retrieve valuable data for analysis and monitoring.
+
+## Current Features
+
+- Execute custom SQL queries for analyzing the OSO dataset
+
+## Installation
+
+You can install `pyoso` using pip:
+
+```bash
+pip install pyoso
+```
+
+## Usage
+
+Here is a basic example of how to use `pyoso`:
+
+```python
+from pyoso import Client
+
+# Initialize the client
+os.environ["OSO_API_KEY"] = 'your_api_key'
+client = Client()
+
+# Fetch artifacts
+query = "SELECT * FROM artifacts_v1 LIMIT 5"
+artifacts = client.query(query)
+
+print(artifacts)
+```
+
+## Documentation
+
+For detailed documentation about the OSO dataset, please refer to the [official documentation](https://docs.opensource.observer/docs/integrate/datasets/).
+
+## Future Plans
+
+- Create DataFrame wrapper for creating SQL query from data transforms

pyoso-0.1.0/pyoso.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+pyoso/__init__.py
+pyoso/client.py
+pyoso/exceptions.py
+pyoso.egg-info/PKG-INFO
+pyoso.egg-info/SOURCES.txt
+pyoso.egg-info/dependency_links.txt
+pyoso.egg-info/top_level.txt
+tests/test_client.py

pyoso-0.1.0/pyoso.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyoso-0.1.0/pyoso.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyoso

pyoso-0.1.0/pyproject.toml

@@ -0,0 +1,10 @@
+[project]
+name = "pyoso"
+version = "0.1.0"
+description = ""
+readme = "README.md"
+requires-python = ">=3.8"
+authors = [
+    { name = "Icaro Guerra", email = "icaro@karibalabs.co" }
+]
+dependencies = []

pyoso-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyoso-0.1.0/tests/test_client.py

@@ -0,0 +1,78 @@
+import os
+from logging import config
+from unittest import TestCase, mock
+
+import requests
+from pyoso.client import Client, ClientConfig
+from pyoso.exceptions import OsoError, OsoHTTPError
+
+
+class TestClient(TestCase):
+    DEFAULT_API_KEY = "test_key"
+    CUSTOM_API_KEY = "custom_key"
+
+    @mock.patch.dict(os.environ, {"OSO_API_KEY": ""})
+    def test_constructor_without_api_key(self):
+        with self.assertRaises(OsoError):
+            Client(api_key=None)
+
+    @mock.patch("requests.post")
+    def test_query(self, mock_get):
+        mock_response = mock.Mock()
+        expected_json = {"data": "test"}
+        mock_response.json.return_value = expected_json
+        mock_get.return_value = mock_response
+
+        client = Client(
+            api_key=self.CUSTOM_API_KEY,
+            client_opts=ClientConfig(base_url="http://localhost:8000/api/v1"),
+        )
+        query = "SELECT * FROM test_table"
+        response = client.query(query)
+
+        mock_get.assert_called_once_with(
+            "http://localhost:8000/api/v1/sql",
+            headers={"Authorization": f"Bearer {self.CUSTOM_API_KEY}"},
+            json={"query": query},
+            stream=True,
+        )
+        self.assertEqual(response, expected_json)
+
+    @mock.patch.dict(os.environ, {"OSO_API_KEY": DEFAULT_API_KEY})
+    @mock.patch("requests.post")
+    def test_query_with_default_api_key(self, mock_get):
+        mock_response = mock.Mock()
+        expected_json = {"data": "test"}
+        mock_response.json.return_value = expected_json
+        mock_get.return_value = mock_response
+
+        client = Client()
+        query = "SELECT * FROM test_table"
+        response = client.query(query)
+
+        mock_get.assert_called_once_with(
+            "https://opensource.observer/api/v1/sql",
+            headers={"Authorization": f"Bearer {self.DEFAULT_API_KEY}"},
+            json={"query": query},
+            stream=True,
+        )
+        self.assertEqual(response, expected_json)
+
+    @mock.patch("requests.post")
+    def test_query_http_error(self, mock_get):
+        mock_response = mock.Mock()
+        mock_response.raise_for_status.side_effect = requests.HTTPError("HTTP Error")
+        mock_get.return_value = mock_response
+
+        client = Client(api_key=self.CUSTOM_API_KEY)
+        query = "SELECT * FROM test_table"
+
+        with self.assertRaises(OsoHTTPError):
+            client.query(query)
+
+        mock_get.assert_called_once_with(
+            "https://opensource.observer/api/v1/sql",
+            headers={"Authorization": f"Bearer {self.CUSTOM_API_KEY}"},
+            json={"query": query},
+            stream=True,
+        )