ai-prompter 0.1.0__tar.gz → 0.2.1__tar.gz

ai_prompter-0.2.1/.python-version

@@ -0,0 +1 @@
+3.10

ai_prompter-0.2.1/Makefile

@@ -0,0 +1,7 @@
+.PHONY: tag
+
+tag:
+	@version=$$(grep '^version = ' pyproject.toml | sed 's/version = "\(.*\)"/\1/'); \
+	echo "Creating tag v$$version"; \
+	git tag "v$$version"; \
+	git push origin "v$$version"

{ai_prompter-0.1.0 → ai_prompter-0.2.1}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: ai-prompter
-Version: 0.1.0
+Version: 0.2.1
 Summary: A prompt management library using Jinja2 templates to build complex prompts easily.
 Author-email: LUIS NOVO <lfnovo@gmail.com>
 License: MIT
 License-File: LICENSE
-Requires-Python: >=3.10.6
+Requires-Python: >=3.10
 Requires-Dist: jinja2>=3.1.6
 Requires-Dist: pip>=25.0.1
 Requires-Dist: pydantic>=2.0
@@ -21,7 +21,7 @@ A prompt management library using Jinja2 templates to build complex prompts easi
 
 - Define prompts as Jinja templates.
 - Load default templates from `src/ai_prompter/prompts`.
-- Override templates via `PROMPT_PATH` environment variable.
+- Override templates via `PROMPTS_PATH` environment variable.
 - Render prompts with arbitrary data or Pydantic models.
 - Export to LangChain `ChatPromptTemplate`.
 
@@ -51,34 +51,104 @@ uv add langchain_core
 Configure a custom template path by creating a `.env` file in the project root:
 
 ```dotenv
-PROMPT_PATH=path/to/custom/templates
+PROMPTS_PATH=path/to/custom/templates
 ```
 
 ## Usage
 
+### Basic Usage
+
+```python
+from ai_prompter import Prompter
+
+# Initialize with a template name
+prompter = Prompter('my_template')
+
+# Render a prompt with variables
+prompt = prompter.render({'variable': 'value'})
+print(prompt)
+```
+
+### Custom Prompt Directory
+
+You can specify a custom directory for your prompt templates using the `prompt_dir` parameter:
+
+```python
+prompter = Prompter(template_text='Hello {{ name }}!', prompt_dir='/path/to/your/prompts')
+```
+
+### Using Environment Variable for Prompt Path
+
+Set the `PROMPTS_PATH` environment variable to point to your custom prompts directory:
+
+```bash
+export PROMPTS_PATH=/path/to/your/prompts
+```
+
+The `Prompter` class will check this path if no custom directory is provided in the constructor. If not set, it will also look in the current working directory and `~/ai-prompter/` as fallback options before using the default package prompts.
+
 ### Raw text template
 
 ```python
 from ai_prompter import Prompter
 
 template = """Write an article about {{ topic }}."""
-prompter = Prompter(prompt_text=template)
+prompter = Prompter(template_text=template)
 prompt = prompter.render({"topic": "AI"})
 print(prompt)  # Write an article about AI.
 ```
 
 ### Using File-based Templates
 
