Index
msaServer - Helper & Wrapper around Uvicorn/Gunicorn for FastAPI based apps
Features¶
- Uvicorn Wrapper: MSAServerUvicorn.
- Gunicorn Wrapper: MSAServerGunicorn.
Main Dependencies¶
- gunicorn~=20.1.0: WSGI HTTP Server for UNIX
- uvicorn~=0.18.3: The lightning-fast ASGI server.
Usage example¶
# -*- encoding: utf-8 -*-
import os
from loguru import logger
ROOTPATH = os.path.join(os.path.dirname(__file__))
if __name__ == "__main__":
from msaServer import base
logger.info("Starting Services...")
base.run(app_dir=ROOTPATH)
License Agreement¶
msaServer
Based onMIT
open source and free to use, it is free for commercial use, but please show/list the copyright information about msaServer somewhere.
How to create the documentation¶
We use mkdocs and mkdocsstring. The code reference and nav entry get's created virtually by the triggered python script /docs/gen_ref_pages.py while mkdocs
serve
or build
is executed.
Requirements Install for the PDF creation option:¶
PDF Export is using mainly weasyprint, if you get some errors here pls. check there documentation. Installation is part of the msaServer, so this should be fine.
We can now test and view our documentation using:
mkdocs serve
Build static Site:
mkdocs build
Build and Publish¶
Build:
python setup.py sdist
Publish to pypi:
twine upload dist/*