ai-prompter 0.1.0__tar.gz

ai_prompter-0.1.0/.env.sample

@@ -0,0 +1 @@
+PROMPTS_PATH=/your/prompt/path

ai_prompter-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+<!--
+Thanks for contributing a pull request! Please ensure you have taken a look at CONTRIBUTING.md
+-->
+
+#### Reference Issues/PRs
+<!--
+Example: Fixes #1234. See also #3456.
+Please use keywords (e.g., Fixes) to create link to the issues or pull requests
+you resolved, so that they will automatically be closed when your pull request
+is merged. See https://github.com/blog/1506-closing-issues-via-pull-requests
+-->
+
+
+#### What does this implement/fix? Explain your changes.
+
+
+#### Any other comments?
+
+
+<!--
+Thanks for contributing!
+-->

ai_prompter-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - 'v*'
+      - '[0-9]*.[0-9]*.[0-9]*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
+    
+    - name: Install uv
+      run: |
+        curl -LsSf https://astral.sh/uv/install.sh | sh
+        echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+        
+    - name: Install dependencies and build tools
+      run: |
+        uv venv
+        rm -rf dist
+        uv sync
+
+    - name: Build package
+      run: uv build
+    
+    - name: Publish to PyPI
+      env:
+        PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+      run: uv publish --token "$PYPI_TOKEN"

ai_prompter-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.vscode
+.*rules

ai_prompter-0.1.0/.python-version

@@ -0,0 +1 @@
+3.10.6

ai_prompter-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Luis Novo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ai_prompter-0.1.0/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.4
+Name: ai-prompter
+Version: 0.1.0
+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-Dist: jinja2>=3.1.6
+Requires-Dist: pip>=25.0.1
+Requires-Dist: pydantic>=2.0
+Provides-Extra: langchain
+Requires-Dist: langchain-core>=0.3; extra == 'langchain'
+Description-Content-Type: text/markdown
+
+# AI Prompter
+
+A prompt management library using Jinja2 templates to build complex prompts easily. Supports raw text or file-based templates and integrates with LangChain.
+
+## Features
+
+- Define prompts as Jinja templates.
+- Load default templates from `src/ai_prompter/prompts`.
+- Override templates via `PROMPT_PATH` environment variable.
+- Render prompts with arbitrary data or Pydantic models.
+- Export to LangChain `ChatPromptTemplate`.
+
+## Installation
+
+1. (Optional) Create and activate a virtual environment:
+   ```bash
+   python3 -m venv .venv
+   source .venv/bin/activate
+   ```
+2. Install the package:
+   ```bash
+   pip install .
+   ```
+### Extras
+
+To enable LangChain integration:
+
+```bash
+pip install .[langchain]
+# or
+uv add langchain_core
+```
+
+## Configuration
+
+Configure a custom template path by creating a `.env` file in the project root:
+
+```dotenv
+PROMPT_PATH=path/to/custom/templates
+```
+
+## Usage
+
+### Raw text template
+
+```python
+from ai_prompter import Prompter
+
+template = """Write an article about {{ topic }}."""
+prompter = Prompter(prompt_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.
+
+```python
+from ai_prompter import Prompter
+
+prompter = Prompter(prompt_template="greet")
+prompt = prompter.render({"who": "Tester"})
+print(prompt)  # GREET Tester
+```
+
+### Including Other Templates
+
+You can include other template files within a template using Jinja2's `{% include %}` directive. This allows you to build modular templates.
+
+```jinja
+# outer.jinja
+This is the outer file
+
+{% include 'inner.jinja' %}
+
+This is the end of the outer file
+```
+
+```jinja
+# inner.jinja
+This is the inner file
+
+{% if type == 'a' %}
+    You selected A
+{% else %}
+    You didn't select A
+{% endif %}
+```
+
+```python
+from ai_prompter import Prompter
+
+prompter = Prompter(prompt_template="outer")
+prompt = prompter.render(dict(type="a"))
+print(prompt)
+# This is the outer file
+# 
+# This is the inner file
+# 
+#     You selected A
+# 
+# 
+# This is the end of the outer file
+```
+
+### Using Variables
+
+Templates can use variables that you pass in through the `render()` method. You can use Jinja2 filters and conditionals to control the output based on your data.
+
+```python
+from ai_prompter import Prompter
+
+prompter = Prompter(prompt_text="Hello {{name|default('Guest')}}!")
+prompt = prompter.render()  # No data provided, uses default
+print(prompt)  # Hello Guest!
+prompt = prompter.render({"name": "Alice"})  # Data provided
+print(prompt)  # Hello Alice!
+```
+
+The library also automatically provides a `current_time` variable with the current timestamp in format "YYYY-MM-DD HH:MM:SS".
+
+```python
+from ai_prompter import Prompter
+
+prompter = Prompter(prompt_text="Current time: {{current_time}}")
+prompt = prompter.render()
+print(prompt)  # Current time: 2025-04-19 23:28:00
+```
+
+### File-based template
+
+Place a Jinja file (e.g., `article.jinja`) in the default prompts directory (`src/ai_prompter/prompts`) or your custom path:
+
+```jinja
+Write an article about {{ topic }}.
+```
+
+```python
+from ai_prompter import Prompter
+
+prompter = Prompter(prompt_template="article")
+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.
+
+## Project Structure
+
+```
+ai-prompter/
+├── src/ai_prompter
+│   ├── __init__.py
+│   └── prompts/
+│       └── *.jinja
+├── notebooks/
+│   ├── prompter_usage.ipynb
+│   └── prompts/
+├── pyproject.toml
+├── README.md
+└── .env (optional)
+```
+
+## Testing
+
+Run tests with:
+
+```bash
+uv run pytest -v
+```
+
+## Contributing
+
+Contributions welcome! Please open issues or PRs.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