-You can store your templates in files and reference them by name (without the `.jinja` extension). The library looks for templates in the `prompts` directory by default, or you can set a custom directory with the `PROMPT_PATH` environment variable.
+You can store your templates in files and reference them by name (without the `.jinja` extension). The library looks for templates in the `prompts` directory by default, or you can set a custom directory with the `PROMPTS_PATH` environment variable. You can specify multiple directories separated by `:` (colon), and the library will search through them in order until a matching template is found.
 
 ```python
 from ai_prompter import Prompter
 
+# Set multiple search paths
+os.environ["PROMPTS_PATH"] = "/path/to/templates1:/path/to/templates2"
+
 prompter = Prompter(prompt_template="greet")
-prompt = prompter.render({"who": "Tester"})
-print(prompt)  # GREET Tester
+result = prompter.render({"name": "World"})
+print(result)  # Output depends on the content of greet.jinja in the first found path
+```
+
+### Using Raw Text Templates
+
+Alternatively, you can provide the template content directly as raw text using the `template_text` parameter or the `from_text` class method.
+
+```python
+from ai_prompter import Prompter
+
+# Using template_text parameter
+prompter = Prompter(template_text="Hello, {{ name }}!")
+result = prompter.render({"name": "World"})
+print(result)  # Output: Hello, World!
+
+# Using from_text class method
+prompter = Prompter.from_text("Hi, {{ person }}!", model="gpt-4")
+result = prompter.render({"person": "Alice"})
+print(result)  # Output: Hi, Alice!
+```
+
+### LangChain Integration
+
+You can convert your prompts to LangChain's `ChatPromptTemplate` format for use in LangChain workflows. This works for both text-based and file-based templates.
+
+```python
+from ai_prompter import Prompter
+
+# With text-based template
+text_prompter = Prompter(template_text="Hello, {{ name }}!")
+lc_text_prompt = text_prompter.to_langchain()
+
+# With file-based template
+file_prompter = Prompter(prompt_template="greet")
+lc_file_prompt = file_prompter.to_langchain()
 ```
 
+**Note**: LangChain integration requires the `langchain-core` package. Install it with `pip install .[langchain]`.
+
 ### Including Other Templates
 
 You can include other template files within a template using Jinja2's `{% include %}` directive. This allows you to build modular templates.
@@ -138,7 +208,7 @@ The library also automatically provides a `current_time` variable with the curre
 ```python
 from ai_prompter import Prompter
 
-prompter = Prompter(prompt_text="Current time: {{current_time}}")
+prompter = Prompter(template_text="Current time: {{current_time}}")
 prompt = prompter.render()
 print(prompt)  # Current time: 2025-04-19 23:28:00
 ```
@@ -159,16 +229,6 @@ prompt = prompter.render({"topic": "AI"})
 print(prompt)
 ```
 
-### LangChain integration
-
-```python
-from ai_prompter import Prompter
-
-prompter = Prompter(prompt_template="article")
-lc_template = prompter.to_langchain()
-# use lc_template in LangChain chains
-```
-
 ### Jupyter Notebook
 
 See `notebooks/prompter_usage.ipynb` for interactive examples.

{ai_prompter-0.1.0 → ai_prompter-0.2.1}/README.md

@@ -6,7 +6,7 @@ A prompt management library using Jinja2 templates to build complex prompts easi
 
 - Define prompts as Jinja templates.
 - Load default templates from `src/ai_prompter/prompts`.
-- Override templates via `PROMPT_PATH` environment variable.
+- Override templates via `PROMPTS_PATH` environment variable.
 - Render prompts with arbitrary data or Pydantic models.
 - Export to LangChain `ChatPromptTemplate`.
 
@@ -36,34 +36,104 @@ uv add langchain_core
 Configure a custom template path by creating a `.env` file in the project root:
 
 ```dotenv
-PROMPT_PATH=path/to/custom/templates
+PROMPTS_PATH=path/to/custom/templates
 ```
 
 ## Usage
 
+### Basic Usage
+
+```python
+from ai_prompter import Prompter
+
+# Initialize with a template name
+prompter = Prompter('my_template')
+
+# Render a prompt with variables
+prompt = prompter.render({'variable': 'value'})
+print(prompt)
+```
+
+### Custom Prompt Directory
+
+You can specify a custom directory for your prompt templates using the `prompt_dir` parameter:
+
+```python
+prompter = Prompter(template_text='Hello {{ name }}!', prompt_dir='/path/to/your/prompts')
+```
+
+### Using Environment Variable for Prompt Path
+
+Set the `PROMPTS_PATH` environment variable to point to your custom prompts directory:
+
+```bash
+export PROMPTS_PATH=/path/to/your/prompts
+```
+
+The `Prompter` class will check this path if no custom directory is provided in the constructor. If not set, it will also look in the current working directory and `~/ai-prompter/` as fallback options before using the default package prompts.
+
 ### Raw text template
 
 ```python
 from ai_prompter import Prompter
 
 template = """Write an article about {{ topic }}."""
