Skip to main content

A Python library to optimize prompt drafts using LLMs

Project description

🧠 leo-prompt-optimizer

leo-prompt-optimizer is a Python library that helps developers optimize raw LLM prompts into structured, high-performance instructions using real LLM intelligence.

It supports both Groq (LLaMA, Mixtral, etc.) and OpenAI (GPT-3.5, GPT-4) — making it fast, flexible, and production-ready.


🚀 Features

  • 🛠️ Refines vague, messy, or unstructured prompts
  • 🧠 Follows a 9-step prompt engineering framework
  • 🧩 Supports contextual optimization (with user input & LLM output)
  • 🔁 Works with both Groq and OpenAI
  • ⚡ Blazing-fast open models via Groq
  • 🔐 Secure API key management with .env or helper functions
  • 🎛️ Lets users pick the model (gpt-4, llama3-70b, etc.)

📦 Installation

pip install leo-prompt-optimizer

🔧 Setup: API Keys & Client

You can provide API keys either via .env or programmatically, then set the provider.

✅ Option A: Use .env (recommended)

Create a .env file in your project root:

GROQ_API_KEY=sk-your-groq-key
OPENAI_API_KEY=sk-your-openai-key

Then in Python:

from dotenv import load_dotenv
load_dotenv()

✅ Option B: Set manually in code

from leo_prompt_optimizer import set_groq_api_key, set_openai_api_key

set_groq_api_key("[YOUR GROQ KEY]")
set_openai_api_key("[YOUR OPENAI KEY]")

✅ Set your provider

Before calling optimize_prompt, set the backend provider:

from leo_prompt_optimizer import set_client

# For Groq (default)
set_client(provider="groq")

# For OpenAI (with optional custom base URL)
set_client(provider="openai", base_url="https://openrouter.ai/v1")

✍️ Usage Example with key in .env

from dotenv import load_dotenv
load_dotenv()

from leo_prompt_optimizer import (
    optimize_prompt,
    set_groq_api_key,
    set_openai_api_key,
    set_client
)

# Required: set backend provider
set_client(provider="groq")  # or "openai"
# or if you have a specific base_url : 
set_client(provider="openai", base_url="[YOUR BASE URL]") 

# Prompt example
optimized = optimize_prompt(
    prompt_draft="[YOUR PROMPT]",
    user_input_example="[POTENTIAL INPUT EXAMPLE]", # Optional
    llm_output_example="[POTENTIAL OUTPUT EXAMPLE]", # Optional
    top_instruction="[POTENTIAL EXTRA CONTEXT, SPECIFIC INSTRUCTION TO FOCUS ON FOR THE LLM]", # Optional
    model="[YOUR MODEL]",            # Optional: model choie based on your provider(e.g. "gpt-4", "llama3-70b", etc.)
)

print(optimized)

🧠 user_input_example and llm_output_example are optional but improve accuracy. 💬 top_instruction is optional — it adds specific guidance to influence the optimization (e.g., tone, audience, format).

🎛️ model is optional — defaults are:

  • "openai/gpt-oss-20b" for Groq
  • "gpt-oss-120b" for OpenAI

📘 Output Format

Optimized prompts follow a clear, modular structure:

Role:
[Define the LLM's persona]

Task:
[Clearly state the specific objective]

Instructions:
* Step-by-step subtasks

Context:
[Any relevant background, constraints, domain]

Output Format:
[e.g., bullet list, JSON, summary]

User Input:
[Original user input or example]

🧪 Quick Test (Optional)

python3 test_import.py

Checks that:

  • ✅ Import works
  • ✅ API keys are found
  • ✅ LLM returns a response

🧯 Common Errors & Fixes

Error Solution
Missing API key Add key to .env or use set_groq_api_key() / set_openai_api_key()
Client not set Use set_client("groq") or set_client("openai") before calling optimize_prompt()
Invalid model or 403 Model may be deprecated or not available — try another, or check Groq’s model list
ModuleNotFoundError Check if leo-prompt-optimizer is installed in the correct virtual environment

💡 Why Use It?

Prompt quality is critical for any GenAI product.

leo-prompt-optimizer helps you:

✅ Make prompts explicit and modular 🚫 Reduce hallucinations 🔁 Improve consistency and reuse 🧱 Standardize prompt formats across your stack


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

leo_prompt_optimizer-0.1.8.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

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

leo_prompt_optimizer-0.1.8-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file leo_prompt_optimizer-0.1.8.tar.gz.

File metadata

  • Download URL: leo_prompt_optimizer-0.1.8.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for leo_prompt_optimizer-0.1.8.tar.gz
Algorithm Hash digest
SHA256 7bc5675d1c966109ffaf81a64937d5b286123cbe221668aee9b5810cf0694e02
MD5 4dd87217b6d8379268d91ba38777f601
BLAKE2b-256 c1dc36ffea023b78b795ab8c812fb8f5644c8254b60d9d2314c48f11047c733a

See more details on using hashes here.

File details

Details for the file leo_prompt_optimizer-0.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for leo_prompt_optimizer-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 4fef70c560b9e4a998d32da493ad8fa3510bb2cab9456cb81b5462c56798538e
MD5 10ccd8966cc1cad9466b3d35f1fbfeb2
BLAKE2b-256 79fe35e6a4ce860ac64e9614e97e0582044841d33e55b29a943853ed970a62eb

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