BROKENXAPI 2.0.2__tar.gz → 2.0.3__tar.gz

{brokenxapi-2.0.2 → brokenxapi-2.0.3}/BROKENXAPI.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BROKENXAPI
-Version: 2.0.2
+Version: 2.0.3
 Summary: Official async Python SDK and CLI for BrokenX YouTube API
 Author-email: Mr Broken <brokenxnetwork@gmail.com>
 License: MIT License
@@ -50,110 +50,53 @@ License-File: LICENSE
 Requires-Dist: aiohttp>=3.8.0
 Dynamic: license-file
 
+# BROKENXAPI
 
-# 🚀 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.
 
-**Official async Python SDK & CLI for BrokenX YouTube API**
-Built by **Broken X Network**
+It is built for **automation tools**, **Telegram bots**, and **production systems** where reliability, speed, and a clean developer experience are critical.
 
-BROKENXAPI developers ko YouTube search aur media processing (audio/video) ke liye ek **fast, async aur secure API** provide karta hai —
-jisme **SDK + CLI dono** available hain.
+The SDK abstracts authentication and networking, while the CLI provides a fast and simple way to interact with the API directly from the terminal.
 
 ---
 
-## ✨ Features
-
-* ⚡ Async Python SDK (aiohttp based)
-* 🖥️ Built-in CLI (`brokenx`)
-* 🔑 Secure API-key authentication
-* 🎵 Audio & 🎬 Video support
-* ☁️ Telegram-based media delivery
-* 🚀 Server-side caching & rate limits
-* 🧱 Clean, production-ready packaging
+<p align="center">
+  <img src="./docs/brokenx.gif" width="600" />
+</p>
 
 ---
 
-## 📦 Installation
-
-```bash
-pip install BROKENXAPI
-```
+## Installation
 
-Verify installation:
+Install via pip:
 
 ```bash
-brokenx -v
-```
-
----
-
-## 🔑 Authentication (One-time)
-
-CLI ke through **ek baar API key authenticate** karni hoti hai:
-
-```bash
-brokenx auth BROKENXAPI-XXXX
-```
-
-### 🔐 How it works
-
-* API key securely local machine par store hoti hai
-* Uske baad har command automatically authenticated hoti hai
-* Environment variables ki zarurat nahi
+pip install BROKENXAPI
+````
 
 ---
 
-## 📟 Command Line Interface (CLI)
+## Authentication
 
-BROKENXAPI with powerful CLI :
+BROKENXAPI requires an API key for all requests.
 
-### 🔢 Version
+### Environment Variable (Recommended)
 
-```bash
-brokenx -v
-```
-
----
-
-### 🔍 Search YouTube
+**Linux / macOS**
 
 ```bash
-brokenx search "lofi beats"
+export YTKEY="BROKENXAPI-XXXX"
 ```
 
-Returns:
+**Windows**
 
-* title
-* video_id
-* duration
-* thumbnail
-* temporary stream URL
-
----
-
-### 🎵 Download Audio
-
-```bash
-brokenx download VIDEO_ID
+```bat
+set YTKEY=BROKENXAPI-XXXX
 ```
 
-Default mode **audio** hota hai.
-
 ---
 
-### 🎬 Download Video
-
-```bash
-brokenx download VIDEO_ID -v
-```
-
-`-v` flag use karke video download hota hai.
-
----
-
-## 🐍 Python SDK Usage
-
-### Basic Example
+## Python SDK Usage
 
 ```python
 import asyncio
@@ -161,82 +104,75 @@ from brokenxapi import BrokenXAPI
 
 async def main():
     async with BrokenXAPI(api_key="BROKENXAPI-XXXX") as api:
-        result = await api.search("Arijit Singh")
-        print(result)
+        # 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 Example
+## Download Video (SDK)
 
 ```python
 async with BrokenXAPI(api_key="BROKENXAPI-XXXX") as api:
-    audio = await api.download("VIDEO_ID", "audio")
     video = await api.download("VIDEO_ID", "video")
+    print(video["telegram_url"])
 ```
 
 ---
 
-## 🧠 How Authentication Works
+## CLI Usage
 
