remnapy 2.3.3

A Python SDK for interacting with the Remnawave API v2.3.0.

Remnawave Python SDK

[!WARNING] This repository is a fork of the official SDK remnawave/python-sdk.

A Python SDK client for interacting with the Remnawave API. This library simplifies working with the API by providing convenient controllers, Pydantic models for requests and responses, and fast serialization with orjson.

🎉 Version 2.3.0 brings full compatibility with the latest Remnawave backend API, including new endpoints, improved response wrappers, and enhanced type safety.

✨ Key Features

• Full v2.3.0 API compatibility: Updated for latest Remnawave backend features
• New controllers: ConfigProfiles, InternalSquads, InfraBilling, NodesUsageHistory
• Enhanced models: OpenAPI-compliant response wrappers with improved field mappings
• 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.
• Backward compatibility: Legacy aliases maintained for smooth migration.

📦 Installation

Production Version

Install the latest version from the new PyPI package:

pip install remnapy

Development Version

If you need the development version:

pip install git+https://github.com/snoups/remnapy.git@development

---

🫥 Compatible versions

Contract Version	Remnawave Panel Version
2.3.0	>=2.3.0

Dependencies

• orjson (>=3.10.15, <4.0.0)
• rapid-api-client (==0.6.0)
• httpx (>=0.27.2, <0.28.0)

🚀 Usage

Here’s a quick example to get you started:

import os
import asyncio

from remnapy import RemnawaveSDK  # Updated import for new package
from remnapy.models import (  # Updated import path
    UsersResponseDto, 
    UserResponseDto,
    GetAllConfigProfilesResponseDto,
    CreateInternalSquadRequestDto
)

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)

if __name__ == "__main__":
    asyncio.run(main())

---

🧪 Running Tests

To run the test suite, use Poetry:

poetry run pytest

❤️ About

This SDK was originally developed by @kesevone for integration with Remnawave's API.

Previously maintained by @sm1ky at sm1ky/remnawave-api.

The official Remnawave repository is located at remnawave/python-sdk.

This repository is a fork of the official SDK.