unraid-api 0.1.0__tar.gz

unraid_api-0.1.0/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.4
+Name: unraid-api
+Version: 0.1.0
+Summary: Python library for Unraid GraphQL API
+Home-page: https://github.com/domalab/pyunraid
+Author: Ruaan Deysel
+Author-email: ruaan.deysel@gmail.com
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.23.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: graphql-core>=3.2.0
+Requires-Dist: typeguard>=2.13.0
+Requires-Dist: websockets>=10.3
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.18.0; extra == "dev"
+Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.10.0; extra == "dev"
+Requires-Dist: mypy>=0.950; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: home-page
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

unraid_api-0.1.0/README.md

@@ -0,0 +1,62 @@
+# PyUnraid: Python Library for Unraid GraphQL API
+
+A comprehensive Python library that provides a clean, intuitive interface to Unraid's GraphQL API. It enables developers to programmatically control and monitor Unraid servers with both synchronous and asynchronous support, strong typing, and intelligent error handling.
+
+## Installation
+
+```bash
+pip install pyunraid
+```
+
+## Usage
+
+### Simple Synchronous Example
+
+```python
+from pyunraid import UnraidClient
+
+# Connect to Unraid server
+client = UnraidClient("192.168.1.10")
+client.login("username", "password")
+
+# Get system info
+system_info = client.get_system_info()
+print(f"System version: {system_info.version}")
+
+# Start the array
+client.system.start_array()
+```
+
+### Async Example
+
+```python
+import asyncio
+from pyunraid.async_client import AsyncUnraidClient
+
+async def main():
+    client = AsyncUnraidClient("192.168.1.10")
+    await client.login("username", "password")
+    
+    # Get all Docker containers
+    containers = await client.docker.get_containers()
+    for container in containers:
+        print(f"Container: {container.name}, Status: {container.status}")
+    
+    # Perform a parity check
+    await client.system.start_parity_check()
+
+asyncio.run(main())
+```
+
+## Features
+
+- Complete access to Unraid GraphQL API endpoints
+- Both synchronous and asynchronous interfaces
+- Automatic token refresh and management
+- Strongly-typed Python classes using Pydantic
+- Comprehensive error handling
+- Request/response logging for debugging
+
+## License
+
+MIT License

unraid_api-0.1.0/pyunraid/__init__.py

@@ -0,0 +1,34 @@
+"""PyUnraid: Python Library for Unraid GraphQL API."""
+
+from .client import UnraidClient
+from .client_async import AsyncUnraidClient
+from .exceptions import (
+    PyUnraidError,
+    AuthenticationError,
+    TokenExpiredError,
+    ConnectionError,
+    APIError,
+    ValidationError,
+    ResourceNotFoundError,
+    OperationError,
+    GraphQLError,
+    SubscriptionError,
+    RateLimitError,
+)
+
+__version__ = "0.1.0"
+__all__ = [
+    "UnraidClient",
+    "AsyncUnraidClient",
+    "PyUnraidError",
+    "AuthenticationError",
+    "TokenExpiredError",
+    "ConnectionError",
+    "APIError",
+    "ValidationError",
+    "ResourceNotFoundError",
+    "OperationError",
+    "GraphQLError",
+    "SubscriptionError",
+    "RateLimitError",
+]