ai_prompter-0.1.0/README.md

@@ -0,0 +1,191 @@
+# AI Prompter
+
+A prompt management library using Jinja2 templates to build complex prompts easily. Supports raw text or file-based templates and integrates with LangChain.
+
+## Features
+
+- Define prompts as Jinja templates.
+- Load default templates from `src/ai_prompter/prompts`.
+- Override templates via `PROMPT_PATH` environment variable.
+- Render prompts with arbitrary data or Pydantic models.
+- Export to LangChain `ChatPromptTemplate`.
+
+## Installation
+
+1. (Optional) Create and activate a virtual environment:
+   ```bash
+   python3 -m venv .venv
+   source .venv/bin/activate
+   ```
+2. Install the package:
+   ```bash
+   pip install .
+   ```
+### Extras
+
+To enable LangChain integration:
+
+```bash
+pip install .[langchain]
+# or
+uv add langchain_core
+```
+
+## Configuration
+
+Configure a custom template path by creating a `.env` file in the project root:
+
+```dotenv
+PROMPT_PATH=path/to/custom/templates
+```
+
+## Usage
+
+### Raw text template
+
+```python
+from ai_prompter import Prompter
+
+template = """Write an article about {{ topic }}."""
+prompter = Prompter(prompt_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.
+
+```python
+from ai_prompter import Prompter
+
+prompter = Prompter(prompt_template="greet")
+prompt = prompter.render({"who": "Tester"})
+print(prompt)  # GREET Tester
+```
+
+### Including Other Templates
+
+You can include other template files within a template using Jinja2's `{% include %}` directive. This allows you to build modular templates.
+
+```jinja
+# outer.jinja
+This is the outer file
+
+{% include 'inner.jinja' %}
+
+This is the end of the outer file
+```
+
+```jinja
+# inner.jinja
+This is the inner file
+
+{% if type == 'a' %}
+    You selected A
+{% else %}
+    You didn't select A
+{% endif %}
+```
+
+```python
+from ai_prompter import Prompter
+
+prompter = Prompter(prompt_template="outer")
+prompt = prompter.render(dict(type="a"))
+print(prompt)
+# This is the outer file
+# 
+# This is the inner file
+# 
+#     You selected A
+# 
+# 
+# This is the end of the outer file
+```
+
+### Using Variables
+
+Templates can use variables that you pass in through the `render()` method. You can use Jinja2 filters and conditionals to control the output based on your data.
+
+```python
+from ai_prompter import Prompter
+
+prompter = Prompter(prompt_text="Hello {{name|default('Guest')}}!")
+prompt = prompter.render()  # No data provided, uses default
+print(prompt)  # Hello Guest!
+prompt = prompter.render({"name": "Alice"})  # Data provided
+print(prompt)  # Hello Alice!
+```
+
+The library also automatically provides a `current_time` variable with the current timestamp in format "YYYY-MM-DD HH:MM:SS".
+
+```python
+from ai_prompter import Prompter
+
+prompter = Prompter(prompt_text="Current time: {{current_time}}")
+prompt = prompter.render()
+print(prompt)  # Current time: 2025-04-19 23:28:00
+```
+
+### File-based template
+
+Place a Jinja file (e.g., `article.jinja`) in the default prompts directory (`src/ai_prompter/prompts`) or your custom path:
+
+```jinja
+Write an article about {{ topic }}.
+```
+
+```python
+from ai_prompter import Prompter
+
+prompter = Prompter(prompt_template="article")
+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.
+
+## Project Structure
+
+```
+ai-prompter/
+├── src/ai_prompter
+│   ├── __init__.py
+│   └── prompts/
+│       └── *.jinja
+├── notebooks/
+│   ├── prompter_usage.ipynb
+│   └── prompts/
+├── pyproject.toml
+├── README.md
+└── .env (optional)
+```
+
+## Testing
+
+Run tests with:
+
+```bash
+uv run pytest -v
+```
+
+## Contributing
+
+Contributions welcome! Please open issues or PRs.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

