initial commit

Author: viperadnan-git

.github/workflows/publish.yml

@@ -0,0 +1,48 @@
+name: Publish to PyPI
+
+on:
+    release:
+        types: [created]
+
+concurrency:
+    group: ${{ github.workflow }}
+
+jobs:
+    deploy:
+        name: Upload release to TestPyPI and PyPi
+
+        runs-on: ubuntu-latest
+
+        environment:
+            name: pypi
+            url: https://pypi.org/p/sonicbit
+
+        permissions:
+            id-token: write
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+
+            - name: Set up Python
+              uses: actions/setup-python@v5
+
+            - name: Install dependencies
+              run: |
+                  pip install -r requirements.txt 
+                  pip install -U build
+
+            - name: Build and package
+              run: python3 -m build --sdist --wheel --outdir dist/ .
+
+            - name: Publish 📦 to Test PyPI
+              uses: pypa/gh-action-pypi-publish@release/v1
+              with:
+                  password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+                  repository-url: https://test.pypi.org/legacy/
+                  skip-existing: true
+
+            - name: Publish 📦 to PyPI
+              uses: pypa/gh-action-pypi-publish@release/v1
+              with:
+                  password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -0,0 +1,15 @@
+# python cache and virtual environment
+.venv/
+__pycache__/
+
+# program output
+*.cache
+
+# build files
+dist/
+build/
+*.egg-info/
+
+# development test files
+test.py
+test.json

.python-version

@@ -0,0 +1 @@
+3.12

LICENSE

@@ -0,0 +1,215 @@
+# SonicBit Python SDK
+
+An unofficial Python SDK for SonicBit which uses the internal API to interact with the application.
+
+> [!WARNING]  
+> This SDK is provided as-is and is not officially supported by Sonicbit. The author is not responsible for any damages or losses caused by the use of this SDK. Use it at your own risk. Please use it responsibly and with the understanding that it may not be fully functional or reliable. Check Sonicbit's terms of service for more information.
+
+## Installation
+
+Install the package using pip:
+
+```bash
+pip install sonicbit
+```
+
+Install bleeding edge version:
+
+```bash
+pip install git+https://github.com/viperadnan-git/sonicbit-python-sdk.git
+```
+
+## Usage
+
+> [!IMPORTANT]  
+> This SDK is still in development and may not be fully functional. Please report any issues or bugs you encounter.
+> The below documentation is generated by AI and is subject to change as the SDK evolves.
+
+To use the SDK, you need to create an instance of the `SonicBit` class and provide your email and password:
+
+```python
+from sonicbit import SonicBit
+
+sb = SonicBit(email='your_email@example.com', password='your_password')
+```
+
+Once you have an instance of `SonicBit`, you can use its various methods to interact with the application. For example, to list the files in your storage:
+
+```python
+files = sb.list_files()
+print(files)
+```
+
+### Token Handling
+
+By default, the SDK will store your authentication token in a file named `.sonicbit.cache` in the current working directory. If you want to specify a different location for the token file, you can pass a `token_handler` argument to the `SonicBit` constructor:
+
+```python
+sb = SonicBit(email='your_email@example.com', password='your_password', token_handler=MyTokenHandler())
+```
+
+The `token_handler` should implement the following methods:
+
+-   `read(email: str) -> str | None`: Reads the token for the given email from the token file.
+-   `write(email: str, token: str) -> None`: Writes the token for the given email to the token file.
+
+The `token_handler` is optional and will default to a `TokenFileHandler` if not provided.
+
+> [!TIP]  
+> You can use the `BaseTokenHandler` class to store and update tokens in a database or other storage mechanism. Simply implement the `read` and `write` methods and pass an instance of your custom class to the `SonicBit` constructor. This will allow you to store tokens in a secure location and easily update them as needed.
+
+### User Module
+
+The `User` module provides methods for interacting with the user's account, such as getting their user details and storage details.
+
+#### User Details
+
+To get the user's details, you can use the `get_user_details` method:
+
+```python
+details = sb.get_user_details()
+print(details)
+```
+
+This will print a `UserDetails` object containing information about the user's account, such as their email, plan name, and more.
+
+#### Storage Details
+
+To get the storage details, you can use the `get_storage_details` method:
+
+```python
+details = sb.get_storage_details()
+print(details)
+```
+
+This will print a `StorageDetails` object containing information about the user's storage, such as their total storage size, free space, and more.
+
+#### Clear Storage
+
+To clear the user's storage, you can use the `clear_storage` method:
+
+```python
+success = sb.clear_storage()
+print(success)
+```
+
+This will return `True` if the storage was successfully cleared, or `False` if there was an error.
+
+### Torrent Management
+
+The `Torrent` module provides methods for interacting with the user's torrents, such as adding, listing, and deleting torrents.
+
+#### Add Torrent
+
+To add a torrent, you can use the `add_torrent` method:
+
+```python
+torrents = sb.add_torrent("https://example.com/torrent.torrent")
+print(torrents)
+```
+
+This will return a list of torrent hashes that were added.
+
+#### List Torrents
+
+To list the user's torrents, you can use the `list_torrents` method:
+
+```python
+torrents = sb.list_torrents()
+print(torrents)
+```
+
+This will print a `TorrentList` object containing information about each torrent in the user's storage, such as the torrent name, hash, size, progress, and more.
+
+#### Get Torrent Details
+
+To get the details of a torrent, you can use the `get_torrent_details` method:
+
+```python
+details = sb.get_torrent_details("hash")
+print(details)
+```
+
+This will print a `TorrentDetails` object containing information about the torrent, such as the files it contains, the download rate, and more.
+
+#### Delete Torrent
+
+To delete a torrent, you can use the `delete_torrent` method:
+
+```python
+success = sb.delete_torrent("hash")
+print(success)
+```
+
+This will return `True` if the torrent was successfully deleted, or `False` if there was an error.
+
+### Remote Download Management
+
+The `RemoteDownload` module provides methods for interacting with the user's remote downloads, such as adding, listing, and deleting remote downloads.
+
+#### Add Remote Download
+
+To add a remote download, you can use the `add_remote_download` method:
+
+```python
+success = sb.add_remote_download("https://example.com/file.torrent", PathInfo.root())
+print(success)
+```
+
+This will return `True` if the remote download was successfully added, or `False` if there was an error.
+
+#### List Remote Downloads
+
+To list the user's remote downloads, you can use the `list_remote_downloads` method:
+
+```python
+downloads = sb.list_remote_downloads()
+print(downloads)
+```
+
+This will print a `RemoteTaskList` object containing information about each remote download in the user's storage, such as the download URL, progress, and more.
+
+#### Delete Remote Download
+
+To delete a remote download, you can use the `delete_remote_download` method:
+
+```python
+success = sb.delete_remote_download(id)
+print(success)
+```
+
+This will return `True` if the remote download was successfully deleted, or `False` if there was an error.
+
+### File Management
+
+The `File` module provides methods for interacting with the user's files, such as listing, deleting, and moving files.
+
+#### List Files
+
+To list the user's files, you can use the `list_files` method:
+
+```python
+files = sb.list_files()
+print(files)
+```
+
+This will print a `FileList` object containing information about each file in the user's storage, such as the file name, size, and more.
+
+#### Delete File
+
+To delete a file, you can use the `delete_file` method:
+
+```python
+success = sb.delete_file("path/to/file")
+print(success)
+```
+
+This will return `True` if the file was successfully deleted, or `False` if there was an error.
+
+## Contributing
+
+Contributions are welcome! If you find a bug or have a suggestion for a new feature, please open an issue or submit a pull request on the GitHub repository.
+
+## License
+
+This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for more details.

