Add example of setting session vars with a session, engine, and conne…

docs/source/index.rst

@@ -10,6 +10,7 @@ SQLAlchemy Postgresql Audit
    example
    alembic-integration
    naming-conventions
+   session-settings
    contributing
    roadmap
    contributors

docs/source/session-settings.rst

@@ -0,0 +1,42 @@
+Session Settings
+----------------
+
+In order to enrich the audit tables with information, we can set session settings that live for the duration of a transaction.
+
+
+**SQLAlchemy Session**
+
+.. code-block:: python
+
+    from sqlalchemy_postgresql_audit import set_session_vars
+    from sqlalchemy.orm import sessionmaker
+
+    Session = sessionmaker(bind=engine)
+    session = Session()
+
+    set_session_vars(session, username='huntcsg')
+    session.execute(insert_stmt, { ... values ... })
+    session.commit()
+
+
+
+**SQLAlchemy Connection**
+
+.. code-block:: python
+
+    from sqlalchemy_postgresql_audit import set_session_vars
+
+    with engine.connect() as conn:
+        with conn.begin() as trans:
+            set_session_vars(conn, username='huntcsg')
+            conn.execute(insert_stmt, { ... values ... })
+
+
+**SQLAlchemy Engine**
+
+.. code-block:: python
+
+    from sqlalchemy_postgresql_audit import set_session_vars
+    with engine.begin() as conn:
+        set_session_vars(conn, username='huntcsg')
+        conn.execute(insert_stmt, { ... values ... })

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.

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.
+

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.