marzban 0.1.2__py3-none-any.whl

marzban/__init__.py

@@ -0,0 +1,4 @@
+from .client.py import MarzbanAPI
+from .models.py import *
+
+__version__ = "0.1.2"

marzban/clients.py

@@ -0,0 +1,257 @@
+import httpx
+from typing import Any, Dict, Optional, List
+from .models import *
+
+class MarzbanAPI:
+    def __init__(self, base_url: str):
+        self.base_url = base_url
+        self.client = httpx.AsyncClient(base_url=base_url)
+
+    def _get_headers(self, token: str) -> Dict[str, str]:
+        return {"Authorization": f"Bearer {token}"}
+
+    async def get_token(self, username: str, password: str) -> Token:
+        url = "/api/admin/token"
+        payload = {
+            "grant_type": "password",
+            "username": username,
+            "password": password,
+            "scope": "",
+            "client_id": "",
+            "client_secret": ""
+        }
+        response = await self.client.post(url, data=payload)
+        response.raise_for_status()
+        return Token(**response.json())
+
+    async def get_current_admin(self, token: str) -> Admin:
+        url = "/api/admin"
+        response = await self.client.get(url, headers=self._get_headers(token))
+        response.raise_for_status()
+        return Admin(**response.json())
+
+    async def create_admin(self, admin: AdminCreate, token: str) -> Admin:
+        url = "/api/admin"
+        response = await self.client.post(url, json=admin.dict(), headers=self._get_headers(token))
+        response.raise_for_status()
+        return Admin(**response.json())
+
+    async def modify_admin(self, username: str, admin: AdminModify, token: str) -> Admin:
+        url = f"/api/admin/{username}"
+        response = await self.client.put(url, json=admin.dict(), headers=self._get_headers(token))
+        response.raise_for_status()
+        return Admin(**response.json())
+
+    async def remove_admin(self, username: str, token: str) -> None:
+        url = f"/api/admin/{username}"
+        response = await self.client.delete(url, headers=self._get_headers(token))
+        response.raise_for_status()
+    
+    async def get_admins(self, token: str, offset: Optional[int] = None, limit: Optional[int] = None, username: Optional[str] = None) -> List[Admin]:
+        url = "/api/admins"
+        params = {"offset": offset, "limit": limit, "username": username}
+        response = await self.client.get(url, headers=self._get_headers(token), params=params)
+        response.raise_for_status()
+        return [Admin(**admin) for admin in response.json()]
+
+    async def get_system_stats(self, token: str) -> SystemStats:
+        url = "/api/system"
+        response = await self.client.get(url, headers=self._get_headers(token))
+        response.raise_for_status()
+        return SystemStats(**response.json())
+
+    async def get_inbounds(self, token: str) -> Dict[str, List[ProxyInbound]]:
+        url = "/api/inbounds"
+        response = await self.client.get(url, headers=self._get_headers(token))
+        response.raise_for_status()
+        return response.json()
+
+    async def get_hosts(self, token: str) -> Dict [str, List[ProxyHost]]:
+        url = "/api/hosts"
+        response = await self.client.get(url, headers=self._get_headers(token))
+        response.raise_for_status()
+        return response.json()
+    
+    async def modify_hosts(self, hosts: Dict[str, List[ProxyHost]], token: str) -> Dict[str, List[ProxyHost]]:
+        url = "/api/hosts"
+        response = await self.client.put(url, json=hosts, headers=self._get_headers(token))
+        response.raise_for_status()
+        return response.json()
+
+    async def get_core_stats(self, token: str) -> CoreStats:
+        url = "/api/core"
+        response = await self.client.get(url, headers=self._get_headers(token))
+        response.raise_for_status()
+        return CoreStats(**response.json())
+
+    async def restart_core(self, token: str) -> None:
+        url = "/api/core/restart"
+        response = await self.client.post(url, headers=self._get_headers(token))
+        response.raise_for_status()
+
+    async def get_core_config(self, token: str) -> Dict[str, Any]:
+        url = "/api/core/config"
+        response = await self.client.get(url, headers=self._get_headers(token))
+        response.raise_for_status()
+        return response.json()
+
+    async def modify_core_config(self, config: Dict[str, Any], token: str) -> Dict[str, Any]:
+        url = "/api/core/config"
+        response = await self.client.put(url, json=config, headers=self._get_headers(token))
+        response.raise_for_status()
+        return response.json()
+
+    async def add_user(self, user: UserCreate, token: str) -> UserResponse:
+        url = "/api/user"
+        response = await self.client.post(url, json=user.dict(), headers=self._get_headers(token))
+        response.raise_for_status()
+        return UserResponse(**response.json())
+
+    async def get_user(self, username: str, token: str) -> UserResponse:
+        url = f"/api/user/{username}"
+        response = await self.client.get(url, headers=self._get_headers(token))
+        response.raise_for_status()
+        return UserResponse(**response.json())
+
+    async def modify_user(self, username: str, user: UserModify, token: str) -> UserResponse:
+        url = f"/api/user/{username}"
+        response = await self.client.put(url, json=user.dict(), headers=self._get_headers(token))
+        response.raise_for_status()
+        return UserResponse(**response.json())
+
+    async def remove_user(self, username: str, token: str) -> None:
+        url = f"/api/user/{username}"
+        response = await self.client.delete(url, headers=self._get_headers(token))
+        response.raise_for_status()
+
+    async def reset_user_data_usage(self, username: str, token: str) -> UserResponse:
+        url = f"/api/user/{username}/reset"
+        response = await self.client.post(url, headers=self._get_headers(token))
+        response.raise_for_status()
+        return UserResponse(**response.json())
+
+    async def revoke_user_subscription(self, username: str, token: str) -> UserResponse:
+        url = f"/api/user/{username}/revoke_sub"
+        response = await self.client.post(url, headers=self._get_headers(token))
+        response.raise_for_status()
+        return UserResponse(**response.json())
+
+    async def get_users(self, token: str, offset: Optional[int] = None, limit: Optional[int] = None, username: Optional[List[str]] = None, status: Optional[str] = None, sort: Optional[str] = None) -> UsersResponse:
+        url = "/api/users"
+        params = {"offset": offset, "limit": limit, "username": username, "status": status, "sort": sort}
+        response = await self.client.get(url, headers=self._get_headers(token), params=params)
+        response.raise_for_status()
+        return UsersResponse(**response.json())
+
+    async def reset_users_data_usage(self, token: str) -> None:
+        url = "/api/users/reset"
+        response = await self.client.post(url, headers=self._get_headers(token))
+        response.raise_for_status()
+
+    async def get_user_usage(self, username: str, token: str, start: Optional[str] = None, end: Optional[str] = None) -> UserUsagesResponse:
+        url = f"/api/user/{username}/usage"
+        params = {"start": start, "end": end}
+        response = await self.client.get(url, headers=self._get_headers(token), params=params)
+        response.raise_for_status()
+        return UserUsagesResponse(**response.json())
+
+    async def set_owner(self, username: str, admin_username: str, token: str) -> UserResponse:
+        url = f"/api/user/{username}/set-owner"
+        params = {"admin_username": admin_username}
+        response = await self.client.put(url, headers=self._get_headers(token), params=params)
+        response.raise_for_status()
+        return UserResponse(**response.json())
+
+    async def get_expired_users(self, token: str, expired_before: Optional[str] = None, expired_after: Optional[str] = None) -> List[str]:
+        url = "/api/users/expired"
+        params = {"expired_before": expired_before, "expired_after": expired_after}
+        response = await self.client.get(url, headers=self._get_headers(token), params=params)
+        response.raise_for_status()
+        return response.json()
+
+    async def delete_expired_users(self, token: str, expired_before: Optional[str] = None, expired_after: Optional[str] = None) -> List[str]:
+        url = "/api/users/expired"
+        params = {"expired_before": expired_before, "expired_after": expired_after}
+        response = await self.client.delete(url, headers=self._get_headers(token), params=params)
+        response.raise_for_status()
+        return response.json()
+
+    async def get_user_templates(self, token: str, offset: Optional[int] = None, limit: Optional[int] = None) -> List[UserTemplateResponse]:
+        url = "/api/user_template"
+        params = {"offset": offset, "limit": limit}
+        response = await self.client.get(url, headers=self._get_headers(token), params=params)
+        response.raise_for_status()
+        return [UserTemplateResponse(**template) for template in response.json()]
+
+    async def add_user_template(self, template: UserTemplateCreate, token: str) -> UserTemplateResponse:
+        url = "/api/user_template"
+        response = await self.client.post(url, json=template.dict(), headers=self._get_headers(token))
+        response.raise_for_status()
+        return UserTemplateResponse(**response.json())
+
+    async def get_user_template(self, template_id: int, token: str) -> UserTemplateResponse:
+        url = f"/api/user_template/{template_id}"
+        response = await self.client.get(url, headers=self._get_headers(token))
+        response.raise_for_status()
+        return UserTemplateResponse(**response.json())
+
+    async def modify_user_template(self, template_id: int, template: UserTemplateModify, token: str) -> UserTemplateResponse:
+        url = f"/api/user_template/{template_id}"
+        response = await self.client.put(url, json=template.dict(), headers=self._get_headers(token))
+        response.raise_for_status()
+        return UserTemplateResponse(**response.json())
+
+    async def remove_user_template(self, template_id: int, token: str) -> None:
+        url = f"/api/user_template/{template_id}"
+        response = await self.client.delete(url, headers=self._get_headers(token))
+        response.raise_for_status()
+
+    async def get_node_settings(self, token: str) -> Dict[str, Any]:
+        url = "/api/node/settings"
+        response = await self.client.get(url, headers=self._get_headers(token))
+        response.raise_for_status()
+        return response.json()
+
+    async def add_node(self, node: NodeCreate, token: str) -> NodeResponse:
+        url = "/api/node"
+        response = await self.client.post(url, json=node.dict(), headers=self._get_headers(token))
+        response.raise_for_status()
+        return NodeResponse(**response.json())
+
+    async def get_node(self, node_id: int, token: str) -> NodeResponse:
+        url = f"/api/node/{node_id}"
+        response = await self.client.get(url, headers=self._get_headers(token))
+        response.raise_for_status()
+        return NodeResponse(**response.json())
+
+    async def modify_node(self, node_id: int, node: NodeModify, token: str) -> NodeResponse:
+        url = f"/api/node/{node_id}"
+        response = await self.client.put(url, json=node.dict(), headers=self._get_headers(token))
+        response.raise_for_status()
+        return NodeResponse(**response.json())
+
+    async def remove_node(self, node_id: int, token: str) -> None:
+        url = f"/api/node/{node_id}"
+        response = await self.client.delete(url, headers=self._get_headers(token))
+        response.raise_for_status()
+
+    async def reconnect_node(self, node_id: int, token: str) -> None:
+        url = f"/api/node/{node_id}/reconnect"
+        response = await self.client.post(url, headers=self._get_headers(token))
+        response.raise_for_status()
+
+    async def get_nodes(self, token: str) -> List[NodeResponse]:
+        url = "/api/nodes"
+        response = await self.client.get(url, headers=self._get_headers(token))
+        response.raise_for_status()
+        return [NodeResponse(**node) for node in response.json()]
+
+    async def get_usage(self, token: str, start: Optional[str] = None, end: Optional[str] = None) -> NodesUsageResponse:
+        url = "/api/nodes/usage"
+        params = {"start": start, "end": end}
+        response = await self.client.get(url, headers=self._get_headers(token), params=params)
+        response.raise_for_status()
+        return NodesUsageResponse(**response.json())
+
+    async def close(self):
+        await self.client.aclose()

