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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kuro_py-0.8.0.tar.gz
  • Upload date:
  • Size: 31.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.10.20 Linux/6.17.0-1018-azure

File hashes

Hashes for kuro_py-0.8.0.tar.gz
Algorithm Hash digest
SHA256 b99b5d6cbb519576204d671deae281d139c0dc6c64990fe8584daa90dc74359c
MD5 ffd19be3d7cfdb8846944e118ff2323f
BLAKE2b-256 54fbd9c4fa0529142eabd9268d3c564190dcff97b15f27795666cde4824572f0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for kuro_py-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b09f88bedca73b0e5f107029adb3fe991a6fc37164989a06048e842035b2ae3f
MD5 b6aebd2eb24a305e1a328d0f57e899e8
BLAKE2b-256 910eaba3b085daef416beaef7231fb44c594ac242a13f816ebb415b8f37c1939

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