AUDIT FOR SQLAlchemy and Mongoengine

Library for auditing models made with SQLAlchemy and Mongoengine. This library exposes a signal which you can use to add your custom method.

Instalation

Use following command:

pip install package-audit-flask

Usage

This library exposes a signal which you can use to add your custom method, this method receives kwargs where predefined arguments will arrive.

How is it used in SQLAlchemy?

Import library and then "Register" your model using the keep_logs_models method, as follows:"

from fk_audit_flask.audit.sqlalchemy import sqlalchemy

class Model:
    ...

sqlalchemy.keep_logs_models(Model)

Then, conect the "signal" signal with your custom method

def custom_method(*args, **kwargs):
    ...

sqlalchemy.signal.connect(custom_method)

Kwargs in your custom method

If SETTINGS.HEADERS = FALSE

If SETTINGS.HEADERS = True

Same as above, with two additional keys.

Additional configuration

• If you have a key that you need to extract for the user kwargs, add the keys in the SETTINGS.USER_VALIDATE_HEADERS configuration by default you have assigned: ['X-User-Id', 'X-Auth-User-Id'].
• If you do not want to get the kwargs remote_addr and user, asgine SETTINGS.HEADERS = False

Dependencies

• flask>=2.2.5 # If SETTINGS.HEADERS = True, deafult is True
• blinker>=1.4
• mongoengine>=0.23.1
• sqlalchemy>=1.4.52

License

MIT

Authors

• @jrosalesmeza