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.0.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.0-py3-none-any.whl (41.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kuro_py-0.7.0.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.0.tar.gz
Algorithm Hash digest
SHA256 daa9b02d6c76c29177592880daf336569f461c8daed503f7a139e465441257d0
MD5 752d963f308ca404b84cb5fa1ec7d91e
BLAKE2b-256 f90f347fe25121958fd6edd7bcb2b086409e54edac9b801a1e4af9f89bee5522

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kuro_py-0.7.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a01a31c35500d0ecee8ea615964a9bf7fd294b49b3c5ec5370c2081baffcb36c
MD5 14f8fc555a529b6e392bd198fa70ebef
BLAKE2b-256 0939de564acbbe6718796cfd6b9334a3e6f398bbeb58751e297fc8b458d7b5f5

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