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.5.0.tar.gz (30.1 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.5.0-py3-none-any.whl (40.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kuro_py-0.5.0.tar.gz
  • Upload date:
  • Size: 30.1 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.5.0.tar.gz
Algorithm Hash digest
SHA256 9b025e7858d193bda9348c32382dbbdb1d821b57b5a4a4574a7e4c3498a943a9
MD5 ef99b352856623459e319b29d50bc52c
BLAKE2b-256 d482f2fb9415a1eaa2121a9f828181d26365470c19d34e5619a2e004d4327b46

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kuro_py-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 40.1 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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 34d3c806505d0054a281a01a89a51bd879a0d8390bdbb36e4fd29300be312257
MD5 c69c9821d812bea06ceff0a9f49fdf39
BLAKE2b-256 01965e1ae914f9dd00a2ed118f033eaae7b7bdbada0466d20ee6b0b247f323b0

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