BROKENXAPI 2.0.4__tar.gz

brokenxapi-2.0.4/BROKENXAPI.egg-info/PKG-INFO

@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: BROKENXAPI
+Version: 2.0.4
+Summary: Official async Python SDK and CLI for BrokenX YouTube API
+Author-email: Mr Broken <brokenxnetwork@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Mr Broken
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/mrxbroken011/BROKENXAPI
+Project-URL: Repository, https://github.com/mrxbroken011/BROKENXAPI
+Project-URL: Documentation, https://brokenxapi-docs.vercel.app
+Project-URL: Issues, https://github.com/mrxbroken011/BROKENXAPI/issues
+Keywords: brokenx,youtube,api,async,sdk,cli,aiohttp,telegram
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Multimedia :: Video
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: AsyncIO
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.8.0
+Dynamic: license-file
+
+# BROKENXAPI
+
+**BROKENXAPI** is a high-performance asynchronous **Python SDK and CLI** that enables developers to search and download YouTube audio or video through a remote backend API.
+
+It is built for **automation tools**, **Telegram bots**, and **production systems** where reliability, speed, and a clean developer experience are critical.
+
+The SDK abstracts authentication and networking, while the CLI provides a fast and simple way to interact with the API directly from the terminal.
+
+---
+
+<p align="center">
+  <img src="./docs/brokenx.gif" width="600" />
+</p>
+
+---
+
+## Installation
+
+Install via pip:
+
+```bash
+pip install BROKENXAPI
+````
+
+---
+
+## Authentication
+
+BROKENXAPI requires an API key for all requests.
+
+### Environment Variable (Recommended)
+
+**Linux / macOS**
+
+```bash
+export YTKEY="BROKENXAPI-XXXX"
+```
+
+**Windows**
+
+```bat
+set YTKEY=BROKENXAPI-XXXX
+```
+
+---
+
+## Python SDK Usage
+
+```python
+import asyncio
+from brokenxapi import BrokenXAPI
+
+async def main():
+    async with BrokenXAPI(api_key="BROKENXAPI-XXXX") as api:
+        # Search YouTube
+        search = await api.search("moosetape", video=False)
+        video_id = search["video_id"]
+
+        # Download audio
+        audio = await api.download(video_id, "audio")
+        print(audio["telegram_url"])
+
+asyncio.run(main())
+```
+
+---
+
+## Download Video (SDK)
+
+```python
+async with BrokenXAPI(api_key="BROKENXAPI-XXXX") as api:
+    video = await api.download("VIDEO_ID", "video")
+    print(video["telegram_url"])
+```
+
+---
+
+## CLI Usage
+
+Authenticate once:
+
+```bash
+brokenx auth BROKENXAPI-XXXX
+```
+
+Check installed version:
+
+```bash
+brokenx -v
+```
+
+Search YouTube:
+
+```bash
+brokenx search "moosetape"
+```
+
+Download audio:
+
+```bash
+brokenx download VIDEO_ID
+```
+
+Download video:
+
+```bash
+brokenx download VIDEO_ID -v
+```
+
+---
+
+## Notes
+
+* Python **3.8+** is required
+* An API key is mandatory for all requests
+* All responses are returned as JSON-compatible dictionaries
+* Download responses include a **Telegram-ready file URL**
+
+---
+
+## License
+
+© 2025 **MR Broken**
+All rights reserved.
+
+---

brokenxapi-2.0.4/BROKENXAPI.egg-info/SOURCES.txt

@@ -0,0 +1,19 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+setup.py
+BROKENXAPI.egg-info/PKG-INFO
+BROKENXAPI.egg-info/SOURCES.txt
+BROKENXAPI.egg-info/dependency_links.txt
+BROKENXAPI.egg-info/entry_points.txt
+BROKENXAPI.egg-info/not-zip-safe
+BROKENXAPI.egg-info/requires.txt
+BROKENXAPI.egg-info/top_level.txt
+brokenxapi/__init__.py
+brokenxapi/__version__.py
+brokenxapi/auth.py
+brokenxapi/cli.py
+brokenxapi/client.pyc
+brokenxapi/exceptions.py
+brokenxapi/models.py

brokenxapi-2.0.4/BROKENXAPI.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

brokenxapi-2.0.4/BROKENXAPI.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+brokenx = brokenxapi.cli:main

brokenxapi-2.0.4/BROKENXAPI.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

brokenxapi-2.0.4/BROKENXAPI.egg-info/requires.txt

@@ -0,0 +1 @@
+aiohttp>=3.8.0

brokenxapi-2.0.4/BROKENXAPI.egg-info/top_level.txt

@@ -0,0 +1 @@
+brokenxapi

brokenxapi-2.0.4/LICENSE

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

brokenxapi-2.0.4/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include brokenxapi *.pyc

brokenxapi-2.0.4/PKG-INFO

@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: BROKENXAPI
+Version: 2.0.4
+Summary: Official async Python SDK and CLI for BrokenX YouTube API
+Author-email: Mr Broken <brokenxnetwork@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Mr Broken
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/mrxbroken011/BROKENXAPI
+Project-URL: Repository, https://github.com/mrxbroken011/BROKENXAPI
+Project-URL: Documentation, https://brokenxapi-docs.vercel.app
+Project-URL: Issues, https://github.com/mrxbroken011/BROKENXAPI/issues
+Keywords: brokenx,youtube,api,async,sdk,cli,aiohttp,telegram
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Multimedia :: Video
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: AsyncIO
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.8.0
+Dynamic: license-file
+
+# BROKENXAPI
+
+**BROKENXAPI** is a high-performance asynchronous **Python SDK and CLI** that enables developers to search and download YouTube audio or video through a remote backend API.
+
+It is built for **automation tools**, **Telegram bots**, and **production systems** where reliability, speed, and a clean developer experience are critical.
+
+The SDK abstracts authentication and networking, while the CLI provides a fast and simple way to interact with the API directly from the terminal.
+
+---
+
+<p align="center">
+  <img src="./docs/brokenx.gif" width="600" />
+</p>
+
+---
+
+## Installation
+
+Install via pip:
+
+```bash
+pip install BROKENXAPI
+````
+
+---
+
+## Authentication
+
+BROKENXAPI requires an API key for all requests.
+
+### Environment Variable (Recommended)
+
+**Linux / macOS**
+
+```bash
+export YTKEY="BROKENXAPI-XXXX"
+```
+
+**Windows**
+
+```bat
+set YTKEY=BROKENXAPI-XXXX
+```
+
+---
+
+## Python SDK Usage
+
+```python
+import asyncio
+from brokenxapi import BrokenXAPI
+
+async def main():
+    async with BrokenXAPI(api_key="BROKENXAPI-XXXX") as api:
+        # Search YouTube
+        search = await api.search("moosetape", video=False)
+        video_id = search["video_id"]
+
+        # Download audio
+        audio = await api.download(video_id, "audio")
+        print(audio["telegram_url"])
+
+asyncio.run(main())
+```
+
+---
+
+## Download Video (SDK)
+
+```python
+async with BrokenXAPI(api_key="BROKENXAPI-XXXX") as api:
+    video = await api.download("VIDEO_ID", "video")
+    print(video["telegram_url"])
+```
+
+---
+
+## CLI Usage
+
+Authenticate once:
+
+```bash
+brokenx auth BROKENXAPI-XXXX
+```
+
+Check installed version:
+
+```bash
+brokenx -v
+```
+
+Search YouTube:
+
+```bash
+brokenx search "moosetape"
+```
+
+Download audio:
+
+```bash
+brokenx download VIDEO_ID
+```
+
+Download video:
+
+```bash
+brokenx download VIDEO_ID -v
+```
+
+---
+
+## Notes
+
+* Python **3.8+** is required
+* An API key is mandatory for all requests
+* All responses are returned as JSON-compatible dictionaries
+* Download responses include a **Telegram-ready file URL**
+
+---
+
+## License
+
+© 2025 **MR Broken**
+All rights reserved.
+
+---

