48 lines
780 B
Markdown
48 lines
780 B
Markdown
# MyLARP Web API
|
|
|
|
A parser and REST API for using https://mylarp.dev/
|
|
|
|
This really doesn't do much just yet, just a proof of concept.
|
|
|
|
## Setup
|
|
|
|
Rename the `sample_config.toml` to `config.toml`.
|
|
Then, edit it to include your credentials for login, and the proper url for mylarp.
|
|
|
|
### Create Virtual Environment
|
|
|
|
```bash
|
|
python -m venv ./.venv
|
|
source ./.venv/bin/activate
|
|
```
|
|
|
|
### Install Dependencies
|
|
|
|
You can then install dependencies with Poetry, or using the `requirements.txt`
|
|
|
|
#### Poetry
|
|
|
|
```bash
|
|
pip install poetry
|
|
poetry install --no-root
|
|
```
|
|
|
|
#### requirements.txt
|
|
|
|
```bash
|
|
pip install -r ./requirements.txt
|
|
```
|
|
|
|
## Usage
|
|
|
|
If you installed with Poetry:
|
|
|
|
```bash
|
|
poetry run ./src/mylarp-api/mylarp-api.py
|
|
```
|
|
|
|
Otherwise:
|
|
|
|
```bash
|
|
python ./src/mylarp-api/mylarp-api.py
|
|
```
|