Skip to content
This repository has been archived by the owner on Nov 2, 2024. It is now read-only.

arenekosreal/QDamakuEngine

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

67 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QDamakuEngine

What is this

This is just a Damaku Engine written in PySide6

How to use

  1. Prepare poetry

    See https://python-poetry.org/docs/#installation for more info.

  2. Install project

    Run poetry install in this repository

  3. Build wheel

    Run poetry build in this repository, you will find artifacts in dist folder

  4. Install wheel

    Run python -m installer dist/*.whl in this repository to install it.

  5. Run the program

    Run qdamakuengine in your terminal and everything should be fine.

  6. Run from source

    After finishing step 2, run poetry run qdamakuengine in this repository instead building, installing and running.

API

Simply connect to the socket and send json string like this:

{
    "text": "sample-damaku"
}

And you should received the response like this:

{
    "result": 0,
    "message": "Success to record damaku"
}

When there is something wrong, you need to check result code and message for detailed info.

Test

Run poetry install --with=dev to install pytest and its plugins, then run poetry run pytest.

Running poetry run pytest --cov=qdamakuengine to get test coverage report.