feat: add reference fields

README.md

@@ -9,4 +9,18 @@ Import DMAP data into a PostgreSQL database
 * run `docker-compose build` to build the docker images for local testing
     * run `docker-compose up dmap_local_rds` to stand up a local postgres db
         * this imnage could be used when running pytest
-    * run `docker-compose up dmap_importer` to run the importer application
+    * run `docker-compose up dmap_import` to run the importer application
+
+### Outside of Docker
+
+1. Navigate to repository directory.
+2. Update `.env` variable. Source it `source .env`.
+3. Run `poetry run start` to run the ingestion process.
+4. Run `psql postgresql://postgres:[email protected]:5432/dmap_importer` to get into the database. Alternatively, after `docker-compose up`, you can:
+    1. `docker exec -it dmap_local_rds bash` 
+    2. `psql -U postgres -d dmap_importer`
+5. Run format, type and lint checker:
+    * `poetry run black .`
+    * `poetry run mypy .`
+    * `poetry run pylint src tests`
+6. Run tests, `poetry run pytest`.

src/alembic/versions/002_0d3bf1348c58_new_reference_org_name_columns.py

@@ -0,0 +1,34 @@
+"""new reference org name columns
+
+Revision ID: 0d3bf1348c58
+Revises: d630193252db
+Create Date: 2024-06-01 22:10:22.189820
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = "0d3bf1348c58"
+down_revision: Union[str, None] = "d630193252db"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    op.add_column(
+        "use_transaction_longitudinal", sa.Column("reference", sa.String())
+    )
+    op.add_column(
+        "use_transaction_location", sa.Column("reference", sa.String())
+    )
+    op.add_column("sale_transaction", sa.Column("reference", sa.String()))
+
+
+def downgrade() -> None:
+    op.drop_column("use_transaction_longitudinal", "reference")
+    op.drop_column("use_transaction_location", "reference")
+    op.drop_column("sale_transaction", "reference")

src/dmap_import/schemas/sale_transaction.py

@@ -182,3 +182,4 @@ class SaleTransaction(SqlBase):
     discount_amount = sa.Column(sa.BigInteger, nullable=True)
     _exported_dtm = sa.Column(sa.DateTime, nullable=True)
     promotion_id = sa.Column(sa.String(), nullable=True)
+    reference = sa.Column(sa.String(), nullable=True)

src/dmap_import/schemas/use_transaction_location.py

@@ -157,3 +157,4 @@ class UseTransactionalLocation(SqlBase):
     fare_rule_description = sa.Column(sa.String(), nullable=True)
     _exported_dtm = sa.Column(sa.DateTime, nullable=True)
     promotion_id = sa.Column(sa.String(), nullable=True)
+    reference = sa.Column(sa.String(), nullable=True)

src/dmap_import/schemas/use_transaction_longitudinal.py

@@ -155,3 +155,4 @@ class UseTransactionalLongitudinal(SqlBase):
     fare_rule_description = sa.Column(sa.String(), nullable=True)
     _exported_dtm = sa.Column(sa.DateTime, nullable=True)
     promotion_id = sa.Column(sa.String(), nullable=True)
+    reference = sa.Column(sa.String(), nullable=True)