Create JSON:API and Web App from database, with LogicBank -- 40X more concise, Python for extensibility.
Project description
Creates an executable API from a database:
API: swagger/OpenAPI and JSON:API compliant. Uses SAFRS , a modern approach that enables client applications to configure their own API to reduce network traffic.
Web App: a multi-page, multi-table web app; incorporates Flask AppBuilder and fab-quickstart.
Logic: spreadsheet-like rules for multi-table derivations and constraint that reduce transaction logic by 40X, using Logic Bank.
Usage
Installation
Install with pip:
cd ~/Desktop
mkdir server
cd server
virtualenv venv
source venv/bin/activate
# windows venv\Scripts\activate
pip install ApiLogicServer
Generation
This verifies proper install:
ApiLogicServer create --project_name=my_api_logic_server
cd my_api_logic_server # create / initialize the venv
virtualenv venv
source venv/bin/activate
# windows venv\Scripts\activate
pip install -r requirements.txt
More commonly, you would include the db_url parameter, a SQLAlchemy url designating the database used for creation.
You may also wish to include the open_with parameter, to open an IDE or Editor on the created project. For example, PyCharm (charm) will open the project and create / initialize the venv automatically (some PyCharm configuration may be required):
ApiLogicServer create --project_name=my_api_logic_server db_url=sqlite:///nw.sqlite --open_with=charm
Execution
python api_logic_server_run.py
python ui/basic_web_app/run.py
Features
API: SAFRS JSON:API and Swagger
Your API is available in swagger:
Basic Web App - Flask Appbuilder
Generated fab pages look as shown below:
Multi-page: apps include 1 page per table
Multi-table: pages include related_views for each related child table, and join in parent data
Favorite field first: first-displayed field is “name”, or contains “name” (configurable)
Predictive joins: favorite field of each parent is shown (product name - not product id)
Ids last: such boring fields are not shown on lists, and at the end on other pages
Customize your app by editing ui/basic_web_app/app/views.py.
Logic:
Logic is declared in Python (example below), and is:
Extensible: logic consists of rules (see below), plus standard Python code
Multi-table: rules like sum automate multi-table transactions
Scalable: rules are pruned and optimized; for example, sums are processed as 1 row adjustment updates, rather than expensive SQL aggregate queries
Manageable: develop and debug your rules in IDEs, manage it in SCS systems (such as git) using existing procedures
The following 5 rules represent the same logic as 200 lines of Python:
Declare your logic by editing logic/rules_bank.py
More information:
The github project includes documentation and examples.
Acknowledgements
Many thanks to
Thomas Pollet, for SAFRS
Daniel Gaspar, for Flask AppBuilder
Achim Götz, for design collaboration
Change Log
01/30/2021 - 1.02.03 - Flask AppBuilder fixes - Admin setup, class vs table names (wip)
01/28/2021 - 01.02.02: Command line cleanup
01/27/2021 - 01.02.0 - Many:
renamed logic/rules_bank to logic/logic_bank
improved error handling on introspection failures
building backrefs for relationships (with disambiguation)
project creation defaults to copy (vs git clone)
01/25/2021 - 01.01.01 - Preliminary fixes for MySQL - acknowledgements (and thanks!) to Thomas Pollet
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ApiLogicServer-1.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 292ba884f8b3d9d89cc71b2221a272497db88c589563bfba7eb46d49649ce9b5 |
|
MD5 | e7af86befcb76876f04b5baf7b25c407 |
|
BLAKE2b-256 | b2626ca95d2ea582869f286b77bd43a60cc47207001a7e5c060155a82da34644 |