DocumentationInstallation
Installation
Complete guide for installing and configuring Pynions on your local machine.
Prerequisites
- Install Homebrew (if not already installed):
- Install Python 3.9+ and Git:
Installation
- Create and activate a virtual environment:
- Install Pynions:
The installer will automatically:
- Create
.env
from.env.example
in your project root - Create
pynions.json
frompynions.example.json
in your project root
- Configure your API keys:
Troubleshooting
Common issues:
- Missing API keys
- Check if
.env
exists in your project root - Ensure you've added your OpenAI API key
- Check if
- Configuration issues
- Verify
pynions.json
exists in your project root - Check file permissions
- Verify
Verify Installation
- Run test workflow:
- Check output:
- Progress messages should appear
- Results in
data/
directory - No error messages
- Check logs in data/pynions.log
IDE Setup (Cursor)
-
Download Cursor:
- Visit https://cursor.sh
- Download Mac version
- Install application
-
Open project:
- Open Cursor
- File -> Open Folder
- Select
~/Documents/pynions
-
Configure Python interpreter:
- Click Python version in status bar
- Select:
~/Documents/pynions/venv/bin/python
Common Issues
Python Version Issues
Virtual Environment Issues
Permission Issues
Module Not Found Issues
API Issues
Playwright Issues
Development Workflow
- Always work with activated virtual environment
- Create feature branches for new work:
- Run tests before committing:
- Follow git workflow:
Remember to:
- Keep config.json in .gitignore
- Check logs in data/pynions.log for issues
- Run tests before committing changes
- Test components in isolation when debugging
Development Tools
Optional but recommended:
- HTTPie for API testing:
- jq for JSON processing:
- VS Code extensions:
- Python
- Python Environment Manager
Updating
To update dependencies:
To update Playwright:
Next Steps
- Read Configuration for detailed API setup
- Try example workflows in Examples
- Check Plugins for plugin usage
- See Workflows for creating custom workflows
- Review Debugging if you encounter issues
Updated 2 months ago
Edit this page