Skip to main content

A centralized hub for managing and loading AI artifacts like agents, prompts, and workflows

Project description

Pepperpy

A Python library for building AI-powered research assistants.

🚀 Quick Win (30 seconds)

# Install Pepperpy
pip install pepperpy

# Start interactive setup
pepperpy init

# Ask your first question
pepperpy test "What is AI?"

That's it! You're ready to use Pepperpy's powerful features:

from pepperpy import Pepperpy

async def main():
    # Auto-configuration (or use Pepperpy.quick_start() for interactive setup)
    pepper = await Pepperpy.create()
    
    # Simple question
    result = await pepper.ask("What is AI?")
    print(result)
    
    # Interactive chat
    await pepper.chat("Tell me about AI")  # With initial message
    # Or just:
    await pepper.chat()  # Start blank chat

if __name__ == "__main__":
    import asyncio
    asyncio.run(main())

## Quick Start

```python
from pepperpy import Pepperpy

# Quick setup with interactive wizard
pepper = Pepperpy.quick_start()

# Or configure programmatically
async with await Pepperpy.create(api_key="your-key") as pepper:
    # Ask simple questions
    result = await pepper.ask("What is AI?")
    print(result)
    
    # Research topics in depth
    result = await pepper.research("Impact of AI in Healthcare")
    print(result.tldr)  # Short summary
    print(result.full)  # Full report
    print(result.bullets)  # Key points
    print(result.references)  # Sources
    
    # Use pre-configured teams
    team = await pepper.hub.team("research-team")
    async with team.run("Analyze AI trends") as session:
        print(f"Current step: {session.current_step}")
        print(f"Progress: {session.progress * 100:.0f}%")

Features

  • 🚀 Zero-config setup with smart defaults
  • 🤖 Pre-configured agents and teams
  • 📚 Built-in research capabilities
  • 🔄 Flexible workflows
  • 🎯 Progress monitoring
  • 🔌 Easy integration

Installation

pip install pepperpy

Documentation

Basic Usage

The simplest way to get started is with the interactive setup:

# Run interactive setup
$ pepperpy init

# Test it out
$ pepperpy test "What is AI?"

Or in your code:

from pepperpy import Pepperpy

# Auto-configuration
pepper = await Pepperpy.create()

# With custom settings
pepper = await Pepperpy.create(
    api_key="your-key",
    model="openai/gpt-4"
)

Research Assistant

# Simple research
result = await pepper.research("Quantum Computing")
print(result.tldr)  # Short summary
print(result.full)  # Full report

# With custom parameters
result = await pepper.research(
    topic="Quantum Computing",
    depth="academic",
    max_sources=10
)

Teams & Workflows

# Use a pre-configured team
team = await pepper.hub.team("research-team")
async with team.run("Analyze AI trends") as session:
    # Monitor progress
    print(f"Step: {session.current_step}")
    print(f"Progress: {session.progress * 100:.0f}%")
    
    # Provide input if needed
    if session.needs_input:
        value = input(f"{session.input_prompt}: ")
        session.provide_input(value)

Custom Agents

# Create a custom agent
agent = await pepper.hub.create_agent(
    name="custom-researcher",
    base="researcher",  # Inherit from base agent
    config={
        "style": "technical",
        "depth": "deep"
    }
)

# Use the agent
result = await agent.research("Topic")

# Share with others
await pepper.hub.publish("custom-researcher")

Examples

Check out the examples/ directory for more usage examples:

  • quick_start.py: Basic usage with interactive setup
  • research_workflow.py: Advanced research workflow
  • custom_agent.py: Creating custom agents
  • team_collaboration.py: Using teams and workflows

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run tests: pytest
  5. Submit a pull request

License

MIT License - see LICENSE file for details.

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

pepperpy-1.8.0.tar.gz (169.4 kB view details)

Uploaded Source

Built Distribution

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

pepperpy-1.8.0-py3-none-any.whl (246.5 kB view details)

Uploaded Python 3

File details

Details for the file pepperpy-1.8.0.tar.gz.

File metadata

  • Download URL: pepperpy-1.8.0.tar.gz
  • Upload date:
  • Size: 169.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.9 Linux/6.5.0-1025-azure

File hashes

Hashes for pepperpy-1.8.0.tar.gz
Algorithm Hash digest
SHA256 48aaf003410ff87d16aca70f8ef0bdb1b91cd4d9406b0148b15b8bfb1cfe8745
MD5 ada76b5943a8f220404617763f8d64f9
BLAKE2b-256 bb493c7e33a4c7731215c559eefbc6d6c6586b2821398a0e0656c6606c31209f

See more details on using hashes here.

File details

Details for the file pepperpy-1.8.0-py3-none-any.whl.

File metadata

  • Download URL: pepperpy-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 246.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.9 Linux/6.5.0-1025-azure

File hashes

Hashes for pepperpy-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 34f6debf40b9e0a08dc94256509b8866ecd6238182bfbd9bfc516f79d41a2691
MD5 07b45de0f820141ce5d4b0cb3e54d97f
BLAKE2b-256 de0bae692f7c8a42ca5a1c662109ec5e36f1c2c7ed9d7422f0183a64af9568d3

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