https://github.com/bmwant/mappi

Generate webserver from yaml file
https://github.com/bmwant/mappi

dev-server fastapi nocode python starlette static-serve webserver yaml

Last synced: 2 months ago
JSON representation

Generate webserver from yaml file

• Host: GitHub
• URL: https://github.com/bmwant/mappi
• Owner: bmwant
• Created: 2022-11-15T17:42:39.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-15T10:59:33.000Z (almost 3 years ago)
• Last Synced: 2024-04-24T16:04:27.998Z (almost 2 years ago)
• Topics: dev-server, fastapi, nocode, python, starlette, static-serve, webserver, yaml
• Language: Python
• Homepage:
• Size: 173 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# 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)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)

[![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/)

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)



  



### 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

```

### Contributing

See [DEVELOP.md](https://github.com/bmwant/mappi/blob/main/DEVELOP.md) for the development setup and contributing guide.