Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/u2d-ai/msasdk
FastAPI Microservices Architecture SDK - As Basis for multiple services in a platform/system
https://github.com/u2d-ai/msasdk
admin-dashboard async asyncio dapr dapr-sidecar distributed fastapi json microservices openapi pydantic restful scheduler scheduler-service sqlalchemy-python sqlmodel starlette swagger-ui uvicorn-gunicorn vuejs
Last synced: 15 days ago
JSON representation
FastAPI Microservices Architecture SDK - As Basis for multiple services in a platform/system
- Host: GitHub
- URL: https://github.com/u2d-ai/msasdk
- Owner: u2d-ai
- License: mit
- Created: 2022-08-23T12:55:58.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-10-04T08:01:57.000Z (about 2 years ago)
- Last Synced: 2024-10-15T11:36:44.762Z (about 1 month ago)
- Topics: admin-dashboard, async, asyncio, dapr, dapr-sidecar, distributed, fastapi, json, microservices, openapi, pydantic, restful, scheduler, scheduler-service, sqlalchemy-python, sqlmodel, starlette, swagger-ui, uvicorn-gunicorn, vuejs
- Language: Python
- Homepage:
- Size: 64.6 MB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
------
msaSDK - FastAPI based Microservice Architecture Development Kit
To build PoC's, MVP's, API's with CRUD and Dashboards fast and consistent.
Build on top of FastAPI, SQLModel, SQLAlchemy, Amis and many other bullet proofed libraries.
------
**Documentation**: MSA SDK Documentation (http://msa.u2d.ai/)
------
## Features
- **Build connected distributed applications faster**: Ready for [Dapr](https://dapr.io/).
- **Consistency**: With sometimes 10s or 100s of Micro Services, the SDK helps to easy version control and provides a stable Dapr Basis.
- **High performance**: Based on [FastAPI](https://fastapi.tiangolo.com/zh/). Enjoy all the benefits.
- **Integrated Scheduler**: Define Scheduler Tasks with natural language timings and dependencies.
- **Integrated Dashboard UI**: Admin and Optional Auth enabled Dashboard with CRUD Forms.
- **Integrated CRUD**: Generates CRUD Router and Admin Dashboard Forms based on SQLModel and SQLAlchemy.
- **Integrated Abstract Filesystem**: Agnostic Abstract Filesystem API which allows to use S3, GCS, Azure Datalake, your local FS, Youtube etc.
- **Integrated justpy WEB UI**: Integrated justpy UI Web Framework to MSAAPI, which allows simple adding of routes to justpy webpages functions.
- **Integrated Dict with Storage Backend**: Use Dict's with backend storage like redis.
- **Integrated Signals**: Use and handle Signals and Tasks.
- **Integrated Feature Management**: Feature switch management with conditions.
## Main Dependencies
- [FastAPI](https://fastapi.tiangolo.com/)
- [SQLModel](https://sqlmodel.tiangolo.com/)
combined with [SQLAlchemy](https://www.sqlalchemy.org/) and [Pydantic](https://pydantic-docs.helpmanual.io/), with all
their features .
- **msaUtils**: General utils for Microservices based on FastAPI like Profiler, Scheduler, Sysinfo, Healtcheck, Error Handling etc.
- **msaJustPyUI**: FastAPI adapted JustPy version for Integration of justpy UI Web Framework to msaAppService, which allows simple adding of routes to justpy webpages functions.
- **msaCRUD**: SQLModel/SQLAlchemy/FastAPI - DB Object CRUD/API Automation
- **msaFeature**: Feature switch management with conditions
- **msaServer**: Helper & Wrapper around Uvicorn/Gunicorn for FastAPI based apps
- **msaSignal**: Signals/Events for Starlette/FastAPI.
- **msaDocModels**: # MSA Document Pydantic Models and Schemas, used to store Parser, NLP, NLU and AI results for processed documents
- **msaStorageDict**: Dict with a Storage Backend like redis or Zookeeper
### Usage example is in the app module \_\_init\_\_.py
```python
# -*- encoding: utf-8 -*-
"""
Copyright (c) 2022 - U2D.ai / S.Welcker
"""
from typing import Optional, List
from sqlmodel import SQLModel
from msaSDK.admin.utils.fields import Field
from msaSDK.models.service import get_msa_app_settings
from msaSDK.service import MSAApp
async def test_timer_min():
app.logger.info("msaSDK Test Timer Async Every Minute")
def test_timer_five_sec():
app.logger.info("msaSDK Test Timer Sync 5 Second")
class TestArticle(SQLModel, table=True):
__table_args__ = {'extend_existing': True}
id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
title: str = Field(title='ArticleTitle', max_length=200)
description: Optional[str] = Field(default='', title='ArticleDescription', max_length=400)
status: bool = Field(None, title='status')
content: str = Field(title='ArticleContent')
class TestCategory(SQLModel, table=True):
__table_args__ = {'extend_existing': True}
id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
title: str = Field(title='ArticleTitle', max_length=200)
description: Optional[str] = Field(default='', title='ArticleDescription', max_length=400)
status: bool = Field(None, title='status')
content: str = Field(title='ArticleContent')
get_msa_app_settings.cache_clear()
settings = get_msa_app_settings()
settings.title = "u2d.ai - MSA/SDK MVP"
settings.version = "0.0.1"
settings.debug = True
app = MSAApp(settings=settings, auto_mount_site=True,
sql_models=[TestArticle, TestCategory],
contact={"name": "msaSDK", "url": "http://u2d.ai", "email": "[email protected]"},
license_info={"name": "MIT", "url": "https://opensource.org/licenses/MIT", })
app.scheduler.task("every 1 min", func=test_timer_min )
app.scheduler.task("every 5 sec", func=test_timer_five_sec )
app.logger.info("Initialized " + settings.title + " " + settings.version)
@app.on_event("startup")
async def startup():
app.logger.info("msaSDK Own Startup MSAUIEvent")
#app.mount_site()
@app.on_event("shutdown")
async def shutdown():
app.logger.info("msaSDK Own Shutdown MSAUIEvent")
if __name__ == '__main__':
pass
```
# Typical Run Log
## Interface Preview
#### Home Screen with System Info
- Open `http://127.0.0.1:8090/admin/` in your browser:
#### CRUD of SQLModels Screen
#### Login Screen
- Open `http://127.0.0.1:8090/admin/auth/form/login` in your browser:
#### OpenAPI Interactive Documentation (Swagger) Screen
- Open `http://127.0.0.1:8090/#/admin/docs` in your browser:
#### Profiler Screen
- Open `http://127.0.0.1:8090/#/admin/profiler` in your browser:
## License Agreement
- `msaSDK`Based on `MIT` open source and free to use, it is free for commercial use, but please show/list the copyright information about msaSDK 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 msaSDK, 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/*