DocumentationProject Structure
Project Structure
Simple guide to Pynions project organization
Project Structure
my-pynions/ # Your project folder
├── .env # API keys
├── pynions.json # Optional settings
├── data/ # Generated content
│ └── content_ideas.txt
│
├── workflows/ # Your marketing workflows
│ ├── blog_ideas.py
│ ├── social_posts.py
│ └── seo_research.py
│
└── README.md # Project documentation
Key Files
1. Configuration Files
[object Object] - API Keys
[object Object] - Optional Settings
2. Your Workflows
Create Python workflows for your marketing tasks:
[object Object]
3. Generated Content
Content is saved to the data
folder by default:
data/content_ideas.txt
data/blog_posts/
data/social_media/
Core Components
Pynions handles these for you:
-
Configuration (
pynions.core.config
)- API key management
- Settings handling
- File saving
-
AI Integration (
litellm
)- Multiple AI models
- Smart defaults
- Error handling
-
Plugins (
pynions.plugins
)- Search (Serper)
- Content Analysis
- SEO Tools
Best Practices
-
Organization
- Keep workflows in
workflows/
folder - Use descriptive filenames
- Group related content
- Keep workflows in
-
Configuration
- Keep API keys in
.env
- Use
pynions.json
for custom settings - Let Pynions handle the rest
- Keep API keys in
-
Content
- Save generated content to
data/
- Use subfolders for organization
- Add dates to filenames
- Save generated content to
Example Project
Here's a complete marketing automation project:
my-pynions/
├── .env # API keys
├── pynions.json # Custom settings
│
├── workflows/
│ ├── blog_ideas.py # Blog ideation workflow
│ ├── social_calendar.py # Social planning workflow
│ └── seo_keywords.py # SEO research workflow
│
├── data/
│ ├── blog/ # Blog content
│ ├── social/ # Social posts
│ └── seo/ # SEO data
│
└── README.md # Documentation
Need more examples? Check our example workflows or join our Discord!
Updated 1 month ago
Edit this page