wr-common-lib 0.1.6

Shared enums and optional PostgreSQL helpers for email workflows

wr-common-lib

Shared enums, attachment encoding helpers, and optional PostgreSQL write helpers for the email table.

PyPI	wr-common-lib
import	wr_common_lib

Requires Python 3.12+.

Install

pip install wr-common-lib
pip install "wr-common-lib[db]"   # adds async-db-tools

Package layout

src/wr_common_lib/
├── __init__.py          # __version__
└── email/
    ├── __init__.py      # public exports
    ├── constants.py     # MailFlow, MailStatus
    ├── encoding.py      # file_to_base64, file_to_attachment
    └── db_oper.py       # EmailDbOper, get_email_content_hash

Enums

MailFlow and MailStatus match PostgreSQL mail_flow / mail_status.

from wr_common_lib.email import MailFlow, MailStatus

MailFlow.INBOUND
MailStatus.PENDING.value

Status flows

Outbound:  PENDING → SENT | FAILED；webhook → DELIVERED | BOUNCED
Inbound:   RECEIVED → PARSED | PARSE_FAILED

Content hash

from wr_common_lib.email import get_email_content_hash

content_hash = get_email_content_hash(
    to="[e-mail],[e-mail]",
    subject="...",
    content="...",
    cc="",
    attachments=[{"filename": "report.pdf"}],
)

Normalizes to / cc (comma-separated), strips subject/content, and hashes attachment filenames only (not file bytes).

Attachment encoding

No [db] extra required. Converts local files to Base64 for Resend attachments[].content or queue tasks.

from wr_common_lib.email import file_to_base64, file_to_attachment

b64 = file_to_base64("/path/to/report.pdf")

att = file_to_attachment("/path/to/report.pdf")
# {"filename": "report.pdf", "content": "<base64>", "content_type": "application/pdf"}

att = file_to_attachment(
    "/path/to/data.bin",
    filename="custom.pdf",
    content_type="application/pdf",
)

EmailDbOper

Requires the [db] extra. Pass an async-db-tools PostgresPool (or compatible pool with fetchval / execute).

from wr_common_lib.email import EmailDbOper, MailFlow, MailStatus, get_email_content_hash

db_oper = EmailDbOper(pool)

Write operations only; reads should use db_oper._db directly (e.g. fetchrow, fetchval).

insert_email

email_id, created = await db_oper.insert_email(
    task,
    MailFlow.OUTBOUND,
    MailStatus.PENDING,
)
# created is True when a new row was inserted, False when content_hash already existed

Task fields (inbound and outbound use the same shape):

Field	Required	Notes
imo	yes
voyage_id	yes	UUID string
mail_from	yes	Sender
to	yes	Recipients (comma-separated allowed)
cc	no	Default ""
subject	no	Default ""
content	no	Default ""
attachments	no	List of dicts with filename
content_hash	no	Computed via get_email_content_hash when omitted
created_user_id	no	Outbound only

Stored as DB columns mail_to, mail_cc, attachment (jsonb).

On duplicate content_hash, the insert is skipped (ON CONFLICT DO NOTHING); the existing row id is returned and created is False.

Example:

task = {
    "imo": 1234567,
    "voyage_id": "550e8400-e29b-41d4-a716-446655440000",
    "mail_from": "[e-mail]",
    "to": "[e-mail]",
    "cc": "",
    "subject": "Noon report",
    "content": "...",
    "attachments": [],
}

email_id, created = await db_oper.insert_email(
    task, MailFlow.INBOUND, MailStatus.RECEIVED
)

update_status

await db_oper.update_status(email_id, MailStatus.SENT)
await db_oper.update_status(email_id, MailStatus.DELIVERED)
await db_oper.update_status(email_id, MailStatus.FAILED)

update_parsed_data

Sets mail_status to PARSED and writes parsed_data (jsonb).

await db_oper.update_parsed_data(email_id, {"parsed": "..."})

Dependencies

install	brings in
wr-common-lib	enums, get_email_content_hash, file_to_base64, file_to_attachment
wr-common-lib[db]	above + async-db-tools (for EmailDbOper)

Your application owns the database URL and pool lifecycle.

Publish

pip install -e ".[db]"

# 1. Update CHANGELOG.md for the new version
# 2. Bump version and publish
uv version 0.1.7
export UV_PUBLISH_TOKEN=pypi-...
uv build && uv publish

git tag v0.1.7 && git push --tags   # optional: GitHub Release notes from CHANGELOG

PyPI does not allow re-uploading the same version.

License

MIT — see LICENSE.