README.md

@@ -0,0 +1,4 @@
+pip install autoflake black isort -q
+isort .
+black .
+autoflake --in-place  --remove-all-unused-imports --recursive .

format.sh

@@ -0,0 +1 @@
+requests>=2.28.1

requirements.txt

@@ -0,0 +1,34 @@
+import re
+
+from setuptools import find_packages, setup
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+
+def get_version() -> str:
+    with open("sonicbit/__init__.py", "r") as f:
+        version = re.search(r'__version__ = "(.*?)"', f.read()).group(1)
+        return version
+
+
+setup(
+    name="sonicbit",
+    version=get_version(),
+    author="Adnan Ahmad",
+    author_email="viperadnan@gmail.com",
+    description="An unofficial Python SDK for SonicBit which uses the internal API to interact with the application.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/viperadnan-git/sonicbit-python-sdk",
+    license="GNU General Public License v3.0",
+    keywords="sonicbit python sdk",
+    packages=find_packages(),
+    install_requires=["requests"],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.10",
+)

setup.py

@@ -0,0 +1,11 @@
+import logging
+
+from sonicbit.handlers.token_file import TokenFileHandler
+from sonicbit.sonicbit import SonicBit
+
+__version__ = "0.1.0"
+__all__ = ["SonicBit", "TokenFileHandler"]
+
+logging.basicConfig(
+    level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s"
+)

sonicbit/__init__.py

@@ -0,0 +1,18 @@
+class Constants:
+    API_DOMAIN = "v4.sonicbit.net"
+    API_ORIGIN = "https://my.sonicbit.net"
+    API_REFERER = "https://my.sonicbit.net/"
+    API_BASE_URL = f"https://{API_DOMAIN}/api"
+
+    USER_AGENT = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.6 Safari/605.1.15"
+
+    API_HEADERS = {
+        "Accept": "application/json, text/plain, */*",
+        "Accept-Encoding": "gzip, deflate, br",
+        "Accept-Language": "en-IN,en-GB;q=0.9,en;q=0.8",
+        "Connection": "keep-alive",
+        "Host": API_DOMAIN,
+        "Origin": API_ORIGIN,
+        "Referer": API_REFERER,
+        "User-Agent": USER_AGENT,
+    }