diff --git a/examples/alembic/README.md b/examples/alembic/README.md new file mode 100644 index 0000000..054225e --- /dev/null +++ b/examples/alembic/README.md @@ -0,0 +1,20 @@ +# Instructions + +1. Install package and dependencies + ```bash + $ pip install sqlalchemy-postgresql-audit + $ pip install psycopg2 + $ pip install alembic + $ pip install -e test-app + +2. Run + + ```bash + $ docker-compose up -d + +3. Run + + ```bash + $ alembic upgrade head + +4. Database now has tables, audit tables, and triggers. diff --git a/examples/plugin/README.md b/examples/plugin/README.md new file mode 100644 index 0000000..4dead54 --- /dev/null +++ b/examples/plugin/README.md @@ -0,0 +1,19 @@ +# Instructions + +1. Install package and dependencies + ```bash + $ pip install sqlalchemy-postgresql-audit + $ pip install psycopg2 + +2. Run + + ```bash + $ docker-compose up -d + +3. Run + + ```bash + $ python plugin.py + +4. Database now has tables, audit tables, and triggers. + diff --git a/examples/simple/README.md b/examples/simple/README.md new file mode 100644 index 0000000..45787a4 --- /dev/null +++ b/examples/simple/README.md @@ -0,0 +1,18 @@ +# Instructions + +1. Install package and dependencies + ```bash + $ pip install sqlalchemy-postgresql-audit + $ pip install psycopg2 + +2. Run + + ```bash + $ docker-compose up -d + +3. Run + + ```bash + $ python simple.py + +4. Database now has tables, audit tables, and triggers.