Wrathserver

A REST API for facilitating the creation of characters for Wrathskeller.

Planned Features

• Store characters from Wrathspriter
• Retrieve characters from Wrathskeller
• Remove image backgrounds using machine learning
• Normalize pose images
• Normalize audio volume
• Trim audio silence
• Lessen audio background noise

Setup

• Install Python 3.8.13
• Install FFMPEG
• Install Poetry package manager
• Clone repository $ git clone git@github.com:Apexal/wrathserver.git
• Download dependencies $ poetry install
• Create .env file with environment variables $ cp .env.example .env

Running Locally

$ poetry shell
$ uvicorn api.main:app --reload

Navigate to http://localhost:8000/docs to view the OpenAPI dashboard.

Running Tests

Write tests under api/tests in files that start with test_. Simply write functions that start with test_ and they will be run when you run the commands below.

$ poetry shell
$ pytest .