https://github.com/u2d-ai/msajustpyui

msaJustPyUI - FastAPI adapted JustPy version for Integration of justpy UI Web Framework to msaAppService, which allows simple adding of routes to justpy webpages functions. Optimized for use with FastAPI/Pydantic.
https://github.com/u2d-ai/msajustpyui

fastapi

Last synced: 3 months ago
JSON representation

msaJustPyUI - FastAPI adapted JustPy version for Integration of justpy UI Web Framework to msaAppService, which allows simple adding of routes to justpy webpages functions. Optimized for use with FastAPI/Pydantic.

• Host: GitHub
• URL: https://github.com/u2d-ai/msajustpyui
• Owner: u2d-ai
• License: mit
• Created: 2022-09-28T16:04:20.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-09-28T21:59:33.000Z (over 2 years ago)
• Last Synced: 2024-11-12T09:03:26.703Z (3 months ago)
• Topics: fastapi
• Language: Python
• Homepage:
• Size: 5.24 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  



------



    msaJustPyUI - FastAPI adapted JustPy version for Integration of justpy UI Web Framework to msaAppService, which allows simple adding of routes to justpy webpages functions.




    Optimized for use with FastAPI/Pydantic.




  

      

  

  

      

  



------

**Documentation**: msaJustPyUI Documentation (https://msaJustPyUI.u2d.ai/)

------

## 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 on `MIT` 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/*