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.7.1.tar.gz (30.9 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.7.1-py3-none-any.whl (41.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for kuro_py-0.7.1.tar.gz
Algorithm Hash digest
SHA256 b3c286826015f208b381ce3b5502d3eaa17851db0ab1fd86370fe2c79ea33d0a
MD5 eb3ec0a577f8a3c8e52ea0580be51571
BLAKE2b-256 1eeff315d0ed05a51fbbf88cffa58f30c4c6cc862f8f8a9b54eca6f3efd02c59

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for kuro_py-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 85e13964585da3b579ebba6013cb06513ddb28c5e31eb94f3df1844b988da7cb
MD5 0cd58ceea08e23661775787ad460baba
BLAKE2b-256 1fec5641c6fb316db4bffd080dec80b46378d703b52daf60a395ad5217259405

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