configuration.md

title	publishedAt	updatedAt	summary	kind
Configuration	2024-10-30	2024-11-23	Simple configuration guide for marketers using Pynions	detailed

Quick Setup

1. Copy .env.example to .env and add your API key:

cp .env.example .env
nano .env  # Add your OpenAI API key

2. (Optional) Create pynions.json if you need custom settings:

cp pynions.example.json pynions.json

That's it! You're ready to start using Pynions.

Configuration Files

1. API Keys (.env)

Put your API keys in .env file in the root directory:

# Required
OPENAI_API_KEY=your_key_here

# Optional (only if you use these features)
SERPER_API_KEY=your_key_here
ANTHROPIC_API_KEY=your_key_here

2. Optional Settings (pynions.json)

If you need to customize settings, create pynions.json in the root directory:

{
    "save_results": true,        // Save generated content to files
    "output_folder": "data",     // Where to save files
    "plugins": {
        "serper": {
            "results": 10,       // Number of search results
            "country": "us"      // Search region
        }
    }
}

All settings are optional and have sensible defaults.

Using in Scripts

Access configuration in your scripts:

from pynions.core.config import config

# Get settings (with defaults)
model = config.get("model", "gpt-4o-mini")
temperature = config.get("temperature", 0.7)

# Set runtime configuration
config.set("max_tokens", 2000)

# Load custom configuration files
config.load(
    env_path=Path("custom/.env"),
    config_path=Path("custom/pynions.json")
)

# Clear configuration if needed
config.clear()

AI Configuration

Pynions uses LiteLLM for AI features. The configuration system automatically manages API keys and model settings.

Example usage:

from litellm import completion

response = completion(
    model=config.get("model", "gpt-4o-mini"),
    temperature=config.get("temperature", 0.7),
    messages=[{"role": "user", "content": "Hello!"}]
)

See LiteLLM documentation for more options.