Python SDK

pip install norq

from norq import Norq
 
notif = Norq()
 
# Send
result = notif.send("transactional/order-shipped",
    to={"email": "gaurav@example.com"},
    data={"user": {"first_name": "Gaurav"}, "order": {"id": "ORD-123"}},
)

notif = Norq(
    config="./norq.config.yaml",   # config file path
    binary_path="/usr/local/bin/norq",  # explicit binary path
    cwd="/path/to/project",           # working directory
    logger=my_logger,                 # structured logger
    recipient_resolver=my_resolver,   # user ID -> Recipient
)

result = notif.send("transactional/welcome",
    to={"email": "user@example.com"},
    data={"user": {"first_name": "Gaurav"}},
    channels=["email"],
    dry_run=False,
)
 
for r in result.results:
    print(f"{r.channel}: {'OK' if r.success else r.error}")
 
for s in result.skipped:
    print(f"Skipped {s.channel}: {s.reason}")

results = notif.lint()              # all
results = notif.lint("transactional/welcome")     # one
 
for result in results:
    for diag in result.diagnostics:
        print(f"{diag.severity}: {diag.message} [{diag.rule}]")

from norq.types import Recipient
 
recipient = Recipient(
    email="user@example.com",
    phone="+1234567890",
)
 
# Or pass a dict:
result = notif.send("transactional/welcome", to={"email": "user@example.com"}, data={...})

class MyResolver:
    def resolve(self, user_id: str) -> Recipient:
        user = db.users.get(user_id)
        return Recipient(email=user.email, phone=user.phone)
 
notif = Norq(recipient_resolver=MyResolver())
notif.send("transactional/welcome", to="user-123", data={...})

from norq.binary import NorqError
 
try:
    notif.send("transactional/welcome", to="user-123", data={...})
except NorqError as e:
    print(f"Norq error: {e}")

norq codegen --lang python --out src/generated/norq_types.py