Skip to main content

Professional Python SDK for MiCloud API

Project description

MiCloud SDK

Python библиотека для работы с MiCloud API.

Особенности

  • 🔐 Безопасная аутентификация через API ключи
  • 📦 Загрузка и управление файлами
  • 📁 Работа с папками и структурой файлов
  • 🔗 Создание публичных ссылок для шаринга
  • 📊 Получение статистики использования
  • 🔄 Поддержка асинхронных операций

Установка

pip install micloud-sdk

Быстрый старт

Инициализация клиента

from micloud_sdk import MiCloudClient

# Просто передайте API ключ - всё остальное настроено
client = MiCloudClient(api_key="ваш_api_ключ")

Получение информации о пользователе

# Базовая информация (user_id, username, full_name)
user_info = client.auth.get_current_user()
print(f"Пользователь: {user_info.username} (ID: {user_info.user_id})")

# Полная информация со статистикой (используйте эту для storage и premium статуса)
full_user = client.auth.get_full_user()
print(f"Всего файлов: {full_user.files_count}")
print(f"Используется: {full_user.used_storage / 1024 / 1024} MB")
print(f"Лимит: {full_user.max_storage / 1024 / 1024} MB")
print(f"Премиум: {full_user.is_premium}")

Важно: /me возвращает только базовую информацию. Для полной статистики используйте get_full_user() которая вызывает /me/stats.

Загрузка файла

# Загрузить файл
file_info = client.files.upload("path/to/file.txt")
print(f"Файл загружен: {file_info.name}")
print(f"Размер: {file_info.size} байт")

Создание репозитория

# Создать репозиторий
repo = client.repos.create("Мой проект", "Описание проекта")
print(f"Репо создано: {repo.name}")

Асинхронное использование

import asyncio

async def main():
    client = MiCloudClient(api_key="ваш_api_ключ")
    
    # Базовая информация
    user = await client.auth.get_current_user_async()
    print(f"Пользователь: {user.username}")
    
    # Полная информация со статистикой
    full_user = await client.auth.get_full_user_async()
    print(f"Статистика: {full_user.files_count} файлов")
    
    await client.close()

asyncio.run(main())

С контекстным менеджером

async with MiCloudClient(api_key="ваш_api_ключ") as client:
    user = await client.auth.get_current_user_async()
    print(f"Пользователь: {user.username}")

API Referece

Аутентификация

  • client.auth.get_current_user() - Получить базовую информацию о пользователе
  • client.auth.get_full_user() - Получить полную информацию с статистикой
  • client.auth.get_stats() - Получить статистику использования

Файлы

  • client.files.upload(file_path) - Загрузить файл
  • client.files.list_tree() - Получить дерево файлов
  • client.files.download(file_id) - Скачать файл
  • client.files.delete(file_id) - Удалить файл

Папки

  • client.folders.create(name, parent_id) - Создать папку
  • client.folders.list(parent_id) - Список папок
  • client.folders.delete(folder_id) - Удалить папку

Репозитории

  • client.repos.create(name, description) - Создать репозиторий
  • client.repos.list() - Список репозиториев
  • client.repos.delete(repo_id) - Удалить репозиторий

Конфигурация

API подключается к https://api.micloud.website по умолчанию. Убедитесь что у вас есть действительный API ключ.

Обработка ошибок

from micloud_sdk import (
    MiCloudClient,
    AuthenticationError,
    RateLimitError,
    NotFoundError,
    ValidationError,
)

try:
    client = MiCloudClient(api_key="invalid_key")
    user = client.auth.get_current_user()
except AuthenticationError:
    print("Неверный API ключ")
except RateLimitError as e:
    print(f"Превышено ограничение. Повторите через {e.retry_after} сек")
except NotFoundError:
    print("Ресурс не найден")
except ValidationError as e:
    print(f"Ошибка валидации: {e}")

Версионирование

Версия SDK: 1.0.0 API версия: v1

Лицензия

MIT

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

micloud_sdk-1.0.2.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

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

micloud_sdk-1.0.2-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file micloud_sdk-1.0.2.tar.gz.

File metadata

  • Download URL: micloud_sdk-1.0.2.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for micloud_sdk-1.0.2.tar.gz
Algorithm Hash digest
SHA256 a504e2ca375356ff6e2688f1836c5c5431ccdf060a7d49f53219a99d848be5ae
MD5 6eb3b6e32bee1c60419bf18aae6b280d
BLAKE2b-256 187e5e79f2ad81449f2652b7173235939253eab2c4add0ff487abc04f900b489

See more details on using hashes here.

File details

Details for the file micloud_sdk-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: micloud_sdk-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for micloud_sdk-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ce7f89c1d946c54f045d8758bf799dc104235a9fc9fffa704ef2fd66fb9d01f6
MD5 d4f2fb1e322b82ccaddd7d84499a5e3a
BLAKE2b-256 d5be223c4ad51c0c4a6ab26fe269b51f7800030e586fa730b037f0ce195c54e9

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