Skip to main content

Natural Language Template engine — plain-English templates for email, notifications, and dynamic content

Project description

pyrx-nlt

Natural Language Template (NLT) Engine — Plain-English templates that non-technical teams can read, write, and maintain for email, notifications, and dynamic content.

Installation

pip install pyrx-nlt

Requires Python 3.10+. Zero third-party dependencies.

Quick Start

from pyrx_nlt import NLTRenderer

renderer = NLTRenderer(
    contact={"first_name": "Alice", "properties": {"Plan": "premium", "Points": 1250}},
    trigger_event={"event_name": "purchase", "attributes": {"Item": "Widget", "Amount": "49.99"}},
)

result = renderer.render(
    subject_template='Order confirmation for {the user\'s First Name, or "Customer"}',
    body_template="""
        <h1>Thank you, {the user's First Name}!</h1>
        <p>You purchased: {the Item from the trigger event}</p>
        <p>Amount: {the Amount from the trigger event, as "currency"}</p>
        {if the user's Plan is premium}
            <p>You earned {the user's Points, as "currency"} in rewards!</p>
        {else}
            <p>Upgrade to Premium for rewards on every purchase.</p>
        {end if}
    """,
)

print(result.html)      # Rendered HTML
print(result.subject)   # "Order confirmation for Alice"
print(result.suppressed) # False

Features

  • 3 data sources: {the user's X}, {the X from the trigger event}, {the X from the Y event}
  • Modifiers: or "fallback", required, as "format", uppercase/lowercase/titlecase
  • Math: plus, minus, times, divided by, modulo
  • Conditionals: {if}...{else if}...{else}...{end if} with 20 comparison operators, AND/OR/NOT
  • Loops: {for item in source}...{end for} with loop.index, loop.first, loop.last
  • Lists: {list source, as comma/ordered/unordered list}
  • Tables: {table source with columns: A, B, C}
  • Aggregates: {sum of}, {average of}, {count of}
  • 19 chainable filters: truncate, replace, url_encode, round, default, strip_html, trim, newline_to_br, split, join, first, last, length, sort, reverse, unique, where, map, slice
  • Formatting: 17 currency codes, date presets, custom date tokens, percentages
  • Variable assignment: {set x to expression}
  • Ternary: {condition ? "true" : "false"}
  • Comments: {# ignored #}
  • Raw blocks: {raw}...{end raw}
  • Macros: {define name(params)}...{end define} / {use name(args)}
  • Template inheritance: {extends "base.html"} / {block name}...{end block} / {parent}
  • Built-in variables: {today}, {now}
  • XSS-safe: All output HTML-escaped by default
  • Graceful degradation: Unparseable expressions preserved as literal text

Extension Points

from pyrx_nlt import NLTRenderer, EventStore, TemplateLoader

class MyEventStore:
    """Implement to look up historical events for named event resolution."""
    async def get_latest(self, contact_id: str, event_name: str) -> dict | None:
        ...

class MyTemplateLoader:
    """Implement for template inheritance ({extends "base.html"})."""
    def load(self, template_name: str) -> str | None:
        ...

renderer = NLTRenderer(
    contact=contact_data,
    event_store=MyEventStore(),
    template_loader=MyTemplateLoader(),
)

Jinja2 Migration

Built-in bidirectional converter for migrating from Jinja2/MoEngage templates:

from pyrx_nlt.converter import convert_jinja2_to_nlt, convert_nlt_to_jinja2, detect_template_language

nlt_template, result = convert_jinja2_to_nlt(jinja2_template)
print(f"Converted {result.count} expressions")

language = detect_template_language(template)  # "nlt", "jinja2", "mixed", or "none"

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyrx_nlt-1.1.3.tar.gz (177.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyrx_nlt-1.1.3-py3-none-any.whl (53.0 kB view details)

Uploaded Python 3

File details

Details for the file pyrx_nlt-1.1.3.tar.gz.

File metadata

  • Download URL: pyrx_nlt-1.1.3.tar.gz
  • Upload date:
  • Size: 177.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyrx_nlt-1.1.3.tar.gz
Algorithm Hash digest
SHA256 afe97afdc644a503d814649379c883ede3ec76512520014fb883caf1bf7b5f46
MD5 174f33ab4fe0822219df46790aa250fc
BLAKE2b-256 d226011a274e728168bf10a5dbf5e343a5cc5378ef4830db5165e1d8efae2955

See more details on using hashes here.

File details

Details for the file pyrx_nlt-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: pyrx_nlt-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 53.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyrx_nlt-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e15460e222577fa4bfdff6bba08e3d35d05a5a87af45e22014a1fdedb57610f3
MD5 a7de3cc4e737e18f8f23f5ce5f07559e
BLAKE2b-256 254e498e7c8158cd678130f965221c0ad5635e1af8af06b9ed2253ca1449bf3d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page