marzban/models.py

@@ -0,0 +1,197 @@
+from pydantic import BaseModel
+from typing import Optional, List, Dict, Any
+
+class Token(BaseModel):
+    access_token: str
+    token_type: str = "bearer"
+
+class Admin(BaseModel):
+    username: str
+    is_sudo: bool
+    telegram_id: Optional[int]
+    discord_webhook: Optional[str]
+
+class AdminCreate(Admin):
+    password: str
+
+class AdminModify(BaseModel):
+    is_sudo: bool
+    password: Optional[str]
+    telegram_id: Optional[int]
+    discord_webhook: Optional[str]
+
+class HTTPValidationError(BaseModel):
+    detail: Optional[List[Dict[str, Any]]]
+
+class SystemStats(BaseModel):
+    version: str
+    mem_total: int
+    mem_used: int
+    cpu_cores: int
+    cpu_usage: float
+    total_user: int
+    users_active: int
+    incoming_bandwidth: int
+    outgoing_bandwidth: int
+    incoming_bandwidth_speed: int
+    outgoing_bandwidth_speed: int
+
+class ProxySettings(BaseModel):
+    pass
+
+class UserCreate(BaseModel):
+    username: str
+    proxies: Optional[Dict[str, ProxySettings]] = {}
+    expire: Optional[int] = None
+    data_limit: Optional[int] = 0
+    data_limit_reset_strategy: Optional[str] = "no_reset"
+    inbounds: Optional[Dict[str, List[str]]] = {}
+    note: Optional[str] = None
+    sub_updated_at: Optional[str] = None
+    sub_last_user_agent: Optional[str] = None
+    online_at: Optional[str] = None
+    on_hold_expire_duration: Optional[int] = 0
+    on_hold_timeout: Optional[str] = None
+    status: Optional[str] = "active"
+
+class UserResponse(BaseModel):
+    username: str
+    proxies: Dict[str, ProxySettings]
+    expire: Optional[int]
+    data_limit: int
+    data_limit_reset_strategy: str
+    inbounds: Dict[str, List[str]]
+    note: Optional[str]
+    sub_updated_at: Optional[str]
+    sub_last_user_agent: Optional[str]
+    online_at: Optional[str]
+    on_hold_expire_duration: Optional[int]
+    on_hold_timeout: Optional[str]
+    status: str
+    used_traffic: int
+    lifetime_used_traffic: int
+    created_at: str
+    links: List[str]
+    subscription_url: str
+    excluded_inbounds: Dict[str, List[str]]
+
+class NodeCreate(BaseModel):
+    name: str
+    address: str
+    port: int = 62050
+    api_port: int = 62051
+    usage_coefficient: float = 1.0
+    add_as_new_host: bool = True
+
+class NodeModify(BaseModel):
+    name: Optional[str]
+    address: Optional[str]
+    port: Optional[int]
+    api_port: Optional[int]
+    usage_coefficient: Optional[float]
+    status: Optional[str]
+
+class NodeResponse(BaseModel):
+    name: str
+    address: str
+    port: int
+    api_port: int
+    usage_coefficient: float
+    id: int
+    xray_version: Optional[str]
+    status: str
+    message: Optional[str]
+
+class NodeUsageResponse(BaseModel):
+    node_id: int
+    node_name: str
+    uplink: int
+    downlink: int
+
+class NodesUsageResponse(BaseModel):
+    usages: List[NodeUsageResponse]
+
+class ProxyHost(BaseModel):
+    remark: str
+    address: str
+    port: Optional[int]
+    sni: Optional[str]
+    host: Optional[str]
+    path: Optional[str]
+    security: str = "inbound_default"
+    alpn: str = ""
+    fingerprint: str = ""
+    allowinsecure: bool
+    is_disabled: bool
+
+class ProxyInbound(BaseModel):
+    tag: str
+    protocol: str
+    network: str
+    tls: str
+    port: Any
+
+class CoreStats(BaseModel):
+    version: str
+    started: bool
+    logs_websocket: str
+
+class UserModify(BaseModel):
+    proxies: Optional[Dict[str, ProxySettings]] = {}
+    expire: Optional[int]
+    data_limit: Optional[int] = 0
+    data_limit_reset_strategy: Optional[str] = "no_reset"
+    inbounds: Optional[Dict[str, List[str]]] = {}
+    note: Optional[str] = None
+    sub_updated_at: Optional[str] = None
+    sub_last_user_agent: Optional[str] = None
+    online_at: Optional[str] = None
+    on_hold_expire_duration: Optional[int] = 0
+    on_hold_timeout: Optional[str] = None
+    status: Optional[str] = "active"
+
+class UserTemplateCreate(BaseModel):
+    name: Optional[str]
+    data_limit: int = 0
+    expire_duration: int = 0
+    username_prefix: Optional[str]
+    username_suffix: Optional[str]
+    inbounds: Optional[Dict[str, List[str]]] = {}
+
+class UserTemplateResponse(BaseModel):
+    id: int
+    name: Optional[str]
+    data_limit: int
+    expire_duration: int
+    username_prefix: Optional[str]
+    username_suffix: Optional[str]
+    inbounds: Dict[str, List[str]]
+
+class UserTemplateModify(BaseModel):
+    name: Optional[str]
+    data_limit: Optional[int]
+    expire_duration: Optional[int]
+    username_prefix: Optional[str]
+    username_suffix: Optional[str]
+    inbounds: Optional[Dict[str, List[str]]]
+
+class UserUsageResponse(BaseModel):
+    node_id: int
+    node_name: str
+    used_traffic: int
+
+class UserUsagesResponse(BaseModel):
+    username: str
+    usages: List[UserUsageResponse]
+
+class UsersResponse(BaseModel):
+    users: List[UserResponse]
+    total: int
+
+class UserStatus(BaseModel):
+    enum = ["active", "disabled", "limited", "expired", "on_hold"]
+
+class ValidationError(BaseModel):
+    loc: List[Any]
+    msg: str
+    type: str

