Installation

Requirements

PromptKit requires Python 3.8 or higher.

The recommended way to install PromptKit is via pip:

pip install promptkit-core

For development, clone the repository and install in editable mode with development dependencies:

git clone https://github.com/ochotzas/promptkit.git
cd promptkit
pip install -e .[dev]

You can verify your installation by running:

promptkit --version

Or in Python:

import promptkit
print(promptkit.__version__)

To use OpenAI models, you’ll need to set your API key:

export OPENAI_API_KEY="sk-your-api-key-here"

To use local models with Ollama, install and start Ollama:

# Install Ollama (see https://ollama.ai for platform-specific instructions)
ollama serve

# Pull a model
ollama pull llama2

Once installed, check out the Quick Start Guide to begin using PromptKit.