diff --git a/docs/data-dictionary.md b/docs/data-dictionary.md new file mode 100644 index 000000000..392fae5c9 --- /dev/null +++ b/docs/data-dictionary.md @@ -0,0 +1,17 @@ +# notify.gov Data Dictionary + +This document serves as a comprehensive guide to the data structure of notify.gov. It outlines the key data elements, their types, and relationships within the system. From user information to message details, this data dictionary is a valuable resource for understanding and maintaining the underlying data model of this application. Use this guide to ensure consistency, clarity, and effective management of the data that powers our messaging functionality. + +# Table: Global + +| Field | Type | Length | Description | +|-------------------------------------|-----------|--------|------------------------------------------------------------------| +| service_id | Integer | | Service ID - reference for most data related to a service | + + +## Table: Dashboard + +| Field | Type | Length | Description | +|-------------------------------------|-----------|--------|--------------------------------------------| +| global_message_limit | Integer | | Message limit set by platform admin | +| daily_global_messages_remaining | Integer | | Remaining messages in database | diff --git a/poetry.lock b/poetry.lock index 64108e397..54e2b2c50 100644 --- a/poetry.lock +++ b/poetry.lock @@ -2410,7 +2410,7 @@ files = [ {file = "msgpack-1.0.8-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5fbb160554e319f7b22ecf530a80a3ff496d38e8e07ae763b9e82fadfe96f273"}, {file = "msgpack-1.0.8-cp39-cp39-win32.whl", hash = "sha256:f9af38a89b6a5c04b7d18c492c8ccf2aee7048aff1ce8437c4683bb5a1df893d"}, {file = "msgpack-1.0.8-cp39-cp39-win_amd64.whl", hash = "sha256:ed59dd52075f8fc91da6053b12e8c89e37aa043f8986efd89e61fae69dc1b011"}, - {file = "msgpack-1.0.8-py3-none-any.whl", hash = "sha256:24f727df1e20b9876fa6e95f840a2a2651e34c0ad147676356f4bf5fbb0206ca"}, + {file = "msgpack-1.0.8.tar.gz", hash = "sha256:95c02b0e27e706e48d0e5426d1710ca78e0f0628d6e89d5b5a5b91a5f12274f3"}, ] [[package]] @@ -4695,4 +4695,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.12.2" -content-hash = "4146fba7b1b851dfdca41511a2e7239ed11999b293fa7312c5d57a296a375fd5" +content-hash = "9aa9831a1e257899f1504bc7b252f796fa0beaf51367e4c43a3d6de4108d5f54" diff --git a/pyproject.toml b/pyproject.toml index 0309642fb..7f03f943c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -50,6 +50,7 @@ python-dotenv = "==1.0.0" sqlalchemy = "==1.4.40" werkzeug = "^3.0.1" faker = "^23.3.0" +setuptools = "^69.2.0" [tool.poetry.group.dev.dependencies]