OpenMLBB 4.0.3__tar.gz

openmlbb-4.0.3/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024-2026, ridwaanhall / RoneAI
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

openmlbb-4.0.3/OpenMLBB/README.md

@@ -0,0 +1,35 @@
+# OpenMLBB Python SDK
+
+OpenMLBB is the official Python SDK for `https://mlbb.rone.dev/api`.
+
+## Install
+
+```bash
+pip install OpenMLBB
+```
+
+## Quick Start
+
+```python
+from OpenMLBB import OpenMLBB
+
+client = OpenMLBB()
+
+heroes = client.mlbb.heroes(size=5, index=1, order="desc", lang="en")
+academy_roles = client.academy.roles(lang="en")
+win_rate = client.addon.win_rate_calculator(match_now=100, wr_now=50, wr_future=60)
+
+print(heroes)
+print(academy_roles)
+print(win_rate)
+```
+
+Every SDK method returns API JSON as a Python dictionary.
+
+## User-Agent
+
+The default `User-Agent` is:
+
+`RoneAI-OpenMLBB-Python-SDK`
+
+You can override it by passing `user_agent=` to `OpenMLBB(...)`.

openmlbb-4.0.3/OpenMLBB/src/OpenMLBB/__init__.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from OpenMLBB._version import __version__
+from OpenMLBB.client import (
+    AddonClient,
+    AcademyClient,
+    MlbbClient,
+    OpenMLBB,
+    OpenMLBBError,
+    UserClient,
+)
+
+__all__ = [
+    "__version__",
+    "OpenMLBB",
+    "OpenMLBBError",
+    "AcademyClient",
+    "MlbbClient",
+    "UserClient",
+    "AddonClient",
+]

openmlbb-4.0.3/OpenMLBB/src/OpenMLBB/_version.py

@@ -0,0 +1,3 @@
+"""Package version for OpenMLBB."""
+
+__version__ = "4.0.3"

openmlbb-4.0.3/OpenMLBB/src/OpenMLBB/client.py

