Skip to content

Getting Started

Installation

Install promptstore using pip:

pip install promptstore

Basic Usage

Create a store and add some prompts:

from promptstore import PromptStore

# Create a store
store = PromptStore("./prompts")

# Add a prompt template
prompt = store.add(
    name="example",
    content="Write a {{language}} function that {{task}}",
    namespace="project1",
    description="Code generation prompt",
    tags=["coding", "generation"],
    subset="subproject1"
)

# Use the prompt
filled = prompt.fill({
    "language": "Python",
    "task": "sorts a list in reverse order"
})

# Export to markdown (variables will be highlighted)
markdown = prompt.to_markdown()
print(markdown)
# Output shows the prompt with **`{{language}}`** and **`{{task}}`** highlighted

Variable Highlighting

When the prompts are stored, they are saved in markdown format where template variables are automatically highlighted with bold code formatting ({{variable}}), making them stand out visually. This is especially useful when:

  • Reviewing prompts in markdown viewers or editors
  • Sharing prompts with team members
  • Documenting your prompt templates
  • Identifying which parts of the prompt need to be filled

The highlighting is automatically removed when loading prompts from markdown, so your templates work seamlessly.

Using Prompts

PromptStore provides a simple Hugging Face-like identifier to manage and use prompts. For that simply use the get method indicating the prompt by its name, namespace, and subset:

# Add a prompt template
prompt = store.get("namespace/name@subset")

Old way to get and use prompts is by checking the UUID:

```python

Fill a prompt template

prompt = store.get("prompt-uuid") result = prompt.fill({ "language": "Python", "task": "sorts a list in ascending order" })

Next Steps

Check out the User Guide for more detailed information about using PromptStore.