newjerseystyle / litepolis Goto Github PK

Document and docstring should be checked and rendered before merge into main branch

A good service should have loggings for admin, maintain, debug and update

An example can be:
Adding python logging to FastApi endpoints

This feature must be available in beta release

Options for rate limit:

• fastapi-limiter requires Redis
• fastapi-rate-limiter based on middleware

Web application firewall (WAF) should work too
but I have not study which and how to configure
WAF for brutal force API key / DDoS.
It will take me some time

mysql-connector-python used in this module seem to be a bad idea
for the performance should change to mysqlclient in later version.
Benchmark reference here.

Also the implementation of connector may not be thread safe right now,
need to improve

For better documentation and simplify developers for developing other front end solution to replace existing Streamlit user interface, a SDK for TypeScript should be developed and the Swagger UI should be tested and enhanced in documentation, many data structure in the FastAPI API endpoint implementations are still unclear which may be a roadblock for other develoepr. It has to be clean up before Beta release

The existing solution is not good enough and not secure

Review and consider OpenID solution with OIDC server.
Check out A Python OpenID Connect implementation
the OIC library

it will be at the end of the data pipeline

developers using db.py do not know DB structure, db.py should encapsulate the return value