Skip to main content

Cloudreve api client

Project description

Cloudreve Python Client

An async Python client for the Cloudreve API.
Supports authentication, file operations, token management, and utilities—built on httpx and aiofiles.


Important Note

Active Development
This client library is under active development and is not yet feature-complete. It was built to satisfy specific use-cases and may change without warning.

Not Production-Ready
Use at your own risk. Do not deploy this in production environments unless you fully understand its internals and have thoroughly tested it for your needs.

Contributions, feedback, and issue reports are welcome—but please be cautious if you plan to rely on this library for critical workloads.


Features

  • Health check (ping())

  • Authentication

    • password_sign_in(email, password, captcha=None, ticket=None)
    • refresh_token(refresh_token)
    • is_token_valid()
    • validate_token()
  • File operations

    • list_files(uri, page=0, page_size=50, order_by="created_at", order_direction="asc", next_page_token=None)
    • get_file_info(file_uri, file_id, extended=False, folder_summary=False)
    • create_download_url(uris, download=False, redirect=False, entity=None, use_primary_site_url=False, skip_error=False, archive=False, no_cache=False)
    • get_download_url(uris, download=False, redirect=False, entity=None, use_primary_site_url=False, skip_error=False, archive=False, no_cache=False)
    • update_file_content(file_uri, content, previous=None)
    • create_upload_session(uri, filename, size, chunk_size, expire_in, ...)
    • delete_upload_session(id, uri)
    • delete_file(uris, unlink=False, skip_soft_delete=False)
    • force_unlock(tokens)
    • get_last_folder_or_file(uri)
  • Download & save

    • save_url_as_file(url, save_dir, filename, extension, overwrite=True)
  • Utilities

    • read_file_as_bytes(path)
    • get_headers(include_auth=True, include_content_type=True)

Installation

# Install from PyPI
pip install InoCloudreve

# install locally:
git clone https://github.com/nobandegani/InoCloudreve.git
cd InoCloudreve
pip install -e .

License

Mozilla Public License Version 2.0

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

inocloudreve-0.1.7.tar.gz (20.4 kB view details)

Uploaded Source

Built Distribution

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

inocloudreve-0.1.7-py3-none-any.whl (30.5 kB view details)

Uploaded Python 3

File details

Details for the file inocloudreve-0.1.7.tar.gz.

File metadata

  • Download URL: inocloudreve-0.1.7.tar.gz
  • Upload date:
  • Size: 20.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for inocloudreve-0.1.7.tar.gz
Algorithm Hash digest
SHA256 21e29646908afa3853ed3203d5de137769c4a78e483258b6bb40eb1e24749ffb
MD5 1be7257be908a241be84b255bd3a1aa6
BLAKE2b-256 6811981feabe090712a168f8e8b4b11d7942e74cf3657c8ed0056defe2a25fb8

See more details on using hashes here.

File details

Details for the file inocloudreve-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: inocloudreve-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 30.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for inocloudreve-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e72322e983fdbdcebca4fbc37f41b9fc13f13076df0a0d4b7a9c7b5c37deedce
MD5 d09c0a2c17d59d8d2dba6f960edb1dec
BLAKE2b-256 3a419541a81f4b0d9bf4c107b86de5c6370cf8aa6219024242eca94894106ade

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