Skip to main content

Async API wrapper for KuroBBS written in Python.

Project description

kuro.py

Async API wrapper for KuroBBS and Waves game written in Python

Usage

Basic usage example:

import asyncio
import kuro

async def main() -> None:
    client = kuro.Client()
    login_result = await client.game_login("email@example.com", "password")
    print(login_result)

asyncio.run(main())

See tests for more examples.

Setting up the development environment

# Clone the repo
git clone https://github.com/Wuthery/kuro.py
cd kuro.py

# Install the dependencies
uv sync

# Install pre-commit
pre-commit install

Running tests

  1. Create a .env file in the root directory of the project and add your test account credentials:
    TEST_EMAIL=""
    TEST_PASSWORD=""
    
  2. Run the tests using pytest:
    pytest
    

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

kuro_py-0.6.1.tar.gz (30.6 kB view details)

Uploaded Source

Built Distribution

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

kuro_py-0.6.1-py3-none-any.whl (40.8 kB view details)

Uploaded Python 3

File details

Details for the file kuro_py-0.6.1.tar.gz.

File metadata

  • Download URL: kuro_py-0.6.1.tar.gz
  • Upload date:
  • Size: 30.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.10.18 Linux/6.11.0-1018-azure

File hashes

Hashes for kuro_py-0.6.1.tar.gz
Algorithm Hash digest
SHA256 2b3180f7db6d71fb0fbca210f5c870f85af996fcff7e44329325618b0d9be230
MD5 ddedda81626ef17d59e9a1575b4423ea
BLAKE2b-256 5e31ce76761b20913a7dfb606b270e4ae93ecad7a1904ca7d69042512f5f0285

See more details on using hashes here.

File details

Details for the file kuro_py-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: kuro_py-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 40.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.10.18 Linux/6.11.0-1018-azure

File hashes

Hashes for kuro_py-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1be804e05ff8dc606c4f1d41cf4a6d29da78bc7c57765a935b55cdd9d2c40a2e
MD5 cd30fbd5d77ccc35f2c313c6d9808c65
BLAKE2b-256 b8ef8148e7d485e2d64543cb55934029bf7c24017e1cbefdb633926b8a3ec4a4

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