Skip to content

Commit

Permalink
Merge pull request #14 from swelcker/0.2.5
Browse files Browse the repository at this point in the history
## 0.2.5
* Switched from local packages to msa* packages
* Updated dashboard template, switched to amis version 2.3.0 from 1.10.2 and from local js/css to unpkg.com cdn
* BugFix: Solved language issues for the sdk based message popup's
  • Loading branch information
swelcker authored Oct 4, 2022
2 parents 5a5c27d + 5b9f306 commit c640a2f
Show file tree
Hide file tree
Showing 239 changed files with 528 additions and 327,106 deletions.
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
dist/* linguist-documentation
docs/* linguist-documentation
docs_dist_site/* linguist-documentation
dist_docs/* linguist-documentation
msaSDK/msastatic/* linguist-vendored
*.html linguist-detectable=false
*.js linguist-detectable=false
Expand Down
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="http://msa.u2d.ai/images/msa_logo_big.png?raw=true" alt="MSA SDK image"/>
<img src="http://logos.u2d.ai/msaSDK_logo.png?raw=true" alt="MSA SDK image"/>
</p>

------
Expand Down Expand Up @@ -35,14 +35,22 @@
- **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

Expand Down Expand Up @@ -155,7 +163,7 @@ if __name__ == '__main__':

## License Agreement

- `msaSDK`Based on `MIT` open source and free to use, it is free for commercial use, but please clearly show the copyright information about msaSDK - Auth Admin in the display interface.
- `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
Expand Down
7 changes: 7 additions & 0 deletions docs/css/mkdocstrings.css
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@
content: 'Page ' counter(page);
}
}
/* logo. */
.md-header__button.md-logo :-webkit-any(img,svg) {
fill: currentcolor;
display: block;
height: 2.2rem;
width: auto;
}
/* Indentation. */
div.doc-contents:not(.first) {
padding-left: 25px;
Expand Down
Binary file added docs/images/msaSDK_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/msa_logo_big.png
Binary file not shown.
14 changes: 11 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="http://msa.u2d.ai/images/msa_logo_big.png?raw=true" alt="MSA SDK image"/>
<img src="http://logos.u2d.ai/msaSDK_logo.png?raw=true" alt="MSA SDK image"/>
</p>

------
Expand All @@ -25,20 +25,28 @@
- **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 Dashboard UI**: Admin and Optional Auth enabled Dashboard with CRUD Forms based on `fastapi-amis-admin`.
- **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
Expand Down
23 changes: 15 additions & 8 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
# Release Notes
## Possible future features:
* Add examples for Admins Pages and additional features of the Admin and auth module
* versioning? FastAPI versioning
* camel case support FastAPI-CamelCase
* Feature Flags: Own Implementation Boolean, Multivariates, Temporary, Permanent, PaidUsers, ClosedBeta, PercentageOfUsers, Experimental, DefaultFallbackHandler=func, ConditionalFeature
* Feature Switch with Conditions based on Pydantic Models, switch can have conditions or just on/of and conditions cheack against an existing pydantic or sqlmodel
* fastapi_socketio?
* Events lib? FastApi Events or FastAPI Websocket Pub/Sub fastapi-cloudevents? Webhook receive? Seems we need a combination of some
## Next release:
* New msaAdmin integration, with Admin, AuthAdmin and new Scheduler which supports Dashboard

## 0.2.5
* Switched from local packages to msa* packages
* Updated dashboard template, switched to amis version 2.3.0 from 1.10.2 and from local js/css to unpkg.com cdn
* BugFix: Solved language issues for the sdk based message popup's

## 0.1.6
* bug fixed with profiler
* bug fixed within sdk.js = was wrong version
* added script folder
* renamed docs dist folder
* added docs_src (todo move all sources there)
* fixed bug in features and deleted mappings as we don't want to define our models twice

## 0.1.5
* Cleaned Static Files
Expand Down
Binary file removed docs/saved_req_package_pip_info.pkl
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/sites/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ class TestCategory(SQLModel, table=True):
# get the MSA app setting, clear the cache, set some settings
get_msa_app_settings.cache_clear()
settings = get_msa_app_settings()
settings.title = "SPK.ai - MSA/SDK MVP"
settings.version = "SPK.0.0.1"
settings.title = "u2d.ai - MSA/SDK MVP"
settings.version = "MSA.0.0.1"
settings.debug = True

# Create some timers with a MSATimer instance, define the interval and set the handler
Expand Down
2 changes: 1 addition & 1 deletion docs/sites/amis.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Building a parser that can generate a JSON for a UI seemed pretty straight forwa
Here an example:

=== "UI"
![Smis Schema Example](../images/msa_amis_schema_example.png)
![Amis Schema Example](../images/msa_amis_schema_example.png)
=== "JSON"
```python
{
Expand Down
4 changes: 2 additions & 2 deletions docs/sites/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ from msaSDK.service import MSAApp
# get the MSA app setting, clear the cache, set some settings
get_msa_app_settings.cache_clear()
settings = get_msa_app_settings()
settings.title = "SPK.ai - MSA/SDK MVP"
settings.version = "SPK.0.0.1"
settings.title = "u2d.ai - MSA/SDK MVP"
settings.version = "MSA.0.0.1"
settings.debug = True
settings.site_auth = True

Expand Down
7 changes: 6 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ theme:
icon: material/brightness-4
name: Switch to light mode

logo: '../images/msa_logo_big.png'
logo: 'http://logos.u2d.ai/msaSDK_logo.png'
favicon: '../images/favicon.png'
features:
- navigation.tabs
Expand Down Expand Up @@ -138,6 +138,11 @@ markdown_extensions:
alternate_style: true

# extras
extra:
analytics:
provider: google
property: G-06Q4RT8KC2

extra_css:
- css/mkdocstrings.css

Expand Down
4 changes: 1 addition & 3 deletions msaSDK/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@
import glob
from os.path import basename, dirname, isfile, join

import msaSDK.jpui.justpy as justpy

version = "0.1.6"
version = "0.2.5"
__author__ = "Stefan Welcker"
__copyright__ = "Copyright 2022, U2D.ai"
__license__ = "MIT"
Expand Down
2 changes: 1 addition & 1 deletion msaSDK/admin/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"zh_CN": gettext.translation(
domain="messages",
localedir=os.path.join(BASE_DIR, "locale"),
languages=["zh_CN"],
languages=["en_US"],
)
}
)
Loading

0 comments on commit c640a2f

Please sign in to comment.