pyrest-model-client 0.0.1__py3-none-any.whl

pyrest_model_client/__init__.py

@@ -0,0 +1,13 @@
+from dotenv import load_dotenv
+
+from pyrest_model_client.client import RequestClient, build_header
+from pyrest_model_client.base import BaseAPIModel, set_client
+
+load_dotenv()
+
+__all__ = [
+    "RequestClient",
+    "build_header",
+    "BaseAPIModel",
+    "set_client",
+]

pyrest_model_client/base.py

@@ -0,0 +1,45 @@
+from typing import ClassVar
+
+from pydantic import BaseModel
+
+from pyrest_model_client.client import RequestClient
+
+
+def set_client(new_client: RequestClient):
+    """Set the global client instance for all API models."""
+    global client
+    client = new_client
+
+
+class BaseAPIModel(BaseModel):
+    id: int | str | None = None
+    _resource_path: ClassVar[str] = ""
+
+    def save(self) -> None:
+        data = self.model_dump(exclude_unset=True)
+        if self.id:
+            response = client.put(f"/{self._resource_path}/{self.id}", json=data)
+        else:
+            response = client.post(f"/{self._resource_path}", json=data)
+        response.raise_for_status()
+        self.id = response.json()["id"]
+
+    def delete(self) -> None:
+        if not self.id:
+            raise ValueError("Cannot delete unsaved resource.")
+        response = client.delete(f"/{self._resource_path}/{self.id}")
+        response.raise_for_status()
+
+    @classmethod
+    def load(cls, resource_id: str):
+        response = client.get(f"/{cls._resource_path}/{resource_id}")
+        if response.status_code == 404:
+            raise ValueError(f"{cls.__name__} not found.")
+        response.raise_for_status()
+        return cls(**response.json())
+
+    @classmethod
+    def find(cls):
+        response = client.get(f"/{cls._resource_path}")
+        response.raise_for_status()
+        return [cls(**item) for item in response.json()]

pyrest_model_client/client.py

