Skip to content

Commit cf0a2f9

Browse files
committed
Add example READMEs
1 parent 9d0103b commit cf0a2f9

File tree

3 files changed

+57
-0
lines changed

3 files changed

+57
-0
lines changed

examples/alembic/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Instructions
2+
3+
1. Install package and dependencies
4+
```bash
5+
$ pip install sqlalchemy-postgresql-audit
6+
$ pip install psycopg2
7+
$ pip install alembic
8+
$ pip install -e test-app
9+
10+
2. Run
11+
12+
```bash
13+
$ docker-compose up -d
14+
15+
3. Run
16+
17+
```bash
18+
$ alembic upgrade head
19+
20+
4. Database now has tables, audit tables, and triggers.

examples/plugin/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Instructions
2+
3+
1. Install package and dependencies
4+
```bash
5+
$ pip install sqlalchemy-postgresql-audit
6+
$ pip install psycopg2
7+
8+
2. Run
9+
10+
```bash
11+
$ docker-compose up -d
12+
13+
3. Run
14+
15+
```bash
16+
$ python plugin.py
17+
18+
4. Database now has tables, audit tables, and triggers.
19+

examples/simple/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Instructions
2+
3+
1. Install package and dependencies
4+
```bash
5+
$ pip install sqlalchemy-postgresql-audit
6+
$ pip install psycopg2
7+
8+
2. Run
9+
10+
```bash
11+
$ docker-compose up -d
12+
13+
3. Run
14+
15+
```bash
16+
$ python simple.py
17+
18+
4. Database now has tables, audit tables, and triggers.

0 commit comments

Comments
 (0)