Metadata-Version: 2.1
Name: mappi
Version: 0.5.0
Summary: Spin up webserver from a yaml config file
License: MIT
Author: Misha Behersky
Author-email: bmwant@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: PyYAML (>=6.0,<7.0)
Requires-Dist: fastapi (>=0.87.0,<0.88.0)
Requires-Dist: rich (>=12.6.0,<13.0.0)
Requires-Dist: uvicorn (>=0.20.0,<0.21.0)
Description-Content-Type: text/markdown

# mappi

![Tests](https://github.com/bmwant/mappi/actions/workflows/tests.yml/badge.svg)
[![PyPI](https://img.shields.io/pypi/v/mappi)](https://pypi.org/project/mappi/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mappi)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![EditorConfig](https://img.shields.io/badge/-EditorConfig-grey?logo=editorconfig)](https://editorconfig.org/)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

### Installation

```bash
$ pip install mappi
$ mappi  # run server with example configuration
```

### Usage

```bash
# generate minimal config file
$ mappi config > mappi.yml

# adjust routes as needed or create your own config
$ vim mappi.yml

# dump configuration with all the options available to a file
$ mappi config --full > mappi.yml

# start your webserver
$ mappi

# start server with configuration stored in different filename
$ mappi --config my-config-file.yml
```

### Development

```bash
$ poetry install
$ poetry run python -m mappi

$ poetry run mappi

$ pre-commit install
$ pre-commit autoupdate
```