-* API key har request ke saath backend par verify hoti hai
-* Rate limits server-side enforce hote hain
-* Invalid / expired key par request reject ho jaati hai
-
----
+Authenticate once:
 
-## 📚 Documentation
-
-📘 **Full Docs:**
-👉 [DOCS](https://brokenxapi-docs.vercel.app) 
-
----
-
-## ⚠️ Important Notes
+```bash
+brokenx auth BROKENXAPI-XXXX
+```
 
-* Media files **Telegram** ke through deliver hote hain
-* Stream URLs **temporary** hote hain
-* Rate limits API key ke type par depend karte hain
-* SDK async hai — `async/await` required
+Check installed version:
 
----
----
+```bash
+brokenx -v
+```
 
-## 🔒 Security & Licensing
+Search YouTube:
 
-* Core client logic intentionally compiled (`.pyc`)
-* No sensitive keys repo me store nahi hoti
-* License: **MIT**
+```bash
+brokenx search "moosetape"
+```
 
----
+Download audio:
 
-## 🤝 Contributing
+```bash
+brokenx download VIDEO_ID
+```
 
-Currently BROKENXAPI core is maintained by **Broken X Network**.
-Issues, feature requests aur suggestions welcome hain:
+Download video:
 
-👉 [DROP ISSUES](https://github.com/mrxbroken011/BROKENXAPI/issues)
+```bash
+brokenx download VIDEO_ID -v
+```
 
 ---
 
-## 🏁 Roadmap (High-level)
+## Notes
 
-* ✅ SDK + CLI
-* 🔜 Advanced CLI flags
-* 🔜 Improved docs & examples
-* 🔜 Multi-profile auth support
-* 🔜 Production backend scaling
+* 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
+## License
 
-MIT License
-© 2025–2026 **MR BROKEN**
+© 2025 **MR Broken**
+All rights reserved.
 
 ---
-
-
-

{brokenxapi-2.0.2 → brokenxapi-2.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BROKENXAPI
-Version: 2.0.2
+Version: 2.0.3
 Summary: Official async Python SDK and CLI for BrokenX YouTube API
 Author-email: Mr Broken <brokenxnetwork@gmail.com>
 License: MIT License
@@ -50,110 +50,53 @@ License-File: LICENSE
 Requires-Dist: aiohttp>=3.8.0
 Dynamic: license-file
 
+# BROKENXAPI
 
-# 🚀 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.
 
-**Official async Python SDK & CLI for BrokenX YouTube API**
-Built by **Broken X Network**
+It is built for **automation tools**, **Telegram bots**, and **production systems** where reliability, speed, and a clean developer experience are critical.
 
-BROKENXAPI developers ko YouTube search aur media processing (audio/video) ke liye ek **fast, async aur secure API** provide karta hai —
-jisme **SDK + CLI dono** available hain.
+The SDK abstracts authentication and networking, while the CLI provides a fast and simple way to interact with the API directly from the terminal.
 
 ---
 
-## ✨ Features
-
-* ⚡ Async Python SDK (aiohttp based)
-* 🖥️ Built-in CLI (`brokenx`)
-* 🔑 Secure API-key authentication
-* 🎵 Audio & 🎬 Video support
-* ☁️ Telegram-based media delivery
-* 🚀 Server-side caching & rate limits
-* 🧱 Clean, production-ready packaging
+<p align="center">
+  <img src="./docs/brokenx.gif" width="600" />
+</p>
 
 ---
 
-## 📦 Installation
-
-```bash
-pip install BROKENXAPI
-```
+## Installation
 
-Verify installation:
+Install via pip:
 
 ```bash
-brokenx -v
-```
-
----
-
-## 🔑 Authentication (One-time)
-
-CLI ke through **ek baar API key authenticate** karni hoti hai:
-
-```bash
-brokenx auth BROKENXAPI-XXXX
-```
-
-### 🔐 How it works
-
-* API key securely local machine par store hoti hai
-* Uske baad har command automatically authenticated hoti hai
-* Environment variables ki zarurat nahi
+pip install BROKENXAPI
+````
 
 ---
 
-## 📟 Command Line Interface (CLI)
+## Authentication
 
-BROKENXAPI with powerful CLI :
+BROKENXAPI requires an API key for all requests.
 
-### 🔢 Version
+### Environment Variable (Recommended)
 
-```bash
-brokenx -v
-```
-
----
-
-### 🔍 Search YouTube
+**Linux / macOS**
 
 ```bash
-brokenx search "lofi beats"
+export YTKEY="BROKENXAPI-XXXX"
 ```
 
-Returns:
+**Windows**
 
-* title
-* video_id
-* duration
-* thumbnail
-* temporary stream URL
-
----
-
-### 🎵 Download Audio
-
-```bash
-brokenx download VIDEO_ID
+```bat
+set YTKEY=BROKENXAPI-XXXX
 ```
 
-Default mode **audio** hota hai.
-
 ---
 
-### 🎬 Download Video
-
-```bash
-brokenx download VIDEO_ID -v
-```
-
-`-v` flag use karke video download hota hai.
-
----
-
-## 🐍 Python SDK Usage
-
-### Basic Example
+## Python SDK Usage
 
 ```python
 import asyncio
@@ -161,82 +104,75 @@ from brokenxapi import BrokenXAPI
 
 async def main():
     async with BrokenXAPI(api_key="BROKENXAPI-XXXX") as api:
-        result = await api.search("Arijit Singh")
-        print(result)
+        # 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 Example
+## Download Video (SDK)
 
 ```python
 async with BrokenXAPI(api_key="BROKENXAPI-XXXX") as api:
-    audio = await api.download("VIDEO_ID", "audio")
     video = await api.download("VIDEO_ID", "video")
+    print(video["telegram_url"])
 ```
 
 ---
 
-## 🧠 How Authentication Works
+## CLI Usage
 
-* API key har request ke saath backend par verify hoti hai
-* Rate limits server-side enforce hote hain
-* Invalid / expired key par request reject ho jaati hai
-
----
+Authenticate once:
 
-## 📚 Documentation
-
-📘 **Full Docs:**
-👉 [DOCS](https://brokenxapi-docs.vercel.app) 
-
----
-
-## ⚠️ Important Notes
+```bash
+brokenx auth BROKENXAPI-XXXX
+```
 
-* Media files **Telegram** ke through deliver hote hain
-* Stream URLs **temporary** hote hain
-* Rate limits API key ke type par depend karte hain
-* SDK async hai — `async/await` required
+Check installed version:
 
----
----
+```bash
+brokenx -v
+```
 
-## 🔒 Security & Licensing
+Search YouTube:
 
-* Core client logic intentionally compiled (`.pyc`)
-* No sensitive keys repo me store nahi hoti
-* License: **MIT**
+```bash
+brokenx search "moosetape"
+```
 
----
+Download audio:
 
-## 🤝 Contributing
+```bash
+brokenx download VIDEO_ID
+```
 
-Currently BROKENXAPI core is maintained by **Broken X Network**.
-Issues, feature requests aur suggestions welcome hain:
+Download video:
 
-👉 [DROP ISSUES](https://github.com/mrxbroken011/BROKENXAPI/issues)
+```bash
+brokenx download VIDEO_ID -v
+```
 
 ---
 
-## 🏁 Roadmap (High-level)
+## Notes
 
-* ✅ SDK + CLI
-* 🔜 Advanced CLI flags
-* 🔜 Improved docs & examples
-* 🔜 Multi-profile auth support
-* 🔜 Production backend scaling
+* 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
+## License
 
-MIT License
-© 2025–2026 **MR BROKEN**
+© 2025 **MR Broken**
+All rights reserved.
 
 ---
-
-
-

brokenxapi-2.0.3/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.3/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.3/brokenxapi/__version__.py

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

brokenxapi-2.0.2/README.md

@@ -1,190 +0,0 @@
-
-# 🚀 BROKENXAPI
-
-**Official async Python SDK & CLI for BrokenX YouTube API**
-Built by **Broken X Network**
-
-BROKENXAPI developers ko YouTube search aur media processing (audio/video) ke liye ek **fast, async aur secure API** provide karta hai —
-jisme **SDK + CLI dono** available hain.
-
----
-
-## ✨ Features
-
-* ⚡ Async Python SDK (aiohttp based)
-* 🖥️ Built-in CLI (`brokenx`)
-* 🔑 Secure API-key authentication
-* 🎵 Audio & 🎬 Video support
-* ☁️ Telegram-based media delivery
-* 🚀 Server-side caching & rate limits
-* 🧱 Clean, production-ready packaging
-
----
-
-## 📦 Installation
-
-```bash
-pip install BROKENXAPI
-```
-
-Verify installation:
-
-```bash
-brokenx -v
-```
-
----
-
-## 🔑 Authentication (One-time)
-
-CLI ke through **ek baar API key authenticate** karni hoti hai:
-
-```bash
-brokenx auth BROKENXAPI-XXXX
-```
-
-### 🔐 How it works
-
-* API key securely local machine par store hoti hai
-* Uske baad har command automatically authenticated hoti hai
-* Environment variables ki zarurat nahi
-
----
-
-## 📟 Command Line Interface (CLI)
-
-BROKENXAPI with powerful CLI :
-
-### 🔢 Version
-
-```bash
-brokenx -v
-```
-
----
-
-### 🔍 Search YouTube
-
-```bash
-brokenx search "lofi beats"
-```
-
-Returns:
-
-* title
-* video_id
-* duration
-* thumbnail
-* temporary stream URL
-
----
-
-### 🎵 Download Audio
-
-```bash
-brokenx download VIDEO_ID
-```
-
-Default mode **audio** hota hai.
-
----
-
-### 🎬 Download Video
-
-```bash
-brokenx download VIDEO_ID -v
-```
-
-`-v` flag use karke video download hota hai.
-
----
-
-## 🐍 Python SDK Usage
-
-### Basic Example
-
-```python
-import asyncio
-from brokenxapi import BrokenXAPI
-
-async def main():
-    async with BrokenXAPI(api_key="BROKENXAPI-XXXX") as api:
-        result = await api.search("Arijit Singh")
-        print(result)
-
-asyncio.run(main())
-```
-
----
-
-### Download Example
-
-```python
-async with BrokenXAPI(api_key="BROKENXAPI-XXXX") as api:
-    audio = await api.download("VIDEO_ID", "audio")
-    video = await api.download("VIDEO_ID", "video")
-```
-
----
-
-## 🧠 How Authentication Works
-
-* API key har request ke saath backend par verify hoti hai
-* Rate limits server-side enforce hote hain
-* Invalid / expired key par request reject ho jaati hai
-
----
-
-## 📚 Documentation
-
-📘 **Full Docs:**
-👉 [DOCS](https://brokenxapi-docs.vercel.app) 
-
----
-
-## ⚠️ Important Notes
-
-* Media files **Telegram** ke through deliver hote hain
-* Stream URLs **temporary** hote hain
-* Rate limits API key ke type par depend karte hain
-* SDK async hai — `async/await` required
-
----
----
-
-## 🔒 Security & Licensing
-
-* Core client logic intentionally compiled (`.pyc`)
-* No sensitive keys repo me store nahi hoti
-* License: **MIT**
-
----
-
-## 🤝 Contributing
-
-Currently BROKENXAPI core is maintained by **Broken X Network**.
-Issues, feature requests aur suggestions welcome hain:
-
-👉 [DROP ISSUES](https://github.com/mrxbroken011/BROKENXAPI/issues)
-
----
-
-## 🏁 Roadmap (High-level)
-
-* ✅ SDK + CLI
-* 🔜 Advanced CLI flags
-* 🔜 Improved docs & examples
-* 🔜 Multi-profile auth support
-* 🔜 Production backend scaling
-
----
-
-## © License
-
-MIT License
-© 2025–2026 **MR BROKEN**
-
----
-
-
-

brokenxapi-2.0.2/brokenxapi/__init__.py

@@ -1,4 +0,0 @@
-from .client import BrokenXAPI
-
-__all__ = ["BrokenXAPI"]
-

brokenxapi-2.0.2/brokenxapi/__version__.py

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