https://github.com/apexal/wrathserver
REST API for the Wrathskeller game and Wrathspriter tool to facilitate character creation.
https://github.com/apexal/wrathserver
fastapi python rest-api websockets
Last synced: about 2 months ago
JSON representation
REST API for the Wrathskeller game and Wrathspriter tool to facilitate character creation.
- Host: GitHub
- URL: https://github.com/apexal/wrathserver
- Owner: Apexal
- License: mit
- Created: 2022-02-26T22:14:08.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-06-22T00:58:24.000Z (almost 3 years ago)
- Last Synced: 2025-02-14T09:52:53.314Z (4 months ago)
- Topics: fastapi, python, rest-api, websockets
- Language: Python
- Homepage:
- Size: 34.9 MB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wrathserver
A REST API for facilitating the creation of characters for Wrathskeller.
## Planned Features
- [x] Store characters from Wrathspriter
- [x] Retrieve characters from Wrathskeller
- [x] Remove image backgrounds using machine learning
- [x] Normalize pose images
- [x] Normalize audio volume
- [x] Trim audio silence
- [ ] Lessen audio background noise
## Setup
- Install Python 3.8.13
- Install FFMPEG
- Install [Poetry package manager](https://python-poetry.org/docs/)
- Clone repository `$ git clone [email protected]:Apexal/wrathserver.git`
- Download dependencies `$ poetry install`
- Create `.env` file with environment variables `$ cp .env.example .env`
## Running Locally
```bash
$ 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.
```bash
$ poetry shell
$ pytest .
```