opa-python-client 2.0.0__tar.gz → 2.0.2__tar.gz

{opa_python_client-2.0.0 → opa_python_client-2.0.2}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: opa-python-client
-Version: 2.0.0
+Version: 2.0.2
 Summary: Client for connection to the OPA service
 Home-page: https://github.com/Turall/OPA-python-client
 License: MIT
 Author: Tural Muradov
-Author-email: tural_m@hotmail.com
+Author-email: tural.muradoov@gmail.com
 Requires-Python: >=3.9,<4.0
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -16,6 +16,7 @@ Classifier: Programming Language :: Python :: 3.9
 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: Programming Language :: Python :: 3 :: Only
 Requires-Dist: aiofiles (>=24.1.0,<25.0.0)
 Requires-Dist: aiohttp[speedups] (>=3.10.9,<4.0.0)
@@ -25,6 +26,11 @@ Description-Content-Type: text/markdown
 
 
 # OpaClient - Open Policy Agent Python Client
+[![MIT licensed](https://img.shields.io/github/license/Turall/OPA-python-client)](https://raw.githubusercontent.com/Turall/OPA-python-client/master/LICENSE)
+[![GitHub stars](https://img.shields.io/github/stars/Turall/OPA-python-client.svg)](https://github.com/Turall/OPA-python-client/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/Turall/OPA-python-client.svg)](https://github.com/Turall/OPA-python-client/network)
+[![GitHub issues](https://img.shields.io/github/issues-raw/Turall/OPA-python-client)](https://github.com/Turall/OPA-python-client/issues)
+[![Downloads](https://pepy.tech/badge/opa-python-client)](https://pepy.tech/project/opa-python-client)
 
 OpaClient is a Python client library designed to interact with the [Open Policy Agent (OPA)](https://www.openpolicyagent.org/). It supports both **synchronous** and **asynchronous** requests, making it easy to manage policies, data, and evaluate rules in OPA servers.
 
@@ -42,7 +48,7 @@ OpaClient is a Python client library designed to interact with the [Open Policy
 You can install the OpaClient package via `pip`:
 
 ```bash
-pip install OPA-python-client
+pip install opa-python-client
 ```
 
 ## Quick Start

{opa_python_client-2.0.0 → opa_python_client-2.0.2}/README.md

@@ -1,5 +1,10 @@
 
 # OpaClient - Open Policy Agent Python Client
+[![MIT licensed](https://img.shields.io/github/license/Turall/OPA-python-client)](https://raw.githubusercontent.com/Turall/OPA-python-client/master/LICENSE)
+[![GitHub stars](https://img.shields.io/github/stars/Turall/OPA-python-client.svg)](https://github.com/Turall/OPA-python-client/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/Turall/OPA-python-client.svg)](https://github.com/Turall/OPA-python-client/network)
+[![GitHub issues](https://img.shields.io/github/issues-raw/Turall/OPA-python-client)](https://github.com/Turall/OPA-python-client/issues)
+[![Downloads](https://pepy.tech/badge/opa-python-client)](https://pepy.tech/project/opa-python-client)
 
 OpaClient is a Python client library designed to interact with the [Open Policy Agent (OPA)](https://www.openpolicyagent.org/). It supports both **synchronous** and **asynchronous** requests, making it easy to manage policies, data, and evaluate rules in OPA servers.
 
@@ -17,7 +22,7 @@ OpaClient is a Python client library designed to interact with the [Open Policy
 You can install the OpaClient package via `pip`:
 
 ```bash
-pip install OPA-python-client
+pip install opa-python-client
 ```
 
 ## Quick Start

{opa_python_client-2.0.0 → opa_python_client-2.0.2}/opa_client/__init__.py

@@ -11,7 +11,7 @@ def create_opa_client(async_mode=False, *args, **kwargs):
 		return OpaClient(*args, **kwargs)
 
 
-__version__ = "2.0.0"
+__version__ = "2.0.2"
 __author__ = "Tural Muradov"
 __license__ = "MIT"
 

opa_python_client-2.0.2/opa_client/base.py

@@ -0,0 +1,147 @@
+import os
+from typing import Dict, Optional, Union
+from urllib.parse import urlencode
+
+from .errors import (
+	FileError,
+	PathNotFoundError,
+)
+
+
+class BaseClient:
+	"""
+	Base class for OpaClient implementations.
+
+	This class contains common logic shared between synchronous and asynchronous clients.
+	"""
+
+	def __init__(
+		self,
+		host: str = "localhost",
+		port: int = 8181,
+		version: str = "v1",
+		ssl: bool = False,
+		cert: Optional[Union[str, tuple]] = None,
+		headers: Optional[dict] = None,
+		timeout: float = 1.5,
+	):
+		if not isinstance(port, int):
+			raise TypeError("The port must be an integer")
+
+		self.host = host.strip()
+		self.port = port
+		self.version = version
+		self.ssl = ssl
+		self.cert = cert
+		self.timeout = timeout
+
+		self.schema = "https://" if ssl else "http://"
+		self.root_url = f"{self.schema}{self.host}:{self.port}/{self.version}"
+
+		self.headers = headers
+
+		self._session = None  # Will be initialized in the subclass
+		self.retries = 2
+		self.timeout = 1.5
+
+	def _build_url(
+		self, path: str, query_params: Dict[str, str] = None
+	) -> str:
+		url = f"{self.root_url}/{path.lstrip('/')}"
+		if query_params:
+			url = f"{url}?{urlencode(query_params)}"
+		return url
+
+	def _load_policy_from_file(self, filepath: str) -> str:
+		if not os.path.isfile(filepath):
+			raise FileError(f"'{filepath}' is not a valid file")
+		with open(filepath, "r", encoding="utf-8") as file:
+			return file.read()
+
+	def _save_policy_to_file(
+		self, policy_raw: str, path: Optional[str], filename: str
+	) -> bool:
+		full_path = os.path.join(path or "", filename)
+		try:
+			with open(full_path, "w", encoding="utf-8") as file:
+				file.write(policy_raw)
+			return True
+		except OSError as e:
+			raise PathNotFoundError(f"Failed to write to '{full_path}'") from e
+
+	# Abstract methods to be implemented in subclasses
+	def close_connection(self):
+		raise NotImplementedError
+
+	def check_connection(self) -> str:
+		raise NotImplementedError
+
+	def _init_session(self):
+		raise NotImplementedError
+
+	def check_health(
+		self, query: Dict[str, bool] = None, diagnostic_url: str = None
+	) -> bool:
+		raise NotImplementedError
+
+	def get_policies_list(self) -> list:
+		raise NotImplementedError
+
+	def get_policies_info(self) -> dict:
+		raise NotImplementedError
+
+	def update_policy_from_string(
+		self, new_policy: str, endpoint: str
+	) -> bool:
+		raise NotImplementedError
+
+	def update_policy_from_file(self, filepath: str, endpoint: str) -> bool:
+		raise NotImplementedError
+
+	def update_policy_from_url(self, url: str, endpoint: str) -> bool:
+		raise NotImplementedError
+
+	def update_or_create_data(self, new_data: dict, endpoint: str) -> bool:
+		raise NotImplementedError
+
+	def get_data(
+		self, data_name: str = "", query_params: Dict[str, bool] = None
+	) -> dict:
+		raise NotImplementedError
+
+	def policy_to_file(
+		self,
+		policy_name: str,
+		path: Optional[str] = None,
+		filename: str = "opa_policy.rego",
+	) -> bool:
+		raise NotImplementedError
+
+	def get_policy(self, policy_name: str) -> dict:
+		raise NotImplementedError
+
+	def delete_policy(self, policy_name: str) -> bool:
+		raise NotImplementedError
+
+	def delete_data(self, data_name: str) -> bool:
+		raise NotImplementedError
+
+	def check_permission(
+		self,
+		input_data: dict,
+		policy_name: str,
+		rule_name: str,
+		query_params: Dict[str, bool] = None,
+	) -> dict:
+		raise NotImplementedError
+
+	def query_rule(
+		self,
+		input_data: dict,
+		package_path: str,
+		rule_name: Optional[str] = None,
+	) -> dict:
+		raise NotImplementedError
+
+	def ad_hoc_query(self, query: str, input_data: dict = None) -> dict:
+		raise NotImplementedError

{opa_python_client-2.0.0 → opa_python_client-2.0.2}/opa_client/opa.py

@@ -1,4 +1,3 @@
-import json
 import os
 import threading
 from typing import Dict, Optional
@@ -10,15 +9,15 @@ from urllib3.util.retry import Retry
 
 from .base import BaseClient
 from .errors import (
-	CheckPermissionError,
-	ConnectionsError,
-	DeleteDataError,
-	DeletePolicyError,
-	FileError,
-	PathNotFoundError,
-	PolicyNotFoundError,
-	RegoParseError,
-	TypeException,
+    CheckPermissionError,
+    ConnectionsError,
+    DeleteDataError,
+    DeletePolicyError,
+    FileError,
+    PathNotFoundError,
+    PolicyNotFoundError,
+    RegoParseError,
+    TypeException,
 )
 
 
@@ -202,7 +201,7 @@ class OpaClient(BaseClient):
 		    bool: True if the policy was successfully updated.
 		"""
 		if not os.path.isfile(filepath):
-			raise FileError(f"'{filepath}' is not a valid file")
+			raise FileError("file_not_found",f"'{filepath}' is not a valid file")
 
 		with open(filepath, "r", encoding="utf-8") as file:
 			policy_str = file.read()
@@ -300,7 +299,7 @@ class OpaClient(BaseClient):
 		policy_raw = policy.get("result", {}).get("raw", "")
 
 		if not policy_raw:
-			raise PolicyNotFoundError("Policy content is empty")
+			raise PolicyNotFoundError("resource_not_found", "Policy content is empty")
 
 		full_path = os.path.join(path or "", filename)
 
@@ -309,7 +308,7 @@ class OpaClient(BaseClient):
 				file.write(policy_raw)
 			return True
 		except OSError as e:
-			raise PathNotFoundError(f"Failed to write to '{full_path}'") from e
+			raise PathNotFoundError("path_not_found", f"Failed to write to '{full_path}'") from e
 
 	def get_policy(self, policy_name: str) -> dict:
 		"""
@@ -395,7 +394,7 @@ class OpaClient(BaseClient):
 
 		if rule_name not in rules:
 			raise CheckPermissionError(
-				f"Rule '{rule_name}' not found in policy '{policy_name}'"
+				"resource_not_found", f"Rule '{rule_name}' not found in policy '{policy_name}'"
 			)
 
 		url = f"{self.root_url}/{package_path}/{rule_name}"
@@ -456,89 +455,6 @@ class OpaClient(BaseClient):
 		response.raise_for_status()
 		return response.json()
 
-	# # Property methods for read-only access to certain attributes
-	# @property
-	# def host(self) -> str:
-	#     return self._host
-
-	# @host.setter
-	# def host(self, value: str):
-	#     self._host = value
-
-	# @property
-	# def port(self) -> int:
-	#     return self._port
-
-	# @port.setter
-	# def port(self, value: int):
-	#     if not isinstance(value, int):
-	#         raise TypeError('Port must be an integer')
-	#     self._port = value
-
-	# @property
-	# def version(self) -> str:
-	#     return self._version
-
-	# @version.setter
-	# def version(self, value: str):
-	#     self._version = value
-
-	# @property
-	# def schema(self) -> str:
-	#     return self._schema
-
-	# @schema.setter
-	# def schema(self, value: str):
-	#     self._schema = value
-
-	# @property
-	# def root_url(self) -> str:
-	#     return self._root_url
-
-	# @root_url.setter
-	# def root_url(self, value: str):
-	#     self._root_url = value
-
-	# @property
-	# def ssl(self) -> bool:
-	#     return self._ssl
-
-	# @ssl.setter
-	# def ssl(self, value: bool):
-	#     self._ssl = value
-
-	# @property
-	# def cert(self) -> Optional[str]:
-	#     return self._cert
-
-	# @cert.setter
-	# def cert(self, value: Optional[str]):
-	#     self._cert = value
-
-	# @property
-	# def headers(self) -> dict:
-	#     return self._headers
-
-	# @headers.setter
-	# def headers(self, value: dict):
-	#     self._headers = value
-
-	# @property
-	# def retries(self) -> int:
-	#     return self._retries
-
-	# @retries.setter
-	# def retries(self, value: int):
-	#     self._retries = value
-
-	# @property
-	# def timeout(self) -> float:
-	#     return self._timeout
-
-	# @timeout.setter
-	# def timeout(self, value: float):
-	#     self._timeout = value
-
 
 # Example usage:
 if __name__ == "__main__":

{opa_python_client-2.0.0 → opa_python_client-2.0.2}/pyproject.toml

@@ -1,8 +1,8 @@
 [tool.poetry]
 name = "opa-python-client"
-version = "2.0.0"
+version = "2.0.2"
 description = "Client for connection to the OPA service"
-authors = ["Tural Muradov <tural_m@hotmail.com>"]
+authors = ["Tural Muradov <tural.muradoov@gmail.com>"]
 license = "MIT"
 readme = "README.md"
 homepage = "https://github.com/Turall/OPA-python-client"

opa_python_client-2.0.0/opa_client/base.py

@@ -1,286 +0,0 @@
-import os
-from typing import Dict, Optional, Union
-from urllib.parse import urlencode
-
-from .errors import (
-	FileError,
-	PathNotFoundError,
-)
-
-
-class BaseClient:
-	"""
-	Base class for OpaClient implementations.
-
-	This class contains common logic shared between synchronous and asynchronous clients.
-	"""
-
-	def __init__(
-		self,
-		host: str = "localhost",
-		port: int = 8181,
-		version: str = "v1",
-		ssl: bool = False,
-		cert: Optional[Union[str, tuple]] = None,
-		headers: Optional[dict] = None,
-		timeout: float = 1.5,
-	):
-		if not isinstance(port, int):
-			raise TypeError("The port must be an integer")
-
-		self.host = host.strip()
-		self.port = port
-		self.version = version
-		self.ssl = ssl
-		self.cert = cert
-		self.timeout = timeout
-
-		self.schema = "https://" if ssl else "http://"
-		self.root_url = f"{self.schema}{self.host}:{self.port}/{self.version}"
-
-		self.headers = headers
-
-		self._session = None  # Will be initialized in the subclass
-		self.retries = 2
-		self.timeout = 1.5
-
-	def _build_url(
-		self, path: str, query_params: Dict[str, str] = None
-	) -> str:
-		url = f"{self.root_url}/{path.lstrip('/')}"
-		if query_params:
-			url = f"{url}?{urlencode(query_params)}"
-		return url
-
-	def _load_policy_from_file(self, filepath: str) -> str:
-		if not os.path.isfile(filepath):
-			raise FileError(f"'{filepath}' is not a valid file")
-		with open(filepath, "r", encoding="utf-8") as file:
-			return file.read()
-
-	def _save_policy_to_file(
-		self, policy_raw: str, path: Optional[str], filename: str
-	) -> bool:
-		full_path = os.path.join(path or "", filename)
-		try:
-			with open(full_path, "w", encoding="utf-8") as file:
-				file.write(policy_raw)
-			return True
-		except OSError as e:
-			raise PathNotFoundError(f"Failed to write to '{full_path}'") from e
-
-	# Abstract methods to be implemented in subclasses
-	def close_connection(self):
-		raise NotImplementedError
-
-	def check_connection(self) -> str:
-		raise NotImplementedError
-
-	def _init_session(self):
-		raise NotImplementedError
-
-	def check_health(
-		self, query: Dict[str, bool] = None, diagnostic_url: str = None
-	) -> bool:
-		raise NotImplementedError
-
-	def get_policies_list(self) -> list:
-		raise NotImplementedError
-
-	def get_policies_info(self) -> dict:
-		raise NotImplementedError
-
-	def update_policy_from_string(
-		self, new_policy: str, endpoint: str
-	) -> bool:
-		raise NotImplementedError
-
-	def update_policy_from_file(self, filepath: str, endpoint: str) -> bool:
-		raise NotImplementedError
-
-	def update_policy_from_url(self, url: str, endpoint: str) -> bool:
-		raise NotImplementedError
-
-	def update_or_create_data(self, new_data: dict, endpoint: str) -> bool:
-		raise NotImplementedError
-
-	def get_data(
-		self, data_name: str = "", query_params: Dict[str, bool] = None
-	) -> dict:
-		raise NotImplementedError
-
-	def policy_to_file(
-		self,
-		policy_name: str,
-		path: Optional[str] = None,
-		filename: str = "opa_policy.rego",
-	) -> bool:
-		raise NotImplementedError
-
-	def get_policy(self, policy_name: str) -> dict:
-		raise NotImplementedError
-
-	def delete_policy(self, policy_name: str) -> bool:
-		raise NotImplementedError
-
-	def delete_data(self, data_name: str) -> bool:
-		raise NotImplementedError
-
-	def check_permission(
-		self,
-		input_data: dict,
-		policy_name: str,
-		rule_name: str,
-		query_params: Dict[str, bool] = None,
-	) -> dict:
-		raise NotImplementedError
-
-	def query_rule(
-		self,
-		input_data: dict,
-		package_path: str,
-		rule_name: Optional[str] = None,
-	) -> dict:
-		raise NotImplementedError
-
-	def ad_hoc_query(self, query: str, input_data: dict = None) -> dict:
-		raise NotImplementedError
-
-
-# class OpaClient(BaseOpaClient):
-#     """
-#     Synchronous OpaClient implementation using requests.
-#     """
-
-#     def __init__(self, *args, **kwargs):
-#         super().__init__(*args, **kwargs)
-
-#         self._init_session()
-
-#     def _init_session(self):
-#         self._session = requests.Session()
-#         self._session.headers.update(self.headers)
-
-#         if self.ssl:
-#             self._session.verify = self.cert if self.cert else True
-
-#         # Optionally, configure retries and other session parameters
-
-#     def close_connection(self):
-#         if self._session:
-#             self._session.close()
-#             self._session = None
-
-#     def check_connection(self) -> str:
-#         url = self._build_url('policies/')
-#         try:
-#             response = self._session.get(url, timeout=self.timeout)
-#             response.raise_for_status()
-#             return "Yes, I'm here :)"
-#         except requests.exceptions.RequestException as e:
-#             raise ConnectionsError('Service unreachable', 'Check config and try again') from e
-
-#     # Implement other synchronous methods similarly
-#     # For example:
-#     def get_policies_list(self) -> list:
-#         url = self._build_url('policies/')
-#         response = self._session.get(url, timeout=self.timeout)
-#         response.raise_for_status()
-#         policies = response.json().get('result', [])
-#         return [policy.get('id') for policy in policies if policy.get('id')]
-
-#     # ... Rest of synchronous methods ...
-
-
-# class AsyncOpaClient(BaseOpaClient):
-#     """
-#     Asynchronous OpaClient implementation using aiohttp.
-#     """
-
-#     async def __aenter__(self):
-#         await self._init_session()
-#         return self
-
-#     async def __aexit__(self, exc_type, exc_value, traceback):
-#         await self.close_connection()
-
-#     async def _init_session(self):
-#         ssl_context = None
-
-#         if self.ssl:
-#             ssl_context = ssl.create_default_context()
-#             if self.cert:
-#                 if isinstance(self.cert, tuple):
-#                     ssl_context.load_cert_chain(*self.cert)
-#                 else:
-#                     ssl_context.load_cert_chain(self.cert)
-#             else:
-#                 ssl_context.load_default_certs()
-
-#         connector = aiohttp.TCPConnector(ssl=ssl_context)
-
-#         self._session = aiohttp.ClientSession(
-#             headers=self.headers,
-#             connector=connector,
-#             timeout=aiohttp.ClientTimeout(total=self.timeout),
-#         )
-
-#     async def close_connection(self):
-#         if self._session and not self._session.closed:
-#             await self._session.close()
-#             self._session = None
-
-#     async def check_connection(self) -> str:
-#         url = self._build_url('policies/')
-#         try:
-#             async with self._session.get(url) as response:
-#                 if response.status == 200:
-#                     return "Yes, I'm here :)"
-#                 else:
-#                     raise ConnectionsError('Service unreachable', 'Check config and try again')
-#         except Exception as e:
-#             raise ConnectionsError('Service unreachable', 'Check config and try again') from e
-
-#     # Implement other asynchronous methods similarly
-#     # For example:
-#     async def get_policies_list(self) -> list:
-#         url = self._build_url('policies/')
-#         async with self._session.get(url) as response:
-#             response.raise_for_status()
-#             policies = await response.json()
-#             result = policies.get('result', [])
-#             return [policy.get('id') for policy in result if policy.get('id')]
-
-#     # ... Rest of asynchronous methods ...
-
-
-# # Example usage:
-
-# # Synchronous client
-# def sync_example():
-#     client = OpaClient(host='localhost', port=8181)
-#     try:
-#         result = client.check_connection()
-#         print(result)
-#         policies = client.get_policies_list()
-#         print("Policies:", policies)
-#     finally:
-#         client.close_connection()
-
-
-# # Asynchronous client
-# async def async_example():
-#     async with AsyncOpaClient(host='localhost', port=8181) as client:
-#         result = await client.check_connection()
-#         print(result)
-#         policies = await client.get_policies_list()
-#         print("Policies:", policies)
-
-
-# if __name__ == '__main__':
-#     # Run synchronous example
-#     sync_example()
-
-#     # Run asynchronous example
-#     import asyncio
-#     asyncio.run(async_example())