marzban-0.1.2.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Artem
+
+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.

marzban-0.1.2.dist-info/METADATA

@@ -0,0 +1,30 @@
+Metadata-Version: 2.1
+Name: marzban
+Version: 0.1.2
+Summary: Асинхронная библиотека Python для взаимодействия с MarzbanAPI
+Home-page: https://github.com/sm1ky/marzban_api
+Author: Artem
+Author-email: contant@sm1ky.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx >=0.23.0
+Requires-Dist: pydantic >=1.10.0
+
+# MarzbanAPI Client
+
+Это асинхронная библиотека Python для взаимодействия с MarzbanAPI, предоставляющая методы для управления администраторами, пользователями, узлами и системной статистикой.
+
+## Установка
+
+```bash
+pip install marzban
+```
+
+Project in Pypi - https://pypi.org/project/marzban/
+
+If you notice an error, please create a PR and attach logs
+You can contact me by mail contant@sm1ky.com or in Telegram @sm1ky

marzban-0.1.2.dist-info/RECORD

@@ -0,0 +1,8 @@
+marzban/__init__.py,sha256=exQkmVPbMtVfWsL-pqPiwsAHdAXM-XONyVdVSE6DrFg,81
+marzban/clients.py,sha256=kcA60qyG7d1l3lXl5K3MI590DLfLcCi8z42DndwnyDU,12457
+marzban/models.py,sha256=7616sr43dn6tODzaT_NBN6WNPap8WXg70TFsgaJNEHs,4952
+marzban-0.1.2.dist-info/LICENSE,sha256=e7OchdHfXoz2OZRHj8iltLIKYwdri9J4_9PMEnov418,1061
+marzban-0.1.2.dist-info/METADATA,sha256=PkXIOqqKqUCLSL89GMsKdjT6IRxKjQi0aCE7li3WgrY,1111
+marzban-0.1.2.dist-info/WHEEL,sha256=mguMlWGMX-VHnMpKOjjQidIo1ssRlCFu4a4mBpz1s2M,91
+marzban-0.1.2.dist-info/top_level.txt,sha256=KUmBWzTarBlzw2GZOuk-d-jM2GU4zPWo1iwvW_mXS-c,8
+marzban-0.1.2.dist-info/RECORD,,

marzban-0.1.2.dist-info/WHEEL

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

marzban-0.1.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+marzban