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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kuro_py-0.6.0.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.0.tar.gz
Algorithm Hash digest
SHA256 bbe868919ad95c44b2d283afe4259a1683e6e736eb8325fd0f42b22eff27664c
MD5 14af1dfba1adfabfbf39a8c341ed1da1
BLAKE2b-256 b9d232ec5a00af2dac37b507d7ac6a856502788b00f33705599f9d8d2ab2a5c9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kuro_py-0.6.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 552eb20deb22b5ee7254a1b88553392b9d2621640b5312d9beca70367fc4fffe
MD5 55a06b3a83aca55eec6d737fa229c76a
BLAKE2b-256 609d4bd1985a3cf4c00f452a3d499a971f13d2b5aa73590645542af400131b81

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