hexed-notificator 0.4.0

A package for simplified push notification management.

Notificator

A developer-friendly package for simplified notification management across internal services. It provides a small domain model and async provider clients for sending email and SMS.

What It Provides

• Async notification clients for email (Mailgun) and SMS (Twilio).
• A shared NotificationContent value object for payload consistency.
• A NotificationClient protocol to make adapters testable and swappable.
• Template and non-template delivery workflows.

Getting Started

Install

# uv
uv add hexed-notificator

# pip
pip install hexed-notificator

Quickstart: Mailgun Email

import asyncio

from notificator import NotificationContent, EmailAddress
from notificator.mail import MailgunClient


async def main() -> None:
    mailing_client = MailgunClient(
        domain="<MAILGUN_DOMAIN>",
        api_key="<MAILGUN_API_KEY>",
        sender_email=EmailAddress("no-reply@<YOUR_DOMAIN>"),
        sender_display_name="Notificator",
        default_subject="Service Notification",
    )

    await mailing_client.notify(
        NotificationContent(body="Hello from Notificator!"),
        recipient=EmailAddress("[e-mail]"),
    )
    await mailing_client.aclose()


asyncio.run(main())

Quickstart: Twilio SMS

import asyncio

from notificator import NotificationContent, PhoneNumber
from notificator.sms import TwilioSmsClient, TwilioSmsTemplate


async def main() -> None:
    template_with_custom_versioning = TwilioSmsTemplate(
       id="shipping_status_template",  # Friendly name
       version_registry={"en": "temp123_1", "pl": "temp123_2"}  # Friendly version name -> sid mapping
    )
    sms_client = TwilioSmsClient(
        account_sid="<TWILIO_ACCOUNT_SID>",
        token="<TWILIO_AUTH_TOKEN>",
        sender_phone_number=PhoneNumber("[phone]"),
        templates=["temp_123_3", template_with_custom_versioning], # One plain template + a versioned template
    )

    await sms_client.notify(
        NotificationContent(body="Your verification code is 123456."),
        recipient=PhoneNumber("[phone]"),
    )
    
    await sms_client.notify_from_template(
       template="shipping_status_template",
       recipient=PhoneNumber("[phone]"),
       version="en",
       status="shipped",
       shipping_date="2026-03-01"
    )
    await sms_client.aclose()

asyncio.run(main())

Template Delivery

await mailing_client.notify_from_template(
    template="shipping_status_template",
    recipient=EmailAddress("[e-mail]"),
    order_id="1234",
    status="shipped",
)

Documentation

• Build docs: poe docs
• Serve docs locally: poe docs --serve
• API reference is generated via mkdocstrings.

Linting

Run poe lint to apply formatting and ensure docstrings and typing checks pass.

Contributing

Prerequisites

1. Generate an SSH key and add the SSH key to your GitHub account.

2. Configure SSH to automatically load your SSH keys:

   cat << EOF >> ~/.ssh/config
   
   Host *
     AddKeysToAgent yes
     IgnoreUnknown UseKeychain
     UseKeychain yes
     ForwardAgent yes
   EOF
   

3. Install Docker Desktop.

4. Install VS Code and VS Code's Dev Containers extension. Alternatively, install PyCharm.

5. Optional: install a Nerd Font such as FiraCode Nerd Font and configure VS Code or PyCharm to use it.

Development environments

The following development environments are supported:

1. ⭐️ GitHub Codespaces: click on Open in GitHub Codespaces to start developing in your browser.

2. ⭐️ VS Code Dev Container (with container volume): click on Open in Dev Containers to clone this repository in a container volume and create a Dev Container with VS Code.

3. ⭐️ uv: clone this repository and run the following from root of the repository:

   # Create and install a virtual environment
   uv sync --python 3.14 --all-extras
   
   # Activate the virtual environment
   source .venv/bin/activate
   
   # Install the pre-commit hooks
   pre-commit install --install-hooks
   

4. VS Code Dev Container: clone this repository, open it with VS Code, and run Ctrl/⌘ + ⇧ + P → Dev Containers: Reopen in Container.

5. PyCharm Dev Container: clone this repository, open it with PyCharm, create a Dev Container with Mount Sources, and configure an existing Python interpreter at /opt/venv/bin/python.

Developing

• This project follows the Conventional Commits standard to automate Semantic Versioning and Keep A Changelog with Commitizen.
• Run poe from within the development environment to print a list of Poe the Poet tasks available to run on this project.
• Run uv add {package} from within the development environment to install a run time dependency and add it to pyproject.toml and uv.lock. Add --dev to install a development dependency.
• Run uv sync --upgrade from within the development environment to upgrade all dependencies to the latest versions allowed by pyproject.toml. Add --only-dev to upgrade the development dependencies only.
• Run cz bump to bump the package's version, update the CHANGELOG.md, and create a git tag. Then push the changes and the git tag with git push origin main --tags.