Skip to main content

Асинхронная библиотека для MiningRigRentals API v2

Project description

aio-mrr

Асинхронная библиотека для MiningRigRentals API v2

Python Version License Code Style

📖 Описание

aio-mrr — это асинхронный Python-клиент для MiningRigRentals API v2, построенный на основе aiohttp и pydantic. Библиотека предоставляет типизированный интерфейс ко всем методам API с автоматической обработкой ошибок, retry-логикой и HMAC-SHA1 аутентификацией.

✨ Особенности

  • async/await — полностью асинхронный API
  • Pydantic модели — автоматическая валидация и типизация ответов
  • Retry-логика — автоматические повторные попытки при ошибках сети
  • HMAC-SHA1 аутентификация — безопасная работа с API
  • Connection pooling — эффективное управление соединениями
  • Маскирование секретов — защита API-ключей при логировании

📦 Установка

pip install aio-mrr

Для разработки:

pip install -e ".[dev]"

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

import asyncio
from aio_mrr import MRRClient

async def main():
    api_key = "your_api_key"
    api_secret = "your_api_secret"
    
    async with MRRClient(api_key, api_secret) as client:
        # Проверка аутентификации
        response = await client.whoami()
        if response.success:
            print(f"Logged in as: {response.data['username']}")
        
        # Получение баланса
        balance = await client.account.get_balance()
        if balance.success:
            print(f"Balance: {balance.data}")

asyncio.run(main())

📚 Документация

Полная документация доступна на GitHub Pages:

💡 Примеры

Примеры использования доступны в папке examples/:

🔧 Требования

  • Python 3.12+
  • aiohttp >= 3.13.0
  • pydantic >= 2.12.0
  • tenacity >= 9.1.0
  • loguru >= 0.7.0

📝 API Coverage

Библиотека покрывает все 55 публичных методов MiningRigRentals API v2:

Subclient Методы Описание
Client 1 Проверка аутентификации
AccountClient 16 Аккаунт, баланс, пулы, профили
InfoClient 4 Серверы, алгоритмы, валюты
PricingClient 1 Курсы конвертации и цены
RigClient 15 Управление ригами
RentalClient 12 Управление арендами
RigGroupClient 7 Группы ригов

🤝 Вклад

Приветствуются pull requests! Пожалуйста, создавайте issue для обсуждения изменений перед тем как делать PR.

📄 Лицензия

MIT License



aio-mrr is MIT licensed code.
Designed & built in Novosibirsk, Russia by SibNeuroTech
Contact: @GRinvest

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

aio_mrr-0.1.0.tar.gz (113.9 kB view details)

Uploaded Source

Built Distribution

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

aio_mrr-0.1.0-py3-none-any.whl (69.3 kB view details)

Uploaded Python 3

File details

Details for the file aio_mrr-0.1.0.tar.gz.

File metadata

  • Download URL: aio_mrr-0.1.0.tar.gz
  • Upload date:
  • Size: 113.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for aio_mrr-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5343cd2e8cceeaed2e21e359e44bede66d4ba82cb7f0248aefedd1cd2cf381b6
MD5 728deea7d697b5ee9567d78cb080fa49
BLAKE2b-256 637ac19a5f06b5f666a3c1a6d1e3440baf2a0b6be62b6fbda3f90d641533d040

See more details on using hashes here.

File details

Details for the file aio_mrr-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: aio_mrr-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 69.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for aio_mrr-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f1851b16e10ffae0ec949312a72e895b03b4afd5379faf376d78fcd9b95644e0
MD5 5f002a1fed98c37a8748bbfc27c37d9b
BLAKE2b-256 44a36976f664f39daed5fef511004924268be04fc3c587e08202496164ee42d7

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