@@ -0,0 +1,50 @@
+from typing import Optional
+
+import httpx
+
+
+def build_header(token: str, authorization_type: str = "Token", content_type: str = "application/json") -> dict:
+    return {
+        "Content-Type": content_type,
+        "Authorization": f"{authorization_type} {token}",
+    }
+
+
+class RequestClient:
+    def __init__(self, header: dict, base_url: str = "http://localhost:8000"):
+        self.base_url = base_url
+        self.client = httpx.Client(base_url=self.base_url)
+        self.set_credentials(header=header)
+
+    def set_credentials(self, header: dict):
+        self.client.headers.update(header)
+
+    def request(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
+        if not endpoint.startswith("http://") and not endpoint.startswith("https://"):
+            if not endpoint.startswith("/"):  # Ensure endpoint starts with a slash if it's a path (not a full URL)
+                endpoint = "/" + endpoint
+
+        if not endpoint.endswith("/"):  # Ensure endpoint ends with a slash
+            endpoint = endpoint + "/"
+
+        response = self.client.request(method, endpoint, **kwargs)
+        response.raise_for_status()
+        return response
+
+    def get(self, endpoint: str, params: Optional[dict] = None) -> httpx.Response:
+        if params is None:
+            params = {}
+        return self.request("GET", endpoint, params=params)
+
+    def post(self, endpoint: str, json: Optional[dict] = None) -> httpx.Response:
+        if json is None:
+            json = {}
+        return self.request("POST", endpoint, json=json)
+
+    def put(self, endpoint: str, json: Optional[dict] = None) -> httpx.Response:
+        if json is None:
+            json = {}
+        return self.request("PUT", endpoint, json=json)
+
+    def delete(self, endpoint: str) -> httpx.Response:
+        return self.request("DELETE", endpoint)

pyrest_model_client-0.0.1.dist-info/METADATA

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: pyrest-model-client
+Version: 0.0.1
+Summary: A simple, flexible Python HTTP client and API modeling toolkit built on httpx and pydantic.
+Home-page: https://github.com/aviz92/pyrest-model-client
+Author: Avi Zaguri
+Author-email: 
+Project-URL: Repository, https://github.com/aviz92/pyrest-model-client
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: setuptools
+Requires-Dist: dotenv
+Requires-Dist: wheel
+Requires-Dist: colorlog
+Requires-Dist: pytest
+Requires-Dist: pathlib
+Requires-Dist: httpx
+Requires-Dist: pydantic
+Requires-Dist: custom-python-logger
+Requires-Dist: pytest-plugins
+Requires-Dist: python-simple-email-sender
+Requires-Dist: python-vault
+Requires-Dist: PyYAML
+Requires-Dist: pytest-asyncio
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# python-requests-client
+
+A simple, flexible Python HTTP client and API modeling toolkit built on top of [httpx](https://www.python-httpx.org/) and [pydantic](https://docs.pydantic.dev/). Easily integrate robust API requests and resource models into your Python projects.
+
+---
+
+## 🚀 Features
+- **Model-driven**: Define and interact with API resources as Python classes.
+- **Easy HTTP Requests**: Simple `RequestClient` for GET, POST, PUT, DELETE with automatic header and base URL management.
+- **Pydantic API Models**: Define resource models with CRUD helpers (`save`, `delete`, `load`, `find`).
+- **Global Client Setup**: Set a global API client for all models with `set_client()`.
+- **Type Safety**: All models use Pydantic for validation and serialization.
+- **Extensible**: Easily create new models for any RESTful resource.
+
+---
+
+## 📦 Installation
+```bash
+pip install python-requests-client
+```
+
+---
+
+## 🔧 Usage
+
+### 1. Define Your Models
+
+```python
+from pyrest_model_client.base import BaseAPIModel
+from typing import ClassVar
+
+
+class User(BaseAPIModel):
+  name: str
+  email: str
+  _resource_path: ClassVar[str] = "user"
+
+
+class Environment(BaseAPIModel):
+  name: str
+  _resource_path: ClassVar[str] = "environment"
+```
+
+### 2. Initialize the Client
+
+```python
+from pyrest_model_client import RequestClient, build_header, set_client
+from example_usage.models.user import User
+from example_usage.models.environment import Environment
+
+set_client(
+  new_client=RequestClient(
+    base_url="http://localhost:8000",
+    header=build_header(token="YOUR_API_TOKEN")
+  )
+)
+
+# Create and save a new user
+e = User(name="Alice", email="alice@example.com")
+e.save()
+
+# Update and save
+e.name = "Alice Smith"
+e.save()
+
+# Find all environments
+environments = Environment.find()
+print(environments)
+
+# Load a specific user by ID
+user = User.load(resource_id="123")
+
+# Delete a user
+user.delete()
+```
+
+---
+
+## 🤝 Contributing
+Contributions are welcome! Please fork the repo, create a branch, and submit a pull request.
+
+---
+
+## 📄 License
+MIT License — see [LICENSE](LICENSE) for details.

pyrest_model_client-0.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+pyrest_model_client/__init__.py,sha256=4CE5p2_nPxK7yAElL32waZFhvw-mBrJv2Slx-8UzoF0,270
+pyrest_model_client/base.py,sha256=4mbheCcAi8cveq7ceUfREBvwBRNSZF1jVdGXREOjNsU,1420
+pyrest_model_client/client.py,sha256=ke167iQBPg0pUFmVirJREHLF8AIw5cqAvQ2cJa1mw-M,1838
+pyrest_model_client-0.0.1.dist-info/licenses/LICENSE,sha256=cSikHY6SZFsPZSBizCDAJ0-Bjjzxt-JtX6TVbKxwimo,1067
+pyrest_model_client-0.0.1.dist-info/METADATA,sha256=UJ6EQMWMLZ_aYmiyt2XSRESnsgU5bHDIlZQX-C-DBnA,3078
+pyrest_model_client-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pyrest_model_client-0.0.1.dist-info/top_level.txt,sha256=HDtId78s9PTvfjerF5g7kRRe5Z91lgXlPr56w0E7wdU,20
+pyrest_model_client-0.0.1.dist-info/RECORD,,

pyrest_model_client-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyrest_model_client-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Avi Zaguri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyrest_model_client-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyrest_model_client