Merge pull request #49 from sm1ky/patch-1

Update SDK Python data

docs/sdk/python-sdk.md

@@ -10,11 +10,20 @@ import { FaPeopleGroup } from "react-icons/fa6";
 This SDK is fully community-maintained.
 </Admonition>
 
-TODO: add description
-
+Remnawave Python SDK is a library for convenient interaction with the RestAPI types.
+✨ Key Features
+	•	Controller-based design: Split functionality into separate controllers for flexibility. Use only what you need!
+	•	Pydantic models: Strongly-typed requests and responses for better reliability.
+	•	Fast serialization: Powered by orjson for efficient JSON handling.
+	•	Modular usage: Import individual controllers or the full SDK as needed.
+	•	Custom HTTP Client Support: You can pass your own httpx.AsyncClient with custom headers to bypass various checks.
+	•	Caddy Token Integration: Direct support for passing the caddy_token during SDK initialization.
+ 
 ## Installation
 
-TODO: add installation instructions
+```bash
+pip install remnawave_api
+```
 
 ## Usage
 
@@ -22,11 +31,108 @@ TODO: add installation instructions
 <summary>Example usage</summary>
 
 ```python
-import requests
+import os
+import asyncio
 
-from remnawave.backend_contract import GetUserByUsernameCommand
+from remnawave_api import RemnawaveSDK
+from remnawave_api.models import UsersResponseDto, UserResponseDto
 
-# TODO: add example
+async def main():
+    # URL to your panel (ex. https://vpn.com or http://127.0.0.1:3000)
+    base_url: str = os.getenv("REMNAWAVE_BASE_URL")
+    # Bearer Token from panel (section: API Tokens) 
+    token: str = os.getenv("REMNAWAVE_TOKEN")
+
+    # Initialize the SDK
+    remnawave = RemnawaveSDK(base_url=base_url, token=token)
+
+    # Fetch all users
+    response: UsersResponseDto = await remnawave.users.get_all_users_v2()
+    total_users: int = response.total
+    users: list[UserResponseDto] = response.users
+    print("Total users: ", total_users)
+    print("List of users: ", users)
+
+    # Disable a specific user
+    test_uuid: str = "e4d3f3d2-4f4f-4f4f-4f4f-4f4f4f4f4f4f"
+    disabled_user: UserResponseDto = await remnawave.users.disable_user(test_uuid)
+    print("Disabled user: ", disabled_user)
+
+if __name__ == "__main__":
+    asyncio.run(main())
 ```
 
 </details>
+
+<details>
+<summary>Example usage with Caddy as web-server</summary>
+
+```python
+import os
+import asyncio
+
+from remnawave_api import RemnawaveSDK
+from remnawave_api.models import UsersResponseDto, UserResponseDto
+
+async def main():
+    # URL to your panel (ex. https://vpn.com or http://127.0.0.1:3000)
+    base_url: str = os.getenv("REMNAWAVE_BASE_URL")
+    # Bearer Token from panel (section: API Tokens) 
+    token: str = os.getenv("REMNAWAVE_TOKEN")
+    # Bearer Token for Caddy Auth
+    caddy_token = os.getenv("CADDY_TOKEN_AUTH")
+
+    # Initialize the SDK
+    remnawave = RemnawaveSDK(base_url=base_url, token=token, caddy_token=caddy_token)
+
+    # Fetch all users
+    response: UsersResponseDto = await remnawave.users.get_all_users_v2()
+    total_users: int = response.total
+    users: list[UserResponseDto] = response.users
+    print("Total users: ", total_users)
+    print("List of users: ", users)
+
+    # Disable a specific user
+    test_uuid: str = "e4d3f3d2-4f4f-4f4f-4f4f-4f4f4f4f4f4f"
+    disabled_user: UserResponseDto = await remnawave.users.disable_user(test_uuid)
+    print("Disabled user: ", disabled_user)
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+</details>
+
+<details>
+<summary>Example usage with custom client</summary>
+
+```python
+import os
+import asyncio
+import httpx
+from remnawave_api import RemnawaveSDK
+
+async def main():
+    base_url = os.getenv("REMNAWAVE_BASE_URL")
+    token = os.getenv("REMNAWAVE_TOKEN")
+
+    # Custom client with headers
+    async with httpx.AsyncClient(headers={"hello": "world"}) as client:
+        # Initialize SDK with a custom client
+        remnawave = RemnawaveSDK(base_url=base_url, token=token, client=client)
+
+        # Fetch all users
+        response = await remnawave.users.get_all_users_v2()
+        print("Total users:", response.total)
+
+asyncio.run(main())
+```
+
+</details>
+
+
+## 🛠️ Project Links
+
+- **GitHub Repository:** [Remnawave API on GitHub](https://github.com/sm1ky/remnawave-api)
+- **Author:** [Artem (sm1ky)](https://github.com/sm1ky)
+