BROKENXAPI 2.0.5__py3-none-any.whl → 2.0.7__py3-none-any.whl

brokenxapi/__init__.py

@@ -8,9 +8,9 @@ __all__ = ["BrokenXAPI"]
 
 logger = logging.getLogger("BrokenXAPI")
 
-logger.info("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")
+logger.info("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")
 logger.info("🚀 BROKENXAPI INITIALIZED")
 logger.info("⚡ Powered by Broken X Network")
-logger.info("🔐 Secure • Async • Fast")
+logger.info("🔐 Join Telegram: @AboutBrokenX • @BrokenXNetwork1 For Future Updates")
 logger.info("Thanks ❤‍🩹 For Using BrokenxAPI") 
-logger.info("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")
+logger.info("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")

brokenxapi/__version__.py

@@ -1,2 +1,2 @@
-__version__ = "2.0.5"
+__version__ = "2.0.7"
 

brokenxapi-2.0.7.dist-info/METADATA

@@ -0,0 +1,237 @@
+Metadata-Version: 2.4
+Name: BROKENXAPI
+Version: 2.0.7
+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 Documentation
+
+
+**BROKENXAPI** is an async-first Python SDK that allows developers to access
+BrokenX YouTube services securely using an API key.
+---
+
+> [!CAUTION]
+> **IMPORTANT DISCLAIMER**
+>
+> This project is designed for **Educational Purposes Only**.
+> Usage of this software to download copyrighted content (Music/Videos) without permission may violate YouTube's Terms of Service and local copyright laws.
+>
+> The developer (**MR BROKEN**) assumes **NO responsibility** for any misuse or legal consequences resulting from the use of this tool. Use it at your own risk.
+
+---
+
+## Features
+- Async / non-blocking
+- Secure header-based authentication
+- Clean SDK (no backend exposure)
+- Telegram-powered media delivery
+
+## Requirements
+- Python 3.8 or higher
+- Valid BrokenX API key Get it from [Here](https://t.me/AboutbrokenX) 
+- Internet access
+
+---
+##### Install with pip:
+```bash
+pip install BROKENXAPI
+```
+
+# Quick Start
+
+Recommended: set your API key as an environment variable for local development.
+
+Linux / macOS:
+```bash
+export API_KEY="BROKENXAPI-XXXX"
+```
+
+Windows (cmd):
+```bat
+set API_KEY=BROKENXAPI-XXXX
+```
+
+Basic usage (using env var):
+```python
+import os
+import asyncio
+from brokenxapi import BrokenXAPI
+
+API_KEY = os.getenv("API_KEY")  # recommended
+async def main():
+    async with BrokenXAPI(api_key=API_KEY) as api:
+        result = await api.search("Arijit Singh")
+        print(result)
+
+asyncio.run(main())
+```
+
+Or pass API key directly (less secure):
+```python
+async with BrokenXAPI(api_key="BROKENXAPI-XXXX") as api:
+    result = await api.search("No Copyright sounds", video=False)
+```
+
+---
+
+# Authentication
+
+BROKENXAPI uses header-based authentication. The SDK sets the `Authorization` header for you when you pass `api_key` to the constructor.
+
+Header format (used internally by the SDK):
+```
+Authorization: Bearer YOUR_API_KEY
+```
+
+Do not commit or share your API key in public repositories.
+
+---
+
+
+Context-manager usage:
+```python
+async with BrokenXAPI(api_key="...") as api:
+    ...
+```
+
+### search(query: str, video: bool = False, limit: int = 20)
+Search for YouTube content.
+
+- Parameters:
+  - query (str): search keyword
+  - video (bool): False = audio (default), True = video
+  - limit (int): number of results to request (default 20)
+
+- Returns: dict — a JSON-compatible dictionary including keys such as:
+  - title
+  - video_id
+  - duration
+  - thumbnail
+
+Example:
+```python
+result = await api.search("no copyright sounds", video=False)
+video_id = result["video_id"]
+```
+
+### download(video_id: str, media: str = "audio")
+Download audio or video via BrokenX backend.
+
+- Parameters:
+  - video_id (str): YouTube video id
+  - media (str): "audio" (default) or "video"
+
+- Returns: dict — download metadata. Example keys:
+  - telegram_url
+
+Example:
+```python
+audio = await api.download(video_id, media="audio")
+print(audio["telegram_url"])
+```
+
+Notes:
+- The SDK converts boolean query parameters to strings before sending (e.g. True -> "true").
+- All network requests raise on non-2xx responses via aiohttp.
+
+---
+
+# Error Handling
+
+All SDK errors inherit from `BrokenXAPIError`.
+
+Example:
+```python
+from brokenxapi.exceptions import BrokenXAPIError
+
+try:
+    await api.download("invalid_id")
+except BrokenXAPIError as e:
+    print("Error:", e)
+```
+
+---
+
+# CLI
+
+The package provides a `brokenx` CLI. Example usage:
+
+- Save API key:
+```bash
+brokenx auth BROKENXAPI-XXXX
+```
+
+- Search:
+```bash
+brokenx search "no copyright sounds"
+```
+
+- Download (audio):
+```bash
+brokenx download VIDEO_ID
+```
+
+- Download (video):
+```bash
+brokenx download VIDEO_ID -v
+```
+
+---
+
+# Running tests
+
+Set the `YTKEY` env var before running tests that hit the real backend:
+
+```bash
+export API_KEY="BROKENXAPI-XXXX"
+pytest -q
+```
+
+Tests that require a live API key are skipped automatically if `API_KEY` is not set.

brokenxapi-2.0.7.dist-info/RECORD

@@ -0,0 +1,13 @@
+brokenxapi/__init__.py,sha256=kLRH4KqUuez6MeVRXmIGUXXhK5kTGMs5K1g5WJhv50g,672
+brokenxapi/__version__.py,sha256=DztBFRsZn6dmSiL6gaH4Vp0DP0-eSBMtFnCE4Xras4g,23
+brokenxapi/auth.py,sha256=OE3quhkBiWWOeq0beOUzRA4upYkVzJEmegU-n5Hytdg,247
+brokenxapi/cli.py,sha256=uG7xMLE8jPS9FhIaYrCPGDPeQFttVfKnsLxA7WRe5Z0,1291
+brokenxapi/client.py,sha256=_UI6fI39PsPDACZd3IC0O5CBWsTYt08UtZUC3waFEhU,2405
+brokenxapi/exceptions.py,sha256=0__KYZV449w918o2MWsy8Enzddx3fdN1KiKXoGuePQw,192
+brokenxapi/models.py,sha256=2qySJw3hEFJo7-mwfajEXio_1BJfyCkta_yWrd5lw_o,372
+brokenxapi-2.0.7.dist-info/licenses/LICENSE,sha256=yRwkbOC0HB698kkiR8avfaaH53Sl81OO5wo-jQUnuHU,1066
+brokenxapi-2.0.7.dist-info/METADATA,sha256=SIGiEeUSzur6hZYLPni4lH9wgzU-038lGnrN8n9WLpo,6409
+brokenxapi-2.0.7.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+brokenxapi-2.0.7.dist-info/entry_points.txt,sha256=50BWnsEyhIqeJnpnS8FgL5wJx-XdxZ9wsmkL5g6KWfI,48
+brokenxapi-2.0.7.dist-info/top_level.txt,sha256=IXYT66QzKWQbFNCWiR6YriwKBLuws3oEb6fVSfGdQVk,11
+brokenxapi-2.0.7.dist-info/RECORD,,

brokenxapi-2.0.5.dist-info/METADATA

@@ -1,178 +0,0 @@
-Metadata-Version: 2.4
-Name: BROKENXAPI
-Version: 2.0.5
-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.5.dist-info/RECORD

@@ -1,13 +0,0 @@
-brokenxapi/__init__.py,sha256=bimmkqNAi3GRJVjRVQiKlD9mhxmeLMTuNL7RX4EZg6o,557
-brokenxapi/__version__.py,sha256=6ordXD7RlJISGczKIl0KsCvQWPfd4S6i08UAOPccBTI,23
-brokenxapi/auth.py,sha256=OE3quhkBiWWOeq0beOUzRA4upYkVzJEmegU-n5Hytdg,247
-brokenxapi/cli.py,sha256=uG7xMLE8jPS9FhIaYrCPGDPeQFttVfKnsLxA7WRe5Z0,1291
-brokenxapi/client.py,sha256=_UI6fI39PsPDACZd3IC0O5CBWsTYt08UtZUC3waFEhU,2405
-brokenxapi/exceptions.py,sha256=0__KYZV449w918o2MWsy8Enzddx3fdN1KiKXoGuePQw,192
-brokenxapi/models.py,sha256=2qySJw3hEFJo7-mwfajEXio_1BJfyCkta_yWrd5lw_o,372
-brokenxapi-2.0.5.dist-info/licenses/LICENSE,sha256=yRwkbOC0HB698kkiR8avfaaH53Sl81OO5wo-jQUnuHU,1066
-brokenxapi-2.0.5.dist-info/METADATA,sha256=0Mw6OKt5UWjlqkxTFXVg27ujtffPRhof2ZPoAjIMkuA,4638
-brokenxapi-2.0.5.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-brokenxapi-2.0.5.dist-info/entry_points.txt,sha256=50BWnsEyhIqeJnpnS8FgL5wJx-XdxZ9wsmkL5g6KWfI,48
-brokenxapi-2.0.5.dist-info/top_level.txt,sha256=IXYT66QzKWQbFNCWiR6YriwKBLuws3oEb6fVSfGdQVk,11
-brokenxapi-2.0.5.dist-info/RECORD,,