Skip to main content

Asyncio client for TeraBox cloud storage

Project description


Features

  • ⚡ Fully asynchronous (asyncio)
  • 🌐 HTTP client based on aiohttp
  • 🔐 Authentication and session handling
  • 📂 File and directory operations
  • ⬆️ File uploads and downloads

Installation

pip install aioterabox

Install from source

git clone https://github.com/devbis/aioterabox.git
cd aioterabox
pip install -e .

Usage

import asyncio
import aiohttp
from aioterabox.api import TeraboxClient
from aioterabox.exceptions import TeraboxLoginChallengeRequired


async def main():
    async with aiohttp.ClientSession() as session:
        tb = TeraboxClient(
            session=session,
            email='your_email',
            password='your_password',
        )
        try:
            await tb.login()
        except TeraboxLoginChallengeRequired as exc:
            # TeraBox may require a simple-verify continuation step.
            await tb.complete_login_challenge(exc.challenge)

        # get quota
        print('quota = ', await tb.get_storage_quota())

        # list files
        files = await tb.list_remote_directory('/path/to/directory')
        print(files)
        
        # create directory
        await tb.create_directory('/remote/directory')

        # upload file
        await tb.upload_file('/home/user/localfile.zip', f'/remote/directory/remotefile.zip')

        # download file
        meta = await tb.get_files_meta(['/remote/directory/remotefile.zip'])[0]
        async with session.get(meta['dlink']) as resp:
            # the link is signed and can be downloaded without authentication
            with open('/tmp/downloadedfile.zip', 'wb') as f:
                while chunk := await resp.content.read(1024):
                    f.write(chunk)

        # rename file  
        await tb.rename_file('/remote/directory/remotefile.zip', 'newname.zip')

        # delete file
        await tb.delete_files(['/remote/directory/newname.zip'])

asyncio.run(main())

The client can now start from only email/password and establish the session cookies on its own. When TeraBox responds with need verify, the library raises TeraboxLoginChallengeRequired and stores the in-progress session so the caller can continue the flow with complete_login_challenge().

If you want to persist a working session between restarts, store the cookies returned by login() or complete_login_challenge(). The useful fields are usually jstoken, csrfToken, browserid, ndus, TSID, shareUpdateRandom, and lang.

For file operations you should always use absolute paths starting from the root directory /.

Configuration

Manual cookie bootstrap

If you prefer to start from an existing browser session, you can still extract the session JS Token and cookies manually.

Getting the JS Token

To use this tool you need to have a Terabox account and a JS Token key. You can get the session JS Token by logging into your Terabox account and following the sequence of steps below:

  1. Open your Terabox cloud.
  2. Open the browser's developer tools (F12).
    Developer tools F12
  3. Enable the "Device Toolbar" then click the back arrow to get back to Terabox.
    Developer tools F12 "Device Toolbar" Back Arrow
  4. Go to the "Network" tab.
    Developer tools F12 Network tab
  5. Select the "XHR" filter.
    Developer tools F12 XHR filter
  6. Click any directory or file in the cloud.
  7. Look for any request made to the Terabox cloud URL and click on it.
    Developer tools F12 request item
  8. Select the "Payload" tab.
    Developer tools F12 Payload tab
  9. Look for the jsToken parameter in the list and copy its value.

If you can't find the jsToken parameter, try selecting any other directory or file in the cloud and look for the jsToken parameter in the request payload. Make sure that you have the "XHR" filter selected and that you are looking at the "Payload" tab.

Getting the cookies values

Additionally to the JS Token, you will need to capture the cookies values. You can get them by following the sequence of steps below:

  1. Open your Terabox cloud.
  2. Open the browser's developer tools (F12).
    Developer tools F12
  3. Go to the "Application" tab.
    Developer tools F12 Application tab
  4. Select the "Cookies" item in the left panel.
    Developer tools F12 Cookies tab
  5. Look for the cookies values and copy them.
    Developer tools F12 Cookies values

You will need to copy the csrfToken, browserid, and ndus values. Once the values are provided the library will refresh the csrfToken and jstoken values on login automatically.

Requirements

  • Python 3.9+
  • aiofiles
  • aiohttp
  • cryptography

Thanks

https://github.com/seiya-npm/terabox-api for reverse engineering the TeraBox API and JavaScript implementation. https://github.com/dnigamer/TeraboxUploaderCLI/ for the instructions on obtaining session cookies.

Disclaimer

This project is not affiliated with or endorsed by TeraBox. The API behavior may change at any time, which can break compatibility.

Use at your own risk.

License

Apache License 2.0

See LICENSE for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aioterabox-0.2.3.tar.gz (20.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aioterabox-0.2.3-py3-none-any.whl (19.8 kB view details)

Uploaded Python 3

File details

Details for the file aioterabox-0.2.3.tar.gz.

File metadata

  • Download URL: aioterabox-0.2.3.tar.gz
  • Upload date:
  • Size: 20.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for aioterabox-0.2.3.tar.gz
Algorithm Hash digest
SHA256 796b56483119b777a13a1fd3d79917471e81084e91bfebd5dc2c582e05c0771d
MD5 ebc626a8db43759433dcf812165f23d5
BLAKE2b-256 b289af636fcc08f6b0b554fa93708bdfb5b955627bee817bb641a31a86261ce1

See more details on using hashes here.

File details

Details for the file aioterabox-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: aioterabox-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 19.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for aioterabox-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 74e2ca08cd1b1ea13579f378478b84ffe4e3a9932344b6aa584e4a11b4c0873c
MD5 da693634e054c0ec206aebe212f0f2df
BLAKE2b-256 24059e0fadaf14f62a6b5325f9777d51c5f4775be9d5cfe32d053840ca1d4ace

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page