ai_prompter-0.1.0/notebooks/prompter_usage.ipynb

@@ -0,0 +1,135 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'/Users/luisnovo/dev/projetos/ai-prompter/notebooks/prompts'"
+      ]
+     },
+     "execution_count": 1,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "import os\n",
+    "from pathlib import Path\n",
+    "\n",
+    "os.environ['PROMPT_PATH'] = str(Path('prompts').resolve())\n",
+    "\n",
+    "os.environ['PROMPT_PATH']"
+   ]
+  },
+  {
+   "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(prompt_text=template)\n",
+    "\n",
+    "prompt = prompter.render(dict(topic=\"AI\"))\n",
+    "\n",
+    "prompt"
+   ]
+  },
+  {
+   "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\")\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": 5,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'This is the outer file \\n\\nThis is the inner file\\n\\n\\n    You selected A\\n\\n\\nThis is the end of the outer file'"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "prompter = Prompter(prompt_template=\"outer\")\n",
+    "\n",
+    "\n",
+    "prompt = prompter.render(dict(type=\"a\"))\n",
+    "\n",
+    "prompt"
+   ]
+  }
+ ],
+ "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/notebooks/prompts/article.jinja

@@ -0,0 +1 @@
+Write an article about {{topic}}.

ai_prompter-0.1.0/notebooks/prompts/inner.jinja

@@ -0,0 +1,7 @@
+This is the inner file
+
+{% if type == 'a' %}
+    You selected A
+{% else %}
+    You didn't select A
+{% endif %}

ai_prompter-0.1.0/notebooks/prompts/outer.jinja

@@ -0,0 +1,5 @@
+This is the outer file 
+
+{% include 'inner.jinja' %}
+
+This is the end of the outer file

ai_prompter-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[project]
+name = "ai-prompter"
+version = "0.1.0"
+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"
+dependencies = [
+    "jinja2>=3.1.6",
+    "pip>=25.0.1",
+    "pydantic>=2.0",
+]
+optional-dependencies = { langchain = ["langchain-core>=0.3"] }
+license = { text = "MIT" }
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[build-system]
+requires = ["hatchling", "pip"]
+build-backend = "hatchling.build"
+
+[tool.setuptools]
+package-dir = {"ai_prompter" = "src/ai_prompter"}
+
+[dependency-groups]
+dev = [
+    "ipykernel>=4.0.1",
+    "ipywidgets>=4.0.0",
+    "pyperclip>=1.9.0",
+    "pytest>=7.2.0",
+    "pytest-asyncio>=0.21.0",
+    "python-dotenv>=1.1.0",
+]
+
+[tool.pytest.ini_options]
+pythonpath = ["src/ai_prompter"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"