Skip to content

dwhogan/process-prompt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Process Prompt Guide

A Python-based tool that uses Anthropic's Claude AI to guide users through structured processes. This tool helps create interactive, step-by-step guides for any defined process, making it perfect for onboarding, training, or any sequential workflow.

Features

  • Dynamic process guidance using Claude AI
  • Step-by-step process tracking
  • Customizable process definitions
  • Conversation history tracking
  • Progress monitoring
  • Easy integration with existing applications

Prerequisites

  • Python 3.7 or higher
  • Anthropic API key
  • Required Python packages (listed in requirements.txt)

Installation

  1. Clone the repository:
git clone [your-repository-url]
cd process-prompt
  1. Create and activate a virtual environment:
python -m venv venv
source venv/bin/activate  # On Windows, use: venv\Scripts\activate
  1. Install dependencies:
pip install -r requirements.txt
  1. Set up environment variables:
# Copy the example environment file
cp .env.example .env

# Edit .env with your actual API key
# You can use any text editor to replace 'your_api_key_here' with your actual Anthropic API key

Usage

Here's a basic example of how to use the ProcessGuide:

from process_prompt import ProcessGuide

# Create a new process guide
guide = ProcessGuide(
    process_name="New Customer Onboarding",
    process_description="A structured process to onboard new customers to our software platform",
    process_steps=[
        "Collect account information",
        "Set up security settings"
    ]
)

# Process user input
response = guide.process_query("Hi, I'm a new customer and need to get set up.")
print(response)

Configuration

The ProcessGuide class accepts the following parameters:

  • process_name: Name of the process
  • process_steps: List of steps in the process
  • process_description: Brief description of what the process achieves
  • model: Anthropic model to use (defaults to "claude-3-7-sonnet-20250219")

Environment Variables

The following environment variables can be configured in your .env file:

  • ANTHROPIC_API_KEY: Your Anthropic API key (required)
  • MODEL_NAME: The Claude model to use (optional, defaults to "claude-3-7-sonnet-20250219")

See .env.example for a template of the required environment variables.

Dependencies

  • anthropic>=0.8.0
  • python-dotenv>=1.0.0

Development

The project uses:

  • Python 3.7+
  • Virtual environment for dependency management
  • Environment variables for configuration

License

[Your chosen license]

Contributing

[Your contribution guidelines]

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages