Index
msaJustPyUI - FastAPI adapted JustPy version for Integration of justpy UI Web Framework to msaAppService, which allows simple adding of routes to justpy webpages functions.
Features¶
- Integrated justpy WEB UI: Integrated justpy UI Web Framework to FastAPI/Starlette, which allows simple adding of routes to justpy webpages functions.
License Agreement¶
msaJustPyUI
is based onMIT
open source and free to use, it is free for commercial use, but please show/list the copyright information about msaJustPyUI 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 msaJustPyUI, 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/*