Skip to main content

philiprehberger-prompt-builder

Tests PyPI version Last updated

Type-safe prompt template builder for LLM APIs.

Installation

pip install philiprehberger-prompt-builder

Usage

from philiprehberger_prompt_builder import Prompt

messages = (
    Prompt()
    .system("You are a helpful assistant.")
    .user("Summarize this article: {article}")
    .render(article="Long article text here...")
)
# [{"role": "system", "content": "You are a helpful assistant."},
#  {"role": "user", "content": "Summarize this article: Long article text here..."}]

Few-Shot Examples

from philiprehberger_prompt_builder import Prompt

messages = (
    Prompt()
    .system("Classify the sentiment.")
    .example(user="I love this!", assistant="positive")
    .example(user="Terrible product.", assistant="negative")
    .user("{text}")
    .render(text="Pretty good actually")
)

Batch Few-Shot Examples

from philiprehberger_prompt_builder import Prompt

messages = (
    Prompt()
    .system("Translate English to French.")
    .with_examples([
        ("Hello", "Bonjour"),
        ("Goodbye", "Au revoir"),
        ("Thank you", "Merci"),
    ])
    .user("{text}")
    .render(text="Good morning")
)

Output Format Instructions

from philiprehberger_prompt_builder import Prompt

# Request JSON output
messages = (
    Prompt()
    .system("Extract structured data.")
    .user("Parse: {text}")
    .expect_json(description='{"name": string, "age": number}')
    .render(text="John is 30 years old")
)

# Request list output
messages = (
    Prompt()
    .system("Generate ideas.")
    .user("List 5 project ideas about {topic}")
    .expect_list()
    .render(topic="machine learning")
)

Conditional Content

from philiprehberger_prompt_builder import Prompt

use_examples = True

messages = (
    Prompt()
    .system("You are a helpful assistant.")
    .conditional(use_examples, "user", "Here are some examples...")
    .conditional(use_examples, "assistant", "I understand the examples.")
    .user("Now answer my question: {question}")
    .render(question="What is Python?")
)

Prompt Composition

from philiprehberger_prompt_builder import Prompt

preamble = Prompt().system("You are a coding assistant.").user("Use Python 3.12+.")
task = Prompt().user("Write a function that {task}")

combined = preamble.merge(task)
messages = combined.render(task="sorts a list")

Reusable Templates

from philiprehberger_prompt_builder import PromptTemplate

summarizer = PromptTemplate(
    system="You are a {tone} summarizer. Output in {format}.",
    user="Summarize: {content}",
    defaults={"tone": "concise", "format": "bullet points"},
)

messages = summarizer.render(content="Article text...")
messages = summarizer.render(content="...", tone="detailed", format="paragraphs")

verbose = summarizer.extend(tone="thorough", format="essay")

Prompt Versioning

from philiprehberger_prompt_builder import Prompt, PromptVersionStore

store = PromptVersionStore()

v1 = Prompt().system("You are helpful.").user("Answer: {question}")
store.save("v1", v1)

v2 = Prompt().system("You are a concise expert.").user("Answer briefly: {question}")
store.save("v2", v2)

prompt = store.load("v1")
messages = prompt.render(question="What is Python?")

store.list_versions()  # ["v1", "v2"]

Token Estimation

from philiprehberger_prompt_builder import Prompt

prompt = Prompt().system("You are helpful.").user("{text}")
estimated = prompt.estimate_tokens(text="Hello world")

Inspecting prompt state

from philiprehberger_prompt_builder import Prompt

p = Prompt()
p.is_empty()  # True
p.role_counts()  # {}

p.system("Be helpful.").user("Hi").user("Still there?").assistant("Yes!")
p.is_empty()  # False
p.role_counts()  # {"system": 1, "user": 2, "assistant": 1}

# Sanity-check a long conversation
counts = p.role_counts()
assert counts.get("user", 0) == counts.get("assistant", 0) + 1

Context-Window Warnings

prompt = Prompt().user("very long input...")

warnings = prompt.warn_if_over(limit=8192)
for w in warnings:
    print("WARN:", w)

Returns warning strings (not exceptions) when the estimated token count is approaching or exceeds the limit, so callers can decide whether to truncate, summarise, or proceed.

API

Function / Class Description
Prompt Fluent builder for constructing LLM message lists
.system(content) Add a system message
.user(content) Add a user message
.assistant(content) Add an assistant message
.message(role, content) Add a message with any role
.example(user, assistant) Add a few-shot example pair
.with_examples(examples) Add multiple few-shot examples from a list of (input, output) tuples
.expect_json(description) Append instruction requesting JSON output
.expect_list(description) Append instruction requesting list output
.conditional(include, role, content) Conditionally add a message if include is truthy
.merge(other) Create a new Prompt combining messages from self and other
.render(**kwargs) Render with variable substitution, returns list of dicts
.render_messages(**kwargs) Render and return Message objects
.estimate_tokens(**kwargs) Approximate token count using word heuristics
.warn_if_over(limit, **kwargs) List warnings when estimated tokens approach or exceed limit
.role_counts() Dict mapping each role to the number of messages with that role
.is_empty() Return True if no messages have been added
PromptTemplate Reusable prompt template with default values
.extend(**overrides) Create a new template with updated defaults
PromptVersionStore Store and retrieve named prompt versions
.save(name, prompt) Save a prompt snapshot under a name
.load(name) Retrieve a stored prompt version by name
.list_versions() List all stored version names
.delete(name) Delete a stored prompt version
Message A single message with role and content

Development

pip install -e .
python -m pytest tests/ -v

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT

Metadata

Release files for philiprehberger-prompt-builder 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for philiprehberger-prompt-builder 0.5.0
File Size Uploaded Provenance
philiprehberger_prompt_builder-0.5.0.tar.gz 181.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for philiprehberger-prompt-builder 0.5.0
File Interpreter ABI Platform
philiprehberger_prompt_builder-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 190.2 kB

Release files / philiprehberger_prompt_builder-0.5.0.tar.gz

Download URL philiprehberger_prompt_builder-0.5.0.tar.gz
Size 181.7 kB
Tags Source
SHA-256 checksum
How to use checksums
1632cbd72093cee1252c54031300371215a3716e86ea3cd81ccd2705964c2c6e
BLAKE2b-256 checksum
How to use checksums
faf10a1c359d25e7b31d163cd0194fc58fa733526c5f71d1a7271f69386013ac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release files / philiprehberger_prompt_builder-0.5.0-py3-none-any.whl

Download URL philiprehberger_prompt_builder-0.5.0-py3-none-any.whl
Size 8.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1c6a4157076eeb3ef410a30f840cad10248cf7ba73e27f0d06a82f145cd21f12
BLAKE2b-256 checksum
How to use checksums
c949a4009442c57c69e80fc8b9d979d07946751efc16a2135103322207782eb3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Security for philiprehberger-prompt-builder 0.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page