Early Experimental StageThis software is in early development and may have limitations or bugs. Do not use for production.

DocumentationInstallation

Installation

Step-by-step guide for installing Pynions and setting up your local marketing automation environment on macOS.

Prerequisites

  1. Install Homebrew (if not already installed):
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  1. Install Python 3.9+ via Homebrew:
brew install python
  1. Verify Python installation:
python3 --version  # Should show 3.9 or higher
  1. Install git:
brew install git

Project Setup

  1. Clone or create project:
# If starting fresh:
mkdir ~/Documents/pynions
cd ~/Documents/pynions
 
# If cloning:
git clone https://github.com/yourusername/pynions.git
cd pynions
  1. Create virtual environment:
# Create venv
python3 -m venv venv
 
# Activate it
source venv/bin/activate
  1. Install dependencies:
pip install -r requirements.txt
  1. Install Playwright browsers:
playwright install

Configuration

  1. Set up environment variables:
# Copy example files
cp .env.example .env
cp config.example.json config.json
  1. Edit .env file:
# Open in your preferred editor
nano .env
 
# Add your API keys:
SERPER_API_KEY=your_key_here
OPENAI_API_KEY=your_key_here
ANTHROPIC_API_KEY=your_key_here
JINA_API_KEY=your_key_here

Verify Installation

  1. Run test workflow:
# Make sure venv is activated
source venv/bin/activate
 
# Run example
python examples/serp_analysis.py
  1. Check the output:
  • Should see progress messages
  • Results saved in data/ directory
  • No error messages

IDE Setup (Cursor)

  1. Download Cursor:

    • Visit https://cursor.sh
    • Download Mac version
    • Install application
  2. Open project:

    • Open Cursor
    • File -> Open Folder
    • Select ~/Documents/pynions
  3. Configure Python interpreter:

    • Click Python version in status bar
    • Select interpreter from virtual environment: ~/Documents/pynions/venv/bin/python

Common Issues

Python Version Issues

# Check Python version
python --version
 
# If needed, specify Python 3 explicitly
python3 --version

Virtual Environment Issues

# Deactivate if already in a venv
deactivate
 
# Remove existing venv if needed
rm -rf venv
 
# Create new venv
python3 -m venv venv
 
# Activate
source venv/bin/activate

Permission Issues

# Fix venv permissions
chmod +x venv/bin/activate
chmod +x venv/bin/python
 
# Fix data directory permissions
chmod 755 data

Module Not Found Issues

# Verify installation
pip list
 
# Reinstall dependencies
pip install -r requirements.txt

Next Steps

  1. Read 03-configuration.md for detailed API setup
  2. Try example workflows in examples/
  3. Check 04-plugins.md for plugin usage
  4. See 05-workflows.md for creating custom workflows

Development Tools

Optional but recommended tools:

  1. HTTPie for API testing:
brew install httpie
  1. jq for JSON processing:
brew install jq
  1. Visual Studio Code extensions:
    • Python
    • Python Environment Manager
    • Git Lens
    • Docker (if using containers)

Updating

To update dependencies:

pip install --upgrade -r requirements.txt

To update Playwright:

playwright install
Updated 5 days ago
Edit this page
Did this page help you?