brokenxapi-2.0.4/README.md

@@ -0,0 +1,126 @@
+# BROKENXAPI
+
+**BROKENXAPI** is a high-performance asynchronous **Python SDK and CLI** that enables developers to search and download YouTube audio or video through a remote backend API.
+
+It is built for **automation tools**, **Telegram bots**, and **production systems** where reliability, speed, and a clean developer experience are critical.
+
+The SDK abstracts authentication and networking, while the CLI provides a fast and simple way to interact with the API directly from the terminal.
+
+---
+
+<p align="center">
+  <img src="./docs/brokenx.gif" width="600" />
+</p>
+
+---
+
+## Installation
+
+Install via pip:
+
+```bash
+pip install BROKENXAPI
+````
+
+---
+
+## Authentication
+
+BROKENXAPI requires an API key for all requests.
+
+### Environment Variable (Recommended)
+
+**Linux / macOS**
+
+```bash
+export YTKEY="BROKENXAPI-XXXX"
+```
+
+**Windows**
+
+```bat
+set YTKEY=BROKENXAPI-XXXX
+```
+
+---
+
+## Python SDK Usage
+
+```python
+import asyncio
+from brokenxapi import BrokenXAPI
+
+async def main():
+    async with BrokenXAPI(api_key="BROKENXAPI-XXXX") as api:
+        # Search YouTube
+        search = await api.search("moosetape", video=False)
+        video_id = search["video_id"]
+
+        # Download audio
+        audio = await api.download(video_id, "audio")
+        print(audio["telegram_url"])
+
+asyncio.run(main())
+```
+
+---
+
+## Download Video (SDK)
+
+```python
+async with BrokenXAPI(api_key="BROKENXAPI-XXXX") as api:
+    video = await api.download("VIDEO_ID", "video")
+    print(video["telegram_url"])
+```
+
+---
+
+## CLI Usage
+
+Authenticate once:
+
+```bash
+brokenx auth BROKENXAPI-XXXX
+```
+
+Check installed version:
+
+```bash
+brokenx -v
+```
+
+Search YouTube:
+
+```bash
+brokenx search "moosetape"
+```
+
+Download audio:
+
+```bash
+brokenx download VIDEO_ID
+```
+
+Download video:
+
+```bash
+brokenx download VIDEO_ID -v
+```
+
+---
+
+## Notes
+
+* Python **3.8+** is required
+* An API key is mandatory for all requests
+* All responses are returned as JSON-compatible dictionaries
+* Download responses include a **Telegram-ready file URL**
+
+---
+
+## License
+
+© 2025 **MR Broken**
+All rights reserved.
+
+---

brokenxapi-2.0.4/brokenxapi/__init__.py

@@ -0,0 +1,16 @@
+from .client import BrokenXAPI
+import logging
+
+
+__all__ = ["BrokenXAPI"]
+
+
+
+logger = logging.getLogger("BrokenXAPI")
+
+logger.info("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")
+logger.info("🚀 BROKENXAPI INITIALIZED")
+logger.info("⚡ Powered by Broken X Network")
+logger.info("🔐 Secure • Async • Fast")
+logger.info("Thanks ❤‍🩹 For Using BrokenxAPI") 
+logger.info("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")

brokenxapi-2.0.4/brokenxapi/__version__.py

@@ -0,0 +1,2 @@
+__version__ = "2.0.4"
+

brokenxapi-2.0.4/brokenxapi/auth.py

@@ -0,0 +1,11 @@
+from pathlib import Path
+
+AUTH_FILE = Path.home() / ".brokenxapi"
+
+def save_key(key: str):
+    AUTH_FILE.write_text(key.strip())
+
+def get_key() -> str | None:
+    if AUTH_FILE.exists():
+        return AUTH_FILE.read_text().strip()
+    return None

brokenxapi-2.0.4/brokenxapi/cli.py

@@ -0,0 +1,51 @@
+import argparse
+import asyncio
+from .client import BrokenXAPI
+from .auth import get_key, save_key
+from .__version__ import __version__
+
+def main():
+    parser = argparse.ArgumentParser("brokenx")
+    parser.add_argument("-v", "--version", action="store_true")
+
+    sub = parser.add_subparsers(dest="cmd")
+
+    auth = sub.add_parser("auth")
+    auth.add_argument("key")
+
+    search = sub.add_parser("search")
+    search.add_argument("query")
+
+    dl = sub.add_parser("download")
+    dl.add_argument("video_id")
+    dl.add_argument("-v", "--video", action="store_true")
+
+    args = parser.parse_args()
+
+    if args.version:
+        print(__version__)
+        return
+
+    if args.cmd == "auth":
+        save_key(args.key)
+        print("✅ API key saved")
+        return
+
+    api_key = get_key()
+    if not api_key:
+        print("❌ Please run: brokenx auth <API_KEY>")
+        return
+
+    asyncio.run(run(args, api_key))
+
+
+async def run(args, api_key):
+    async with BrokenXAPI(api_key) as api:
+        if args.cmd == "search":
+            res = await api.search(args.query)
+            print(res)
+
+        elif args.cmd == "download":
+            media = "video" if args.video else "audio"
+            res = await api.download(args.video_id, media)
+            print(res["telegram_url"])

brokenxapi-2.0.4/brokenxapi/exceptions.py

@@ -0,0 +1,11 @@
+class BrokenXAPIError(Exception):
+    pass
+
+class AuthenticationError(BrokenXAPIError):
+    pass
+
+class RateLimitError(BrokenXAPIError):
+    pass
+
+class ServerError(BrokenXAPIError):
+    pass

brokenxapi-2.0.4/brokenxapi/models.py

@@ -0,0 +1,19 @@
+from typing import TypedDict
+
+class DownloadResponse(TypedDict, total=False):
+    success: bool
+    status: str
+    video_id: str
+    type: str
+    telegram_url: str
+    thumbnail: str
+    source: str
+
+class SearchResponse(TypedDict, total=False):
+    success: bool
+    status: str
+    title: str
+    video_id: str
+    duration: str
+    thumbnail: str
+    stream_url: str

brokenxapi-2.0.4/pyproject.toml

@@ -0,0 +1,70 @@
+[project]
+name = "BROKENXAPI"
+dynamic = ["version"]
+description = "Official async Python SDK and CLI for BrokenX YouTube API"
+readme = "README.md"
+license = { file = "LICENSE" }
+
+authors = [
+    { name = "Mr Broken", email = "brokenxnetwork@gmail.com" }
+]
+
+keywords = [
+    "brokenx",
+    "youtube",
+    "api",
+    "async",
+    "sdk",
+    "cli",
+    "aiohttp",
+    "telegram"
+]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Multimedia :: Video",
+
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+
+    "Framework :: AsyncIO"
+]
+
+requires-python = ">=3.8"
+
+dependencies = [
+    "aiohttp>=3.8.0"
+]
+
+[project.urls]
+Homepage = "https://github.com/mrxbroken011/BROKENXAPI"
+Repository = "https://github.com/mrxbroken011/BROKENXAPI"
+Documentation = "https://brokenxapi-docs.vercel.app"
+Issues = "https://github.com/mrxbroken011/BROKENXAPI/issues"
+
+# ---------------- CLI ENTRY ----------------
+[project.scripts]
+brokenx = "brokenxapi.cli:main"
+
+# ---------------- SETUPTOOLS ----------------
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ["brokenxapi*"]
+
+# ---------------- BUILD SYSTEM ----------------
+[build-system]
+requires = ["setuptools>=69.0", "wheel>=0.43.0"]
+build-backend = "setuptools.build_meta"

brokenxapi-2.0.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

brokenxapi-2.0.4/setup.py

@@ -0,0 +1,15 @@
+from setuptools import setup
+import os
+
+about = {}
+
+here = os.path.abspath(os.path.dirname(__file__))
+version_file = os.path.join(here, "brokenxapi", "__version__.py")
+
+with open(version_file, encoding="utf-8") as f:
+    exec(f.read(), about)
+
+setup(
+    version=about["__version__"],
+    zip_safe=False,
+)