@@ -0,0 +1,263 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+
+import requests
+
+
+DEFAULT_BASE_URL = "https://mlbb.rone.dev/api"
+DEFAULT_TIMEOUT = 30
+DEFAULT_USER_AGENT = "RoneAI-OpenMLBB-Python-SDK"
+
+
+class OpenMLBBError(Exception):
+    """Raised when an OpenMLBB request fails."""
+
+    def __init__(self, message: str, status_code: int | None = None, payload: Any = None) -> None:
+        super().__init__(message)
+        self.status_code = status_code
+        self.payload = payload
+
+
+@dataclass(slots=True)
+class _Transport:
+    base_url: str
+    timeout: int
+    user_agent: str
+    session: requests.Session
+
+    def request(
+        self,
+        method: str,
+        path: str,
+        *,
+        params: dict[str, Any] | None = None,
+        json_body: dict[str, Any] | None = None,
+        jwt: str | None = None,
+    ) -> dict[str, Any]:
+        url = f"{self.base_url.rstrip('/')}/{path.lstrip('/')}"
+        headers: dict[str, str] = {
+            "User-Agent": self.user_agent,
+            "Accept": "application/json",
+        }
+        if jwt:
+            headers["Authorization"] = f"Bearer {jwt}"
+
+        try:
+            response = self.session.request(
+                method=method.upper(),
+                url=url,
+                params=params,
+                json=json_body,
+                headers=headers,
+                timeout=self.timeout,
+            )
+        except requests.RequestException as exc:
+            raise OpenMLBBError(f"Request failed: {exc}") from exc
+
+        try:
+            payload: Any = response.json()
+        except ValueError:
+            payload = {"raw": response.text}
+
+        if not response.ok:
+            raise OpenMLBBError(
+                message=f"OpenMLBB API request failed with status {response.status_code}",
+                status_code=response.status_code,
+                payload=payload,
+            )
+
+        if isinstance(payload, dict):
+            return payload
+
+        return {"data": payload}
+
+
+class AcademyClient:
+    def __init__(self, transport: _Transport) -> None:
+        self._transport = transport
+
+    def meta_version(self, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/academy/meta/version", params=params)
+
+    def heroes_catalog(self, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/academy/heroes/catalog", params=params)
+
+    def roles(self, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/academy/roles", params=params)
+
+    def equipment(self, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/academy/equipment", params=params)
+
+    def equipment_expanded(self, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/academy/equipment/expanded", params=params)
+
+    def spells(self, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/academy/spells", params=params)
+
+    def emblems(self, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/academy/emblems", params=params)
+
+    def ranks(self, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/academy/ranks", params=params)
+
+    def rank_by_id(self, rank_id: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/academy/ranks/{rank_id}", params=params)
+
+    def recommended(self, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/academy/recommended", params=params)
+
+    def recommended_by_id(self, recommended_id: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/academy/recommended/{recommended_id}", params=params)
+
+    def heroes(self, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/academy/heroes", params=params)
+
+    def hero_stats(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/academy/heroes/{hero_identifier}/stats", params=params)
+
+    def hero_lane(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/academy/heroes/{hero_identifier}/lane", params=params)
+
+    def hero_win_rate_timeline(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/academy/heroes/{hero_identifier}/win-rate/timeline", params=params)
+
+    def hero_builds(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/academy/heroes/{hero_identifier}/builds", params=params)
+
+    def hero_counters(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/academy/heroes/{hero_identifier}/counters", params=params)
+
+    def hero_teammates(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/academy/heroes/{hero_identifier}/teammates", params=params)
+
+    def hero_trends(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/academy/heroes/{hero_identifier}/trends", params=params)
+
+    def hero_recommended(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/academy/heroes/{hero_identifier}/recommended", params=params)
+
+    def heroes_ratings(self, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/academy/heroes/ratings", params=params)
+
+
+class MlbbClient:
+    def __init__(self, transport: _Transport) -> None:
+        self._transport = transport
+
+    def heroes(self, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/heroes", params=params)
+
+    def heroes_rank(self, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/heroes/rank", params=params)
+
+    def heroes_positions(self, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/heroes/positions", params=params)
+
+    def hero_detail(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/heroes/{hero_identifier}", params=params)
+
+    def hero_stats(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/heroes/{hero_identifier}/stats", params=params)
+
+    def hero_skill_combos(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/heroes/{hero_identifier}/skill-combos", params=params)
+
+    def hero_trends(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/heroes/{hero_identifier}/trends", params=params)
+
+    def hero_relations(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/heroes/{hero_identifier}/relations", params=params)
+
+    def hero_counters(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/heroes/{hero_identifier}/counters", params=params)
+
+    def hero_compatibility(self, hero_identifier: str | int, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/heroes/{hero_identifier}/compatibility", params=params)
+
+
+class UserClient:
+    def __init__(self, transport: _Transport) -> None:
+        self._transport = transport
+
+    def send_vc(self, role_id: int, zone_id: int) -> dict[str, Any]:
+        body = {"role_id": role_id, "zone_id": zone_id}
+        return self._transport.request("POST", "/user/auth/send-vc", json_body=body)
+
+    def login(self, role_id: int, zone_id: int, vc: str) -> dict[str, Any]:
+        body = {"role_id": role_id, "zone_id": zone_id, "vc": vc}
+        return self._transport.request("POST", "/user/auth/login", json_body=body)
+
+    def logout(self, jwt: str) -> dict[str, Any]:
+        return self._transport.request("POST", "/user/auth/logout", jwt=jwt)
+
+    def info(self, jwt: str, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/user/info", params=params, jwt=jwt)
+
+    def stats(self, jwt: str, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/user/stats", params=params, jwt=jwt)
+
+    def privacy_settings(self, jwt: str, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/user/privacy/settings", params=params, jwt=jwt)
+
+    def update_privacy_settings(self, jwt: str, body: dict[str, Any], **params: Any) -> dict[str, Any]:
+        return self._transport.request("POST", "/user/privacy/settings", params=params, json_body=body, jwt=jwt)
+
+    def season(self, jwt: str, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/user/season", params=params, jwt=jwt)
+
+    def matches(self, jwt: str, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/user/matches", params=params, jwt=jwt)
+
+    def match_detail(self, match_id: str | int, jwt: str, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/user/matches/{match_id}", params=params, jwt=jwt)
+
+    def heroes_frequent(self, jwt: str, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/user/heroes/frequent", params=params, jwt=jwt)
+
+    def matches_by_hero(self, hero_identifier: str | int, jwt: str, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", f"/user/matches/hero/{hero_identifier}", params=params, jwt=jwt)
+
+    def friends(self, jwt: str, **params: Any) -> dict[str, Any]:
+        return self._transport.request("GET", "/user/friends", params=params, jwt=jwt)
+
+
+class AddonClient:
+    def __init__(self, transport: _Transport) -> None:
+        self._transport = transport
+
+    def win_rate_calculator(self, match_now: int, wr_now: float, wr_future: float) -> dict[str, Any]:
+        params = {
+            "match-now": match_now,
+            "wr-now": wr_now,
+            "wr-future": wr_future,
+        }
+        return self._transport.request("GET", "/addon/win-rate-calculator", params=params)
+
+    def ip(self) -> dict[str, Any]:
+        return self._transport.request("GET", "/addon/ip")
+
+
+class OpenMLBB:
+    """Python SDK for https://mlbb.rone.dev/api."""
+
+    def __init__(
+        self,
+        base_url: str = DEFAULT_BASE_URL,
+        timeout: int = DEFAULT_TIMEOUT,
+        user_agent: str = DEFAULT_USER_AGENT,
+        session: requests.Session | None = None,
+    ) -> None:
+        active_session = session or requests.Session()
+        self._transport = _Transport(
+            base_url=base_url,
+            timeout=timeout,
+            user_agent=user_agent,
+            session=active_session,
+        )
+
+        self.academy = AcademyClient(self._transport)
+        self.mlbb = MlbbClient(self._transport)
+        self.user = UserClient(self._transport)
+        self.addon = AddonClient(self._transport)

openmlbb-4.0.3/OpenMLBB/src/OpenMLBB.egg-info/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: OpenMLBB
+Version: 4.0.3
+Summary: Official Python SDK for the MLBB Public Data API
+Author: ridwaanhall
+License: BSD-3-Clause
+Project-URL: Homepage, https://mlbb.rone.dev
+Project-URL: Documentation, https://mlbb.rone.dev/api/docs
+Project-URL: Repository, https://github.com/ridwaanhall/api-mobilelegends
+Project-URL: Issues, https://github.com/ridwaanhall/api-mobilelegends/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi[standard]>=0.135.2
+Requires-Dist: requests<3,>=2.32.0
+Requires-Dist: cryptography==46.0.7
+Dynamic: license-file
+
+# OpenMLBB Python SDK
+
+OpenMLBB is the official Python SDK for `https://mlbb.rone.dev/api`.
+
+## Install
+
+```bash
+pip install OpenMLBB
+```
+
+## Quick Start
+
+```python
+from OpenMLBB import OpenMLBB
+
+client = OpenMLBB()
+
+heroes = client.mlbb.heroes(size=5, index=1, order="desc", lang="en")
+academy_roles = client.academy.roles(lang="en")
+win_rate = client.addon.win_rate_calculator(match_now=100, wr_now=50, wr_future=60)
+
+print(heroes)
+print(academy_roles)
+print(win_rate)
+```
+
+Every SDK method returns API JSON as a Python dictionary.
+
+## User-Agent
+
+The default `User-Agent` is:
+
+`RoneAI-OpenMLBB-Python-SDK`
+
+You can override it by passing `user_agent=` to `OpenMLBB(...)`.

openmlbb-4.0.3/OpenMLBB/src/OpenMLBB.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+LICENSE
+README.md
+pyproject.toml
+OpenMLBB/README.md
+OpenMLBB/src/OpenMLBB/__init__.py
+OpenMLBB/src/OpenMLBB/_version.py
+OpenMLBB/src/OpenMLBB/client.py
+OpenMLBB/src/OpenMLBB.egg-info/PKG-INFO
+OpenMLBB/src/OpenMLBB.egg-info/SOURCES.txt
+OpenMLBB/src/OpenMLBB.egg-info/dependency_links.txt
+OpenMLBB/src/OpenMLBB.egg-info/requires.txt
+OpenMLBB/src/OpenMLBB.egg-info/top_level.txt
+tests/test_client_ip.py
+tests/test_endpoints.py
+tests/test_user_router.py
+tests/test_validation_errors.py
+tests/test_web_interface.py

openmlbb-4.0.3/OpenMLBB/src/OpenMLBB.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

openmlbb-4.0.3/OpenMLBB/src/OpenMLBB.egg-info/requires.txt

@@ -0,0 +1,3 @@
+fastapi[standard]>=0.135.2
+requests<3,>=2.32.0
+cryptography==46.0.7

openmlbb-4.0.3/OpenMLBB/src/OpenMLBB.egg-info/top_level.txt

@@ -0,0 +1 @@
+OpenMLBB

openmlbb-4.0.3/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: OpenMLBB
+Version: 4.0.3
+Summary: Official Python SDK for the MLBB Public Data API
+Author: ridwaanhall
+License: BSD-3-Clause
+Project-URL: Homepage, https://mlbb.rone.dev
+Project-URL: Documentation, https://mlbb.rone.dev/api/docs
+Project-URL: Repository, https://github.com/ridwaanhall/api-mobilelegends
+Project-URL: Issues, https://github.com/ridwaanhall/api-mobilelegends/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi[standard]>=0.135.2
+Requires-Dist: requests<3,>=2.32.0
+Requires-Dist: cryptography==46.0.7
+Dynamic: license-file
+
+# OpenMLBB Python SDK
+
+OpenMLBB is the official Python SDK for `https://mlbb.rone.dev/api`.
+
+## Install
+
+```bash
+pip install OpenMLBB
+```
+
+## Quick Start
+
+```python
+from OpenMLBB import OpenMLBB
+
+client = OpenMLBB()
+
+heroes = client.mlbb.heroes(size=5, index=1, order="desc", lang="en")
+academy_roles = client.academy.roles(lang="en")
+win_rate = client.addon.win_rate_calculator(match_now=100, wr_now=50, wr_future=60)
+
+print(heroes)
+print(academy_roles)
+print(win_rate)
+```
+
+Every SDK method returns API JSON as a Python dictionary.
+
+## User-Agent
+
+The default `User-Agent` is:
+
+`RoneAI-OpenMLBB-Python-SDK`
+
+You can override it by passing `user_agent=` to `OpenMLBB(...)`.

openmlbb-4.0.3/README.md

@@ -0,0 +1,193 @@
+# MLBB Public Data API & Web
+
+[![Web Live](https://img.shields.io/badge/API-Live-brightgreen?logo=fastapi&logoColor=white)](https://mlbb.rone.dev)
+![Release](https://img.shields.io/github/v/release/ridwaanhall/api-mobilelegends?logo=github)
+![License](https://img.shields.io/github/license/ridwaanhall/api-mobilelegends?logo=bsd&logoColor=white)
+![Stars](https://img.shields.io/github/stars/ridwaanhall/api-mobilelegends?logo=github)
+![Forks](https://img.shields.io/github/forks/ridwaanhall/api-mobilelegends?logo=github)
+![Python](https://img.shields.io/badge/Python-3.12+-blue?logo=python&logoColor=white)
+![FastAPI](https://img.shields.io/badge/FastAPI-009688?logo=fastapi&logoColor=white)
+![OpenAPI](https://img.shields.io/badge/OpenAPI-3.1-green?logo=openapiinitiative&logoColor=white)
+
+![Landing Page](images/blog/landing-page-v3.2.2.webp)
+
+This API & Web provides access to hero analytics, in-game performance data, academy resources, player endpoints, and utility tools. It is designed with a consistent RESTful structure, supports flexible hero identifiers (ID or name), and delivers standardized responses for seamless integration into applications, dashboards, analytics systems, and internal tooling.
+
+> [!IMPORTANT]
+> **Built with Dedication:** This project is the result of over [![wakatime](https://wakatime.com/badge/user/018b799e-de53-4f7a-bb65-edc2df9f26d8/project/07151d3c-c9e1-4f53-bb7f-f706f8261ac4.svg)](https://wakatime.com/badge/user/018b799e-de53-4f7a-bb65-edc2df9f26d8/project/07151d3c-c9e1-4f53-bb7f-f706f8261ac4) of meticulous coding, architecting, and performance tuning to ensure the best developer experience.
+
+## Features
+
+- **Public REST API for MLBB data**: user, mlbb, academy, and addon service groups
+- **Web playground for all endpoints**: form-driven execution at `/web/*`
+- **Flexible hero identifier support**: hero ID or hero name (including compact slug-like names)
+- **Readable response views**: switch between Key-Value and Key-As-Header table modes
+- **Language snippets**: curl, python, javascript, go, node, php, java, csharp
+- **Copy helpers**: copy snippet, copy response, copy JWT from signed-in menu
+- **Auth modal flow for user endpoints**: Send VC + Login in one popup
+- **JWT-aware navbar state**: profile photo, username, country, roleId(zoneId), sign out
+- **Tutorial & blog pages**: step-by-step guides with SEO-ready detail pages
+- **OpenAPI-first docs**: Swagger UI, ReDoc, and OpenAPI JSON
+
+## Documentation
+
+| Title | Link | Description |
+| --- | --- | --- |
+| Website Home | [mlbb.rone.dev](https://mlbb.rone.dev) | Main landing page with quick access to Demo Website and API Docs. |
+| Tutorial and Blog | [mlbb.rone.dev/blog](https://mlbb.rone.dev/blog) | Guides, tutorials, and release/changelog posts. |
+| Web Playground | [mlbb.rone.dev/web](https://mlbb.rone.dev/web) | Interactive endpoint workspace for executing API requests from browser forms. |
+| Swagger UI | [mlbb.rone.dev/api/docs](https://mlbb.rone.dev/api/docs) | OpenAPI-powered docs with live request execution and authorization support. |
+| ReDoc | [mlbb.rone.dev/api/redoc](https://mlbb.rone.dev/api/redoc) | Alternative API documentation view optimized for reference reading. |
+| OpenAPI JSON | [mlbb.rone.dev/api/openapi.json](https://mlbb.rone.dev/api/openapi.json) | Raw OpenAPI schema for tooling, SDK generation, and integrations. |
+
+### Web Interface Highlights
+
+- Home page provides two entry points: **Open Demo Website** and **Open API Docs**
+- Demo Website (`/web/*`) is recommended for most usage and exploration
+- Sign In modal supports **Send VC** then **Login with VC** (same role/zone fields, VC expires in 5 minutes)
+- Signed-in menu shows profile details and **Copy JWT** for quick docs authorization
+- Endpoint cards include request forms, snippets, readable/JSON responses, and copy actions
+- Readable response section supports view switching: **Key-Value** or **Key As Header**
+
+## Base URLs
+
+```txt
+https://mlbb.rone.dev/                  # Landing page
+https://mlbb.rone.dev/blog              # Tutorial and blog list
+https://mlbb.rone.dev/blog/{slug}       # Blog detail page
+https://mlbb.rone.dev/web               # Web interface (redirects to /web/user)
+https://mlbb.rone.dev/web/user          # User endpoints playground
+https://mlbb.rone.dev/web/mlbb          # MLBB endpoints playground
+https://mlbb.rone.dev/web/academy       # Academy endpoints playground
+https://mlbb.rone.dev/web/addon         # Addon endpoints playground
+https://mlbb.rone.dev/api               # API index/status
+https://mlbb.rone.dev/api/docs          # Swagger UI
+https://mlbb.rone.dev/api/redoc         # ReDoc
+https://mlbb.rone.dev/api/openapi.json  # OpenAPI schema
+```
+
+## Python SDK (PyPI)
+
+Install:
+
+```bash
+pip install OpenMLBB
+```
+
+Usage:
+
+```python
+from OpenMLBB import OpenMLBB
+
+client = OpenMLBB()
+
+# same endpoint groups as API routers
+academy_data = client.academy.roles(lang="en")
+mlbb_data = client.mlbb.heroes(size=10, index=1, order="desc", lang="en")
+
+print(academy_data)
+print(mlbb_data)
+```
+
+SDK defaults:
+
+- Base endpoint: `https://mlbb.rone.dev/api`
+- Response type: JSON payload mapped to Python dictionary
+- User-Agent: `RoneAI-OpenMLBB-Python-SDK`
+
+### Automated Release Rules (4.x.x)
+
+- Workflow file: `.github/workflows/python-publish.yml`
+- Version tags use format: `4.x.x` (no `v` prefix)
+- Push behavior:
+	- Add `[release]` in commit message to trigger publish flow.
+	- Without `[release]`, workflow skips release/tag/publish.
+- Branch behavior when `[release]` is used:
+	- `main` branch creates stable release (`4.0.1`, `4.0.2`, ...)
+	- non-`main` branch creates prerelease (`4.0.1rc1`, `4.0.1rc2`, ...)
+- Manual behavior:
+	- Run `workflow_dispatch` and set `publish=true` for forced release.
+
+## API Coverage
+
+Full endpoint lists, operation summaries, and request/response schemas are always available in:
+
+- `https://mlbb.rone.dev/api/docs` (Swagger UI)
+- `https://mlbb.rone.dev/web` (interactive web endpoint explorer)
+
+This ensures API coverage documentation stays up to date with every release without maintaining manual endpoint lists in README.
+
+## Changelog
+
+See [Releases](https://github.com/ridwaanhall/api-mobilelegends/releases) for migration notes and updates.
+
+## License & Attribution
+
+This project is licensed under the **BSD 3-Clause License**.
+Attribution must be preserved to **Moonton (the creator of Mobile Legends)** and either
+**ridwaanhall (the maintainer of this API project)** *or*
+**RoneAI (the organization behind this API)** in all downstream usage and derivative projects.
+
+### Notice
+
+All data is sourced from publicly available content and provided for educational, analytical, and community purposes only.
+Visual assets and references are used respectfully and do not imply official partnership.
+
+### Example Attribution (README or app footer)
+
+> Powered by MLBB Public Data API
+> Data © Moonton (Mobile Legends)
+> API maintained by ridwaanhall / RoneAI
+
+<details>
+<summary>Local Development (internal)</summary>
+
+### Setup
+
+```bash
+# skip this if already have
+uv init # create pyproject.toml
+uv add fastapi # add deps
+uv add pytest --dev # add deps for dev
+
+# use this if already have pyproject.toml and uv.lock
+uv sync
+cp .env.example .env
+```
+
+### Run
+
+#### Development
+
+```bash
+fastapi dev
+```
+
+#### Production
+
+```bash
+fastapi run
+```
+
+#### Deploy
+
+```bash
+# deploy via fastapicloud
+fastapi deploy
+```
+
+### Test
+
+```bash
+pytest
+```
+
+### Environment Variables
+
+- `SECRET_KEY`
+- `RONE_DEV_ACCESS_KEY`
+- `RONE_DEV_ACCESS_KEY_V2`
+
+See `.env.example` for full configuration.
+
+</details>