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.2.1.tar.gz (21.7 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.2.1-py3-none-any.whl (31.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for inocloudreve-0.2.1.tar.gz
Algorithm Hash digest
SHA256 1e657a8475b5cae3e8bbfbcfddb11276164c91ab177d9ce88fff633eefcc1761
MD5 0a8ba9cabbd04075d09b77708032eb05
BLAKE2b-256 45775ee03b00f5c7b80e94b3456ebeff13aaff625fe7cdc5d2851989c0abd0c7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: inocloudreve-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 31.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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 34e78cf2cab75f1c83208645d44c005d12a9dc121c126a0f155127b91384b114
MD5 1d839d9b889fa018faafe2dc142b288f
BLAKE2b-256 19868fb0af6f3a2e4c2f10fff113ddb219cd387ebc47b139a39b557c7cd05648

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