-prompter = Prompter(prompt_text=template)
+prompter = Prompter(template_text=template)
 prompt = prompter.render({"topic": "AI"})
 print(prompt)  # Write an article about AI.
 ```
 
 ### Using File-based Templates
 
-You can store your templates in files and reference them by name (without the `.jinja` extension). The library looks for templates in the `prompts` directory by default, or you can set a custom directory with the `PROMPT_PATH` environment variable.
+You can store your templates in files and reference them by name (without the `.jinja` extension). The library looks for templates in the `prompts` directory by default, or you can set a custom directory with the `PROMPTS_PATH` environment variable. You can specify multiple directories separated by `:` (colon), and the library will search through them in order until a matching template is found.
 
 ```python
 from ai_prompter import Prompter
 
+# Set multiple search paths
+os.environ["PROMPTS_PATH"] = "/path/to/templates1:/path/to/templates2"
+
 prompter = Prompter(prompt_template="greet")
-prompt = prompter.render({"who": "Tester"})
-print(prompt)  # GREET Tester
+result = prompter.render({"name": "World"})
+print(result)  # Output depends on the content of greet.jinja in the first found path
+```
+
+### Using Raw Text Templates
+
+Alternatively, you can provide the template content directly as raw text using the `template_text` parameter or the `from_text` class method.
+
+```python
+from ai_prompter import Prompter
+
+# Using template_text parameter
+prompter = Prompter(template_text="Hello, {{ name }}!")
+result = prompter.render({"name": "World"})
+print(result)  # Output: Hello, World!
+
+# Using from_text class method
+prompter = Prompter.from_text("Hi, {{ person }}!", model="gpt-4")
+result = prompter.render({"person": "Alice"})
+print(result)  # Output: Hi, Alice!
+```
+
+### LangChain Integration
+
+You can convert your prompts to LangChain's `ChatPromptTemplate` format for use in LangChain workflows. This works for both text-based and file-based templates.
+
+```python
+from ai_prompter import Prompter
+
+# With text-based template
+text_prompter = Prompter(template_text="Hello, {{ name }}!")
+lc_text_prompt = text_prompter.to_langchain()
+
+# With file-based template
+file_prompter = Prompter(prompt_template="greet")
+lc_file_prompt = file_prompter.to_langchain()
 ```
 
+**Note**: LangChain integration requires the `langchain-core` package. Install it with `pip install .[langchain]`.
+
 ### Including Other Templates
 
 You can include other template files within a template using Jinja2's `{% include %}` directive. This allows you to build modular templates.
@@ -123,7 +193,7 @@ The library also automatically provides a `current_time` variable with the curre
 ```python
 from ai_prompter import Prompter
 
-prompter = Prompter(prompt_text="Current time: {{current_time}}")
+prompter = Prompter(template_text="Current time: {{current_time}}")
 prompt = prompter.render()
 print(prompt)  # Current time: 2025-04-19 23:28:00
 ```
@@ -144,16 +214,6 @@ prompt = prompter.render({"topic": "AI"})
 print(prompt)
 ```
 
-### LangChain integration
-
-```python
-from ai_prompter import Prompter
-
-prompter = Prompter(prompt_template="article")
-lc_template = prompter.to_langchain()
-# use lc_template in LangChain chains
-```
-
 ### Jupyter Notebook
 
 See `notebooks/prompter_usage.ipynb` for interactive examples.

ai_prompter-0.2.1/notebooks/prompter_usage.ipynb

@@ -0,0 +1,227 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# AI Prompter Usage"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Overriding the PROMPTS_PATH"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from ai_prompter import Prompter\n",
+    "import os\n",
+    "from pathlib import Path\n",
+    "\n",
+    "os.environ['PROMPTS_PATH'] = str(Path('prompts').resolve())\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Using Text Templates"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'Write an article about AI.'"
+      ]
+     },
+     "execution_count": 2,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "from ai_prompter import Prompter\n",
+    "\n",
+    "template = \"\"\"Write an article about {{topic}}.\"\"\"\n",
+    "\n",
+    "prompter = Prompter(template_text=template)\n",
+    "\n",
+    "prompt = prompter.render(dict(topic=\"AI\"))\n",
+    "\n",
+    "prompt"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Using File Templates"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'Write an article about AI.'"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "prompter = Prompter(prompt_template=\"article\") #will look for article.jinja in the prompts directory\n",
+    "\n",
+    "\n",
+    "prompt = prompter.render(dict(topic=\"AI\"))\n",
+    "\n",
+    "prompt"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Using Includes and Ifs"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'This is the outer file \\n\\nThis is the inner file\\n\\nValue: a\\n\\n\\n    You selected A\\n\\n\\nThis is the end of the outer file'"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "prompter = Prompter(prompt_template=\"outer\")\n",
+    "\n",
+    "prompt = prompter.render(dict(type=\"a\"))\n",
+    "\n",
+    "prompt"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Langchain compatibility\n",
+    "\n",
+    "Returns a Langchain ChatPromptTemplate"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "ChatPromptTemplate(input_variables=['topic'], input_types={}, partial_variables={}, messages=[HumanMessagePromptTemplate(prompt=PromptTemplate(input_variables=['topic'], input_types={}, partial_variables={}, template='Write an article about {{topic}}.', template_format='jinja2'), additional_kwargs={})])"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "template = \"\"\"Write an article about {{topic}}.\"\"\"\n",
+    "\n",
+    "prompter = Prompter(template_text=template)\n",
+    "\n",
+    "lc_prompt = prompter.to_langchain()\n",
+    "\n",
+    "lc_prompt"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "ChatPromptTemplate(input_variables=['type'], input_types={}, partial_variables={}, messages=[HumanMessagePromptTemplate(prompt=PromptTemplate(input_variables=['type'], input_types={}, partial_variables={}, template=\"This is the outer file \\n\\nThis is the inner file\\n\\nValue: {{ type }}\\n\\n{% if type == 'a' %}\\n    You selected A\\n{% else %}\\n    You didn't select A\\n{% endif %}\\n\\n\\nThis is the end of the outer file\\n\", template_format='jinja2'), additional_kwargs={})])"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "prompter = Prompter(prompt_template=\"outer\")\n",
+    "lc_prompt = prompter.to_langchain()\n",
+    "lc_prompt"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "ChatPromptValue(messages=[HumanMessage(content='This is the outer file \\n\\nThis is the inner file\\n\\nValue: a\\n\\n\\n    You selected A\\n\\n\\n\\nThis is the end of the outer file', additional_kwargs={}, response_metadata={})])"
+      ]
+     },
+     "execution_count": 7,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "lc_prompt.format_prompt(type=\"a\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".venv",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

{ai_prompter-0.1.0 → ai_prompter-0.2.1}/notebooks/prompts/inner.jinja

@@ -1,5 +1,7 @@
 This is the inner file
 
+Value: {{ type }}
+
 {% if type == 'a' %}
     You selected A
 {% else %}

{ai_prompter-0.1.0 → ai_prompter-0.2.1}/pyproject.toml

@@ -1,13 +1,13 @@
 [project]
 name = "ai-prompter"
-version = "0.1.0"
+version = "0.2.1"
 description = "A prompt management library using Jinja2 templates to build complex prompts easily."
 readme = "README.md"
 homepage = "https://github.com/lfnovo/ai-prompter"
 authors = [
     { name = "LUIS NOVO", email = "lfnovo@gmail.com" }
 ]
-requires-python = ">=3.10.6"
+requires-python = ">=3.10"
 dependencies = [
     "jinja2>=3.1.6",
     "pip>=25.0.1",