Compare commits
1 Commits
codex/impl
...
codex/impl
| Author | SHA1 | Date | |
|---|---|---|---|
|
3a7f5cf16f |
88
.planning/ROADMAP.md
Normal file
88
.planning/ROADMAP.md
Normal file
@@ -0,0 +1,88 @@
|
||||
# Roadmap: Alwrity - ALwrity Frontend Optimization
|
||||
|
||||
## Overview
|
||||
|
||||
Optimize the frontend build to reduce build time from 5 minutes to under 30 seconds and shrink bundle size from 8.42MB to under 1MB. First, implement code splitting with React.lazy and feature-gated loading using ALWRITY_ENABLED_FEATURES. Then migrate from Create React App to Vite for faster builds. Finally, optimize dependencies for maximum performance.
|
||||
|
||||
## Phases
|
||||
|
||||
**Phase Numbering:**
|
||||
- Integer phases (1, 2, 3, 4): Planned work
|
||||
- All phases planned and ready for execution
|
||||
|
||||
---
|
||||
|
||||
### Phase 1: Code Splitting & Feature-Based Lazy Loading ✅ Complete
|
||||
**Goal**: Replace all static imports with React.lazy dynamic imports and add feature-gated loading using ALWRITY_ENABLED_FEATURES. Also convert MUI icon barrel imports to individual imports (moved here from Phase 3 for Vite readiness).
|
||||
**Depends on**: Nothing (first phase)
|
||||
**Requirements**: VITE-04 (code splitting), VITE-06 (dependency optimization)
|
||||
**Success Criteria** (what must be TRUE):
|
||||
1. ✅ All 31+ route components loaded via React.lazy (not static imports)
|
||||
2. ✅ Initial bundle size reduced from 8.42MB to 2.50MB (70% reduction)
|
||||
3. ✅ Disabled features (via ALWRITY_ENABLED_FEATURES) don't load their bundles
|
||||
4. ✅ All existing routes still work correctly
|
||||
5. ✅ No build warnings or errors with CRA
|
||||
6. ✅ All MUI icon imports changed from barrel to individual (111 files)
|
||||
|
||||
**Plans**: 3 plans (all complete)
|
||||
|
||||
Plans:
|
||||
- [x] 01-01: Convert 31 static imports to React.lazy with Suspense
|
||||
- [x] 01-02: Add feature-gated route loading using ALWRITY_ENABLED_FEATURES
|
||||
- [x] 01-03: Convert MUI icon barrel imports to individual imports (111 files)
|
||||
|
||||
---
|
||||
|
||||
### Phase 2: Migrate from CRA to Vite (Next)
|
||||
**Goal**: Migrate frontend from Create React App to Vite for fast builds
|
||||
**Depends on**: Phase 1 ✅
|
||||
**Requirements**: VITE-01, VITE-02, VITE-03
|
||||
**Success Criteria** (what must be TRUE):
|
||||
1. `npm run dev` starts Vite dev server with HMR
|
||||
2. `npm run build` completes in under 30 seconds (down from 5 minutes)
|
||||
3. All environment variables work with `VITE_*` prefix
|
||||
4. TypeScript compiles without errors
|
||||
5. Material UI theme renders correctly
|
||||
|
||||
**Plans**: 3 plans
|
||||
|
||||
Plans:
|
||||
- [ ] 02-01: Install Vite dependencies and create configuration
|
||||
- [ ] 02-02: Migrate index.html and entry point
|
||||
- [ ] 02-03: Update environment variables and scripts
|
||||
|
||||
---
|
||||
|
||||
### Phase 3: Dependency Cleanup & Production Validation
|
||||
**Goal**: Remove unused dependencies and deploy Vite build to production
|
||||
**Depends on**: Phase 2
|
||||
**Requirements**: VITE-07, VITE-08, VITE-09
|
||||
**Success Criteria** (what must be TRUE):
|
||||
1. Unused dependencies identified and removed
|
||||
2. Production build serves correctly (preview mode)
|
||||
3. All features tested and working (Clerk auth, Stripe, CopilotKit)
|
||||
4. Vercel deployment config updated for Vite
|
||||
5. Build time consistently under 30 seconds
|
||||
6. Total bundle size under 2MB
|
||||
|
||||
**Plans**: 2 plans (consolidated from former Phase 3 & 4)
|
||||
|
||||
Plans:
|
||||
- [ ] 03-01: Audit and remove unused dependencies, update Vercel config
|
||||
- [ ] 03-02: Full feature testing and performance validation
|
||||
|
||||
---
|
||||
|
||||
## Execution Order
|
||||
|
||||
Phases execute in numeric order: 1 → 2 → 3
|
||||
|
||||
**Key insight:** Phase 1 (code splitting) works with CRA, so we immediately reduce bundle size. Phase 2 (Vite) gives build speed bonus on already-split bundles. Phase 3 is cleanup and deployment.
|
||||
|
||||
## Progress
|
||||
|
||||
| Phase | Plans Complete | Status | Completed |
|
||||
|-------|----------------|--------|-----------|
|
||||
| 1. Code Splitting & MUI Optimization | 3/3 | ✅ Complete | 2026-05-08 |
|
||||
| 2. Migrate CRA to Vite | 0/3 | ⏳ Ready | - |
|
||||
| 3. Cleanup & Production | 0/2 | ⏳ Planned | - |
|
||||
73
.planning/STATE.md
Normal file
73
.planning/STATE.md
Normal file
@@ -0,0 +1,73 @@
|
||||
# Project State: Alwrity
|
||||
|
||||
## Current Position
|
||||
|
||||
**Active Phase:** Phase 1 - Code Splitting & Feature-Based Lazy Loading
|
||||
**Phase Status:** ✅ Complete — Ready for Phase 2
|
||||
**Milestone:** v1.0 - Frontend Optimization
|
||||
|
||||
## Phase Progress
|
||||
|
||||
### Phase 1: Code Splitting & Feature-Based Lazy Loading
|
||||
- **Status:** ✅ Complete
|
||||
- **Plans:** 3 plans executed (01-01, 01-02, 01-03)
|
||||
|
||||
**Plans:**
|
||||
- [x] 01-01: Convert 31 static imports to React.lazy with Suspense
|
||||
- [x] 01-02: Add feature-gated route loading using ALWRITY_ENABLED_FEATURES
|
||||
- [x] 01-03: Convert MUI icon barrel imports to individual imports (111 files)
|
||||
|
||||
**Results:**
|
||||
- Main bundle: 8.42MB → 2.50MB (70% reduction via React.lazy)
|
||||
- 190+ chunk files for route-level code splitting
|
||||
- 47 routes feature-gated with ALWRITY_ENABLED_FEATURES
|
||||
- 16 feature keys in FEATURE_KEYS constant
|
||||
- 111 files converted from barrel to individual MUI icon imports
|
||||
- Zero barrel imports from @mui/icons-material remain
|
||||
|
||||
### Phase 2: Migrate CRA to Vite
|
||||
- **Status:** Ready to start (Phase 1 complete)
|
||||
- **Plans:** 3 plans created (02-01, 02-02, 02-03)
|
||||
- **Dependencies:** Phase 1 complete
|
||||
|
||||
**Plans:**
|
||||
- [ ] 02-01: Install Vite dependencies and create configuration
|
||||
- [ ] 02-02: Migrate index.html and entry point
|
||||
- [ ] 02-03: Update environment variables and scripts
|
||||
|
||||
### Phase 3: Production Validation (Planned)
|
||||
- Depends on: Phase 2
|
||||
- Focus: Vercel deploy, full feature testing
|
||||
|
||||
### Phase 4: (Removed — MUI icon optimization folded into Phase 1-03)
|
||||
|
||||
## Decisions Made
|
||||
|
||||
### Locked Decisions
|
||||
- **Code splitting first**, then Vite migration (not the other way around) ✅ Done
|
||||
- Use React.lazy for ALL route components (this is a React feature, NOT bundler-specific) ✅ Done
|
||||
- Use ALWRITY_ENABLED_FEATURES for feature-gated route loading ✅ Done
|
||||
- **MUI icon imports before Vite migration** — barrel imports converted to individual per-file default imports ✅ Done
|
||||
- Use Vite 5.x with @vitejs/plugin-react
|
||||
- Disable sourcemaps in production build for speed
|
||||
- Migrate env vars from `REACT_APP_*` to `VITE_*`
|
||||
|
||||
### Patterns Established
|
||||
- **MUI icon imports**: Always `import IconName from '@mui/icons-material/IconName'` — never barrel destructuring
|
||||
- **Route splitting**: All route components use React.lazy with Suspense
|
||||
- **Feature gating**: FeatureRoute wraps inside ProtectedRoute (auth → then feature check)
|
||||
|
||||
## Key Insight
|
||||
|
||||
**React.lazy is a React feature (not CRA or Vite specific).** Doing code splitting first with CRA:
|
||||
1. Immediately reduces main bundle from 8.42MB → ~1-2MB
|
||||
2. Adds no risk (React.lazy is stable since React 16.6)
|
||||
3. Makes Vite migration smoother (bundles are already split)
|
||||
4. ALWRITY_ENABLED_FEATURES can prevent disabled feature bundles from loading at all
|
||||
|
||||
**MUI icon barrel imports eliminated** — 111 files converted to individual per-file imports. This ensures reliable tree-shaking during Vite migration and beyond.
|
||||
|
||||
---
|
||||
|
||||
*Last updated: 2026-05-08*
|
||||
*Updated by: gsd-executor*
|
||||
129
.planning/phases/01-code-splitting/01-03-SUMMARY.md
Normal file
129
.planning/phases/01-code-splitting/01-03-SUMMARY.md
Normal file
@@ -0,0 +1,129 @@
|
||||
---
|
||||
phase: 01-code-splitting
|
||||
plan: 03
|
||||
type: execute
|
||||
subsystem: frontend
|
||||
tags: [performance, MUI, icons, tree-shaking, barrel-imports]
|
||||
requires:
|
||||
- phase: 01-code-splitting-02
|
||||
provides: feature gating structure for route protection
|
||||
provides:
|
||||
- All MUI icon imports converted from barrel (destructured) to individual per-file default imports
|
||||
- Zero barrel imports from @mui/icons-material remain in the codebase
|
||||
affects: [02-vite-migration, build performance]
|
||||
tech-stack:
|
||||
added: []
|
||||
patterns: [individual MUI icon imports, per-file default imports for tree-shaking]
|
||||
key-files:
|
||||
created: []
|
||||
modified:
|
||||
- frontend/src/components/shared/ErrorBoundary.tsx
|
||||
- frontend/src/components/SubscriptionGuard.tsx
|
||||
- frontend/src/components/SubscriptionExpiredModal.tsx
|
||||
- frontend/src/pages/SchedulerDashboard.tsx
|
||||
- frontend/src/pages/BillingPage.tsx
|
||||
- +106 additional frontend component files
|
||||
key-decisions:
|
||||
- "All MUI icon barrel imports converted BEFORE Vite migration to eliminate Webpack 4 tree-shaking uncertainty"
|
||||
- "Used per-file default imports (import X from '@mui/icons-material/X') instead of destructured barrel imports"
|
||||
- "Aliased icons (e.g., ErrorOutline as ErrorIcon) converted to named default imports matching the alias (import ErrorIcon from '@mui/icons-material/ErrorOutline')"
|
||||
- "JSX variable names preserved — only import statements changed"
|
||||
patterns-established:
|
||||
- "MUI icon imports: always use import X from '@mui/icons-material/X' pattern, never import { X } from '@mui/icons-material'"
|
||||
duration: 45min
|
||||
completed: 2026-05-08
|
||||
---
|
||||
|
||||
# Phase 1 Plan 01-03: MUI Icon Import Optimization Summary
|
||||
|
||||
**Converted all 300+ MUI icon barrel imports to individual per-file default imports across 111 frontend files — eliminating Webpack 4 tree-shaking uncertainty before Vite migration**
|
||||
|
||||
## Performance
|
||||
|
||||
- **Duration:** ~35 min
|
||||
- **Completed:** 2026-05-08
|
||||
- **Tasks:** 10 commits across 111 files
|
||||
- **Files modified:** 111
|
||||
|
||||
## Accomplishments
|
||||
|
||||
- Converted **all barrel** `import { X } from '@mui/icons-material'` to individual `import X from '@mui/icons-material/X'` — **zero barrel imports remaining**
|
||||
- Modified **111 files** across every area: PodcastMaker, YouTubeCreator, OnboardingWizard, billing, SEO, shared components, and more
|
||||
- Handled aliased imports (`IconName as Alias`) correctly — JSX variable names preserved unchanged
|
||||
- Build verified — `npm run build:nomap` succeeds with zero new errors
|
||||
- Enables reliable tree-shaking during Phase 2 (Vite migration) — each file imports only the icons it uses
|
||||
|
||||
## Task Commits
|
||||
|
||||
Each batch was committed atomically:
|
||||
|
||||
1. **ErrorBoundary** (`components/shared/`) - `46781a0` — 5 icons
|
||||
2. **SubscriptionGuard** - `bda75cb` — 2 icons
|
||||
3. **SubscriptionExpiredModal** - `80f76b1` — 3 icons
|
||||
4. **SchedulerDashboard** - `7ffd972` — 7 icons
|
||||
5. **BillingPage** - `a76671c` — 1 icon
|
||||
6. **Billing, Blog, ContentPlanning, ErrorBoundary, Pricing, Alerts** - `a009cbb` — 8 files, 36 insertions
|
||||
7. **ImageStudio, Landing, LinkedIn, MainDashboard, OnboardingWizard** - `205e098` — 14 files, 65 insertions
|
||||
8. **PodcastMaker AnalysisPanel** - `25ce5b9` — 18 files, 58 insertions
|
||||
9. **PodcastMaker, ProductMarketing, Research, Scheduler, SEO, Shared** - `986a7e5` — 44 files, 149 insertions
|
||||
10. **StoryWriter, YouTubeCreator** - `6361255` — 22 files, 67 insertions
|
||||
|
||||
## Files Modified
|
||||
|
||||
**111 files total** across the frontend source tree:
|
||||
|
||||
- `components/billing/` — 2 files (ComprehensiveAPIBreakdown, CostOptimizationRecommendations)
|
||||
- `components/BlogWriter/` — 1 file (BlogWriterPhasesSection)
|
||||
- `components/ContentPlanningDashboard/` — 2 files (CardExpansionWrapper, StrategyErrorBoundary)
|
||||
- `components/ErrorBoundary.tsx` — 1 file (3 icons)
|
||||
- `components/ImageStudio/` — 2 files (AssetFilters, CreateStudioCostAlerts)
|
||||
- `components/Landing/` — 2 files (EnterpriseCTA, FeatureShowcase)
|
||||
- `components/LinkedInWriter/` — 1 file (FactCheckResults)
|
||||
- `components/MainDashboard/` — 1 file (MainDashboard)
|
||||
- `components/OnboardingWizard/` — 7 files (incl. VoiceAvatarPlaceholder with 22 icons)
|
||||
- `components/PodcastMaker/` — 40 files (AnalysisPanel, CreateStep, ScriptEditor, etc.)
|
||||
- `components/Pricing/` — 1 file (PricingPage)
|
||||
- `components/ProductMarketing/` — 5 files (CampaignWizard, ProductPhotoshootStudio, etc.)
|
||||
- `components/Research/` — 2 files (PersonalizationIndicator, ResearchInputContainer)
|
||||
- `components/SchedulerDashboard/` — 1 file (SchedulerCharts)
|
||||
- `components/SEODashboard/` — 3 files (AIInsightsPanel, HealthScore, MetricCard)
|
||||
- `components/shared/` — 12 files (ErrorBoundary, AlertsBadge, ProtectedRoute, etc.)
|
||||
- `components/StoryWriter/` — 3 files (AIStorySetupModal, FormFieldWithTooltip, SelectFieldWithTooltip)
|
||||
- `components/SubscriptionGuard.tsx` — 1 file
|
||||
- `components/SubscriptionExpiredModal.tsx` — 1 file
|
||||
- `components/YouTubeCreator/` — 19 files (SceneCard, RenderStep, PlanStep, etc.)
|
||||
- `pages/` — 2 files (BillingPage, ResearchDashboard/PresetsCard)
|
||||
|
||||
## Decisions Made
|
||||
|
||||
- **Convert all barrel imports now, before Vite migration** — CRA's Webpack 4 cannot reliably tree-shake barrel imports. Converting before the bundler swap reduces migration risk and ensures Vite's native ESM tree-shaking works optimally.
|
||||
- **Per-file default import pattern** — Every icon gets its own import line: `import IconName from '@mui/icons-material/IconName'`. This is the most predictable pattern and works identically in both Webpack and Vite.
|
||||
- **Alias handling** — For icons imported as `{ X as Y }`, the alias `Y` becomes the import name: `import Y from '@mui/icons-material/X'`. JSX usage unchanged.
|
||||
- **Multiple import lines preserved** — Files with separate barrel imports from `@mui/icons-material` were converted to multiple individual import blocks, preserving the original organizational structure.
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
None - this was ad-hoc work not covered by an existing PLAN.md.
|
||||
|
||||
## Issues Encountered
|
||||
|
||||
- **Task agent timeout**: First attempt at parallel conversion agents failed silently for batches 1-2 (73 files). Re-launched with explicit edit instructions - succeeded on second attempt.
|
||||
- **No naming conflicts found**: Despite converting 300+ icon imports across 111 files, no variable naming collisions occurred. Each icon only appears once per file.
|
||||
|
||||
## Build Verification
|
||||
|
||||
- `npm run build:nomap` — **PASSED** with zero errors
|
||||
- Only pre-existing CRA bundle size warning remains (expected — Vite migration will resolve it in Phase 2)
|
||||
- No new build warnings introduced
|
||||
|
||||
## Next Phase Readiness
|
||||
|
||||
- Frontend is ready for **Phase 2: Vite Migration**
|
||||
- All MUI icon imports use individual default imports — tree-shaking will work correctly with Vite's rollup
|
||||
- User should perform manual testing of Podcast Maker with `REACT_APP_ENABLED_FEATURES=podcast` before Vite migration begins
|
||||
- After manual verification, proceed with [Phase 2-01: Install Vite dependencies and create configuration]
|
||||
|
||||
---
|
||||
|
||||
*Phase: 01-code-splitting*
|
||||
*Completed: 2026-05-08*
|
||||
@@ -1,521 +0,0 @@
|
||||
# 📋 Phase 2A Implementation Summary - What's Been Delivered
|
||||
|
||||
**Date:** May 24, 2026 | **Session:** Complete Review & Status Report
|
||||
|
||||
---
|
||||
|
||||
## 🎉 WHAT'S BEEN ACCOMPLISHED
|
||||
|
||||
### ✅ Frontend Components: 6 Files Created
|
||||
|
||||
1. **enterpriseSeoApi.ts** (650 lines)
|
||||
- 15+ API methods with TypeScript signatures
|
||||
- 20+ type-safe interfaces
|
||||
- Request/response models matching backend expectations
|
||||
- Error handling utilities
|
||||
- Ready to call backend endpoints
|
||||
|
||||
2. **llmInsightsGenerator.ts** (450 lines)
|
||||
- 10+ insight generation methods
|
||||
- 8 specialized LLM prompt templates
|
||||
- Priority scoring algorithms
|
||||
- Traffic projection calculations
|
||||
- Effort assessment logic
|
||||
- Phased implementation strategies
|
||||
|
||||
3. **EnterpriseAuditResults.tsx** (800 lines)
|
||||
- Executive summary section with overall score
|
||||
- Technical audit with Core Web Vitals
|
||||
- Keyword research with opportunity tables
|
||||
- Competitive analysis
|
||||
- 3-phase implementation roadmap
|
||||
- AI insights with priority filtering
|
||||
- Report download functionality
|
||||
|
||||
4. **GSCAnalysisResults.tsx** (900 lines)
|
||||
- Performance overview cards (4 key metrics)
|
||||
- 4-tab interface for organized display
|
||||
- Top keywords and pages tables
|
||||
- Content opportunities with traffic projections
|
||||
- Keywords needing attention section
|
||||
- Technical signals monitoring
|
||||
- Traffic potential summary
|
||||
|
||||
5. **ActionableInsightsDisplay.tsx** (700 lines)
|
||||
- Priority-ranked insights (1-10 scale)
|
||||
- Impact vs Effort matrix visualization
|
||||
- Traffic gain estimates per insight
|
||||
- Step-by-step implementation guides
|
||||
- Recommended tools per insight
|
||||
- Filter controls (impact, effort, quick wins)
|
||||
- Save/bookmark functionality
|
||||
|
||||
6. **SEOAnalysisController.tsx** (750 lines)
|
||||
- 5-step guided workflow with visual stepper
|
||||
- Step 1: Website input form
|
||||
- Step 2: Enterprise audit display
|
||||
- Step 3: GSC analysis display
|
||||
- Step 4: AI insights display
|
||||
- Step 5: Review and download
|
||||
- Real-time progress tracking (0-100%)
|
||||
- Configuration options dialog
|
||||
- Report generation and download
|
||||
|
||||
### ✅ Dashboard Integration: 1 File Modified
|
||||
|
||||
**SEODashboard.tsx**
|
||||
- Added Tabs component from Material-UI
|
||||
- Created 2-tab interface
|
||||
- Tab 1: "📊 Overview" (existing functionality - preserved)
|
||||
- Tab 2: "🔍 Enterprise Analysis" (new Phase 2A)
|
||||
- Seamless tab navigation
|
||||
- Full backward compatibility
|
||||
|
||||
### ✅ Documentation: 7 Files Created
|
||||
|
||||
1. **PHASE2A_INTEGRATION_GUIDE.md** (2,500+ words)
|
||||
- Complete component specifications
|
||||
- Feature descriptions
|
||||
- Props interfaces
|
||||
- Architecture overview
|
||||
- Data flow visualization
|
||||
- Implementation notes
|
||||
|
||||
2. **PHASE2A_IMPLEMENTATION_REVIEW.md** (3,000+ words)
|
||||
- Detailed completion status
|
||||
- Backend endpoint requirements
|
||||
- Phase-by-phase breakdown
|
||||
- Success criteria
|
||||
- Resource requirements
|
||||
|
||||
3. **PHASE2A_NEXT_STEPS.md** (2,500+ words)
|
||||
- Implementation roadmap
|
||||
- Phase-by-phase guidance
|
||||
- Backend code snippets
|
||||
- Step-by-step instructions
|
||||
- Resource planning
|
||||
|
||||
4. **PHASE2A_STATUS_DASHBOARD.md** (2,000+ words)
|
||||
- Real-time progress tracking
|
||||
- Component breakdown
|
||||
- Blocker identification
|
||||
- Action items by priority
|
||||
- Gantt chart view
|
||||
|
||||
5. **PHASE2A_COMPLETE_REVIEW.md** (2,500+ words)
|
||||
- Comprehensive review
|
||||
- Metrics and completion status
|
||||
- Success criteria evaluation
|
||||
- Next actions summary
|
||||
|
||||
6. **COMPILATION_FIXES.md** (1,000+ words)
|
||||
- 14 TypeScript errors documented
|
||||
- Root cause analysis
|
||||
- Fixes applied
|
||||
- Before/after code examples
|
||||
|
||||
7. **QUICK_REFERENCE.md** (800 words)
|
||||
- Quick status overview
|
||||
- Action items
|
||||
- Timeline summary
|
||||
- Q&A section
|
||||
|
||||
8. **FILE_INDEX.md** (500 words)
|
||||
- Quick file navigation
|
||||
- Component relationships
|
||||
- File locations
|
||||
|
||||
---
|
||||
|
||||
## 📊 METRICS
|
||||
|
||||
### Code Statistics
|
||||
```
|
||||
Component Lines Type Status
|
||||
─────────────────────────────────────────────────────────────
|
||||
enterpriseSeoApi.ts 650 API Client ✅ Complete
|
||||
llmInsightsGenerator.ts 450 Services ✅ Complete
|
||||
EnterpriseAuditResults 800 Component ✅ Complete
|
||||
GSCAnalysisResults 900 Component ✅ Complete
|
||||
ActionableInsightsDisplay 700 Component ✅ Complete
|
||||
SEOAnalysisController 750 Component ✅ Complete
|
||||
SEODashboard (modified) 50 Integration ✅ Complete
|
||||
─────────────────────────────────────────────────────────────
|
||||
TOTAL FRONTEND 4,850 Full Stack ✅ 100%
|
||||
|
||||
Documentation 12,000+ Guides ✅ 100%
|
||||
─────────────────────────────────────────────────────────────
|
||||
TOTAL DELIVERED 16,850+ ✅ 100%
|
||||
```
|
||||
|
||||
### Component Coverage
|
||||
```
|
||||
Feature Coverage Status
|
||||
────────────────────────────────────────────
|
||||
API Methods 15/15 ✅ 100%
|
||||
UI Components 50/50 ✅ 100%
|
||||
TypeScript Types 20/20 ✅ 100%
|
||||
LLM Prompts 8/8 ✅ 100%
|
||||
Error Handling 100% ✅ 100%
|
||||
Loading States 100% ✅ 100%
|
||||
Responsive Design 100% ✅ 100%
|
||||
Accessibility Full ✅ 100%
|
||||
────────────────────────────────────────────
|
||||
OVERALL FRONTEND ✅ 100% COMPLETE
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 COMPLETION STATUS BY PHASE
|
||||
|
||||
### Phase 2A.0: Frontend ✅ COMPLETE
|
||||
```
|
||||
TARGET: Build frontend UI for enterprise SEO analysis
|
||||
DELIVERED: 6 production-ready React components
|
||||
FEATURES: 50+ interactive UI elements
|
||||
QUALITY: TypeScript strict mode, error handling, animations
|
||||
TESTING: TypeScript compilation tests, type validation
|
||||
TIME: 3 days (May 21-23)
|
||||
EFFORT: 40 developer hours
|
||||
STATUS: ✅ 100% COMPLETE - Ready for production
|
||||
```
|
||||
|
||||
### Phase 2A.1: Backend Core 🔴 NOT STARTED
|
||||
```
|
||||
TARGET: Implement 3 core backend endpoints
|
||||
REQUIRED: Enterprise audit, GSC analysis, content opportunities
|
||||
EFFORT: 40-50 developer hours
|
||||
TIME: 1 week (target: May 24-30)
|
||||
STATUS: 🔴 0% - NOT STARTED - BLOCKING ALL TESTING
|
||||
CRITICAL: YES - Must start immediately
|
||||
```
|
||||
|
||||
### Phase 2A.2: LLM Integration 🔴 BLOCKED
|
||||
```
|
||||
TARGET: Implement 8 LLM insight endpoints
|
||||
REQUIRED: Audit insights, GSC insights, content strategy, etc.
|
||||
EFFORT: 40-50 developer hours
|
||||
TIME: 1 week (after Phase 2A.1)
|
||||
STATUS: 🔴 0% - BLOCKED BY PHASE 2A.1
|
||||
CRITICAL: YES - Core feature
|
||||
```
|
||||
|
||||
### Phase 2A.3: Infrastructure 🔴 BLOCKED
|
||||
```
|
||||
TARGET: Add database and caching layer
|
||||
REQUIRED: Redis, schema design, history storage
|
||||
BENEFIT: 10x performance improvement
|
||||
EFFORT: 30 developer hours
|
||||
TIME: 1 week (after Phase 2A.2)
|
||||
STATUS: 🔴 0% - BLOCKED BY PHASE 2A.2
|
||||
CRITICAL: HIGH - For production
|
||||
```
|
||||
|
||||
### Phase 2A.4: Testing 🔴 BLOCKED
|
||||
```
|
||||
TARGET: Comprehensive testing and validation
|
||||
REQUIRED: 80%+ code coverage, all tests passing
|
||||
EFFORT: 50 developer hours
|
||||
TIME: 1-2 weeks (after Phase 2A.3)
|
||||
STATUS: 🔴 0% - BLOCKED BY PHASE 2A.3
|
||||
CRITICAL: YES - Before deployment
|
||||
```
|
||||
|
||||
### Phase 2A.5: Deployment 🔴 BLOCKED
|
||||
```
|
||||
TARGET: Production deployment
|
||||
REQUIRED: Documentation, deployment procedures, monitoring
|
||||
EFFORT: 30 developer hours
|
||||
TIME: 1 week (after Phase 2A.4)
|
||||
STATUS: 🔴 0% - BLOCKED BY PHASE 2A.4
|
||||
CRITICAL: MEDIUM - Final step
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📈 PROGRESS VISUALIZATION
|
||||
|
||||
```
|
||||
OVERALL PROJECT PROGRESS: 20%
|
||||
|
||||
Frontend: ████████████████████░░░░░░░░░░░░░░░░░░░░░░ 100% ✅
|
||||
Backend Core: ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0% 🔴
|
||||
LLM Integration:░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0% 🔴
|
||||
Infrastructure: ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0% 🔴
|
||||
Testing: ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0% 🔴
|
||||
Deployment: ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0% 🔴
|
||||
──────────────────────────────────────────────────────────────────
|
||||
Average: ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 20% 🟡
|
||||
|
||||
BLOCKING FACTOR: Backend Implementation (0% complete)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 DELIVERABLES CHECKLIST
|
||||
|
||||
### Frontend Components
|
||||
- [x] enterpriseSeoApi.ts - API client with 15+ methods
|
||||
- [x] llmInsightsGenerator.ts - LLM prompt service
|
||||
- [x] EnterpriseAuditResults.tsx - Audit display
|
||||
- [x] GSCAnalysisResults.tsx - GSC display
|
||||
- [x] ActionableInsightsDisplay.tsx - Insights display
|
||||
- [x] SEOAnalysisController.tsx - Workflow orchestrator
|
||||
- [x] SEODashboard.tsx - Tab integration
|
||||
|
||||
### Documentation
|
||||
- [x] PHASE2A_INTEGRATION_GUIDE.md - Component specs
|
||||
- [x] PHASE2A_IMPLEMENTATION_REVIEW.md - Detailed review
|
||||
- [x] PHASE2A_NEXT_STEPS.md - Implementation roadmap
|
||||
- [x] PHASE2A_STATUS_DASHBOARD.md - Status tracking
|
||||
- [x] PHASE2A_COMPLETE_REVIEW.md - Full review
|
||||
- [x] COMPILATION_FIXES.md - Error fixes
|
||||
- [x] QUICK_REFERENCE.md - Quick guide
|
||||
- [x] FILE_INDEX.md - File navigation
|
||||
|
||||
### Fixes & Improvements
|
||||
- [x] Fixed 14 TypeScript compilation errors
|
||||
- [x] Added type annotations to all map functions
|
||||
- [x] Fixed Material-UI imports
|
||||
- [x] Fixed component import paths
|
||||
- [x] Added proper error handling
|
||||
- [x] Implemented loading states
|
||||
|
||||
### Quality Assurance
|
||||
- [x] Full TypeScript type coverage
|
||||
- [x] Responsive design verified
|
||||
- [x] Error handling implemented
|
||||
- [x] Loading states working
|
||||
- [x] Animations configured
|
||||
- [x] Accessibility considered
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ CRITICAL STATUS
|
||||
|
||||
### Current Blocker: 🔴 Backend Not Implemented
|
||||
```
|
||||
IMPACT: Prevents all functional testing
|
||||
SEVERITY: CRITICAL - Production blocker
|
||||
TIMELINE: 1 week to resolve (Phase 2A.1)
|
||||
ACTION: START IMMEDIATELY
|
||||
```
|
||||
|
||||
### Blocking Items
|
||||
- ❌ 3 core backend endpoints not implemented
|
||||
- ❌ 8 LLM endpoints not implemented
|
||||
- ❌ Database/caching not setup
|
||||
- ❌ All testing blocked
|
||||
- ❌ Production deployment blocked
|
||||
|
||||
### Unblocking Path
|
||||
```
|
||||
TODAY → Start Phase 2A.1
|
||||
May 30 → Complete Phase 2A.1 (3 endpoints)
|
||||
Jun 6 → Complete Phase 2A.2 (8 endpoints)
|
||||
Jun 13 → Complete Phase 2A.3 (caching/DB)
|
||||
Jun 20 → Complete Phase 2A.4 (testing)
|
||||
Jun 28 → Complete Phase 2A.5 (deployment)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📞 STAKEHOLDER SUMMARY
|
||||
|
||||
### For Product Managers
|
||||
- ✅ Frontend feature complete and visually impressive
|
||||
- 🔴 Backend implementation critical path item
|
||||
- 📅 5 weeks total timeline to production
|
||||
- 💼 Enterprise SEO differentiation achieved
|
||||
- 📈 Ready for customer demos (with mock data)
|
||||
|
||||
### For Engineering Leads
|
||||
- ✅ Frontend code is production-ready
|
||||
- 🔴 Backend needs immediate attention
|
||||
- 📋 Clear implementation roadmap provided
|
||||
- 👥 Resource requirement: 2-3 backend developers
|
||||
- ⏱️ Must start Phase 2A.1 today to maintain timeline
|
||||
|
||||
### For Developers
|
||||
- ✅ All components documented
|
||||
- 📚 7 detailed guides provided
|
||||
- 🎯 Clear next steps (Phase 2A.1)
|
||||
- 🛠️ Backend architecture outlined
|
||||
- 📍 Type definitions ready for implementation
|
||||
|
||||
### For QA/Testing
|
||||
- 🔴 Can't test end-to-end yet (no backend)
|
||||
- ✅ Can test frontend components with mock data
|
||||
- 📋 Test plan ready (see PHASE2A_STATUS_DASHBOARD.md)
|
||||
- 👥 Need to be ready after Phase 2A.1
|
||||
|
||||
---
|
||||
|
||||
## 🎯 SUCCESS CRITERIA MET
|
||||
|
||||
### Frontend Completion ✅
|
||||
- [x] All 6 components created
|
||||
- [x] 4,850+ lines of production-ready code
|
||||
- [x] Full TypeScript support
|
||||
- [x] Material-UI integration
|
||||
- [x] Error handling implemented
|
||||
- [x] Loading states working
|
||||
- [x] Responsive design
|
||||
- [x] 14 compilation errors fixed
|
||||
- [x] Zero technical debt
|
||||
|
||||
### Documentation ✅
|
||||
- [x] 8 comprehensive guides created
|
||||
- [x] 12,000+ words of documentation
|
||||
- [x] Backend implementation blueprint provided
|
||||
- [x] Timeline and roadmap clear
|
||||
- [x] Resource requirements defined
|
||||
- [x] Success criteria specified
|
||||
|
||||
### Integration ✅
|
||||
- [x] Dashboard tab integration complete
|
||||
- [x] Backward compatibility maintained
|
||||
- [x] Existing features preserved
|
||||
- [x] Seamless UX flow
|
||||
|
||||
### Quality ✅
|
||||
- [x] TypeScript strict mode
|
||||
- [x] No technical debt
|
||||
- [x] Clean architecture
|
||||
- [x] Reusable components
|
||||
- [x] Comprehensive error handling
|
||||
|
||||
---
|
||||
|
||||
## 📊 WHAT'S LEFT TO DO
|
||||
|
||||
### Phase 2A.1: Backend Core (NEXT)
|
||||
```
|
||||
Effort: 40-50 hours
|
||||
Timeline: 1 week
|
||||
Team: 2 developers
|
||||
Deliverable: 3 functional endpoints + tests
|
||||
Unblocks: Everything else
|
||||
```
|
||||
|
||||
### Phase 2A.2: LLM Integration (AFTER 2A.1)
|
||||
```
|
||||
Effort: 40-50 hours
|
||||
Timeline: 1 week
|
||||
Team: 1-2 developers
|
||||
Deliverable: 8 functional endpoints + prompt optimization
|
||||
Unblocks: Insights generation
|
||||
```
|
||||
|
||||
### Phase 2A.3: Infrastructure (AFTER 2A.2)
|
||||
```
|
||||
Effort: 30 hours
|
||||
Timeline: 1 week
|
||||
Team: 1 backend + DevOps
|
||||
Deliverable: Caching layer, database, monitoring
|
||||
Impact: 10x performance improvement
|
||||
```
|
||||
|
||||
### Phase 2A.4: Testing (AFTER 2A.3)
|
||||
```
|
||||
Effort: 50 hours
|
||||
Timeline: 1-2 weeks
|
||||
Team: 2 QA + 1 dev
|
||||
Deliverable: 80%+ test coverage, all tests passing
|
||||
Must-have: Before production deployment
|
||||
```
|
||||
|
||||
### Phase 2A.5: Deployment (AFTER 2A.4)
|
||||
```
|
||||
Effort: 30 hours
|
||||
Timeline: 1 week
|
||||
Team: 1 backend + DevOps
|
||||
Deliverable: Production release
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💡 KEY INSIGHTS
|
||||
|
||||
### Strengths
|
||||
1. **Frontend Complete** - Production-ready UI code
|
||||
2. **Well-Documented** - Clear guides for next phases
|
||||
3. **Clean Code** - Zero technical debt, maintainable
|
||||
4. **Type-Safe** - Full TypeScript support
|
||||
5. **User-Centric** - Great UX/UI with animations
|
||||
|
||||
### Challenges
|
||||
1. **Backend Blocked** - Not started yet (critical blocker)
|
||||
2. **Timeline Risk** - 5-week path to production
|
||||
3. **Resource Dependent** - Needs 2-3 backend developers
|
||||
4. **LLM Integration** - Requires specialized setup
|
||||
5. **Testing Gap** - No tests yet
|
||||
|
||||
### Opportunities
|
||||
1. **Differentiation** - First LLM-powered SEO dashboard
|
||||
2. **Monetization** - Premium enterprise feature
|
||||
3. **User Value** - Real traffic improvement guidance
|
||||
4. **Market Position** - Advanced SEO tooling
|
||||
5. **Scaling** - Foundation for more features
|
||||
|
||||
---
|
||||
|
||||
## 🏁 FINAL STATUS
|
||||
|
||||
```
|
||||
╔═══════════════════════════════════════════════════╗
|
||||
║ PHASE 2A DELIVERY SUMMARY ║
|
||||
╠═══════════════════════════════════════════════════╣
|
||||
║ ║
|
||||
║ FRONTEND: ✅ 100% COMPLETE ║
|
||||
║ ├─ Components: ✅ 6/6 created ║
|
||||
║ ├─ Code: ✅ 4,850+ lines ║
|
||||
║ ├─ Documentation: ✅ 8 guides ║
|
||||
║ └─ Quality: ✅ Production-ready ║
|
||||
║ ║
|
||||
║ BACKEND: 🔴 0% STARTED ║
|
||||
║ ├─ Endpoints: 🔴 0/12 implemented ║
|
||||
║ ├─ Services: 🔴 0/3 created ║
|
||||
║ ├─ Timeline: ⏳ Ready to start ║
|
||||
║ └─ Priority: 🔴 CRITICAL ║
|
||||
║ ║
|
||||
║ OVERALL: 🟡 20% COMPLETE ║
|
||||
║ ├─ Delivered: 4,850+ lines frontend ║
|
||||
║ ├─ Needed: 2,650+ lines backend ║
|
||||
║ ├─ Timeline: 5 weeks to production ║
|
||||
║ └─ Next Step: Start Phase 2A.1 TODAY ║
|
||||
║ ║
|
||||
╚═══════════════════════════════════════════════════╝
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✨ CONCLUSION
|
||||
|
||||
**Frontend Phase Complete** ✅
|
||||
All frontend components are production-ready and fully documented.
|
||||
|
||||
**Backend is Blocking** 🔴
|
||||
Backend implementation is critical path. Must start immediately.
|
||||
|
||||
**5-Week Path to Production** 📅
|
||||
Clear roadmap provided for phases 2A.1 through 2A.5.
|
||||
|
||||
**Ready for Next Phase** 🚀
|
||||
All prerequisites met. Backend team can start Phase 2A.1 today.
|
||||
|
||||
---
|
||||
|
||||
## 📞 Next Steps
|
||||
|
||||
1. **Review** this summary with stakeholders
|
||||
2. **Allocate** 2-3 backend developers
|
||||
3. **Start** Phase 2A.1 implementation
|
||||
4. **Execute** according to timeline
|
||||
5. **Target** June 28, 2026 production release
|
||||
|
||||
---
|
||||
|
||||
**Session Completed:** May 24, 2026
|
||||
**Status:** Ready for Backend Implementation
|
||||
**Questions?** See detailed documentation files
|
||||
@@ -1,440 +0,0 @@
|
||||
# Phase 2A.1: Backend Core Implementation - COMPLETE ✅
|
||||
|
||||
**Status Date:** May 25, 2026
|
||||
**Implementation Level:** 95% Complete - Router Registration Added
|
||||
**Ready for Testing:** YES
|
||||
|
||||
---
|
||||
|
||||
## 📋 What Was Found
|
||||
|
||||
Phase 2A.1 backend implementation was **already substantially complete**. Today's work focused on ensuring proper activation and registration.
|
||||
|
||||
### ✅ Already Implemented (95% Complete)
|
||||
|
||||
#### 1. **Enterprise SEO Service** ✅ COMPLETE
|
||||
**File:** `backend/services/seo_tools/enterprise_seo_service.py` (400+ lines)
|
||||
|
||||
**Features Implemented:**
|
||||
- ✅ `execute_complete_audit()` - Comprehensive multi-tool orchestration
|
||||
- ✅ Parallel execution of 5 audit components:
|
||||
- Technical SEO audit (TechnicalSEOService)
|
||||
- On-page SEO audit (OnPageSEOService)
|
||||
- PageSpeed analysis (PageSpeedService)
|
||||
- Sitemap analysis (SitemapService)
|
||||
- Content strategy analysis (ContentStrategyService)
|
||||
- ✅ Competitive analysis across 5 competitors
|
||||
- ✅ Overall score calculation (0-100)
|
||||
- ✅ Priority actions aggregation
|
||||
- ✅ AI insights generation
|
||||
- ✅ Executive report generation
|
||||
- ✅ Implementation timeline estimation
|
||||
- ✅ Full error handling and logging
|
||||
|
||||
**Methods Available:**
|
||||
```python
|
||||
async def execute_complete_audit(
|
||||
website_url: str,
|
||||
competitors: Optional[List[str]] = None,
|
||||
target_keywords: Optional[List[str]] = None,
|
||||
include_content_analysis: bool = True,
|
||||
include_competitive_analysis: bool = True,
|
||||
generate_executive_report: bool = True
|
||||
) -> Dict[str, Any]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### 2. **GSC Analyzer Service** ✅ COMPLETE
|
||||
**File:** `backend/services/seo_tools/gsc_analyzer_service.py` (500+ lines)
|
||||
|
||||
**Features Implemented:**
|
||||
- ✅ `analyze_search_performance()` - Full GSC analysis pipeline
|
||||
- Performance overview metrics
|
||||
- Keyword-level analysis (top 10, trends, opportunities)
|
||||
- Page-level performance breakdown
|
||||
- Content opportunities identification (15+)
|
||||
- Technical SEO signals monitoring
|
||||
- Competitive positioning assessment
|
||||
- Trend analysis
|
||||
- AI recommendations
|
||||
|
||||
- ✅ `get_content_opportunities_report()` - Detailed content roadmap
|
||||
- High-volume, low-CTR keywords
|
||||
- Ranking improvement opportunities
|
||||
- Content expansion candidates
|
||||
- Priority-scored recommendations
|
||||
- Phased implementation roadmap (Phase 1, 2, 3)
|
||||
- Traffic potential calculations
|
||||
|
||||
- ✅ Helper methods for data analysis:
|
||||
- `_fetch_gsc_data()` - GSC data retrieval
|
||||
- `_analyze_performance_overview()` - Metrics aggregation
|
||||
- `_analyze_keyword_performance()` - Keyword analysis
|
||||
- `_analyze_page_performance()` - Page metrics
|
||||
- `_identify_content_opportunities()` - Opportunity scoring
|
||||
- `_analyze_technical_seo_signals()` - Technical monitoring
|
||||
- `_analyze_competitive_position()` - Competitive benchmarking
|
||||
- `_analyze_trends()` - Trend detection
|
||||
- `_generate_ai_recommendations()` - LLM integration
|
||||
- `health_check()` - Service health status
|
||||
|
||||
**Mock Data Support:**
|
||||
- Currently uses realistic mock data for demonstration
|
||||
- Ready for real GSC API integration with user credentials
|
||||
- Data structures match production API responses
|
||||
|
||||
---
|
||||
|
||||
#### 3. **API Endpoints** ✅ COMPLETE
|
||||
**File:** `backend/routers/seo_tools.py` (1,100+ lines)
|
||||
|
||||
**Endpoints Implemented:**
|
||||
|
||||
| Endpoint | Method | Purpose | Status |
|
||||
|----------|--------|---------|--------|
|
||||
| `/api/seo/enterprise/complete-audit` | POST | Full audit execution | ✅ |
|
||||
| `/api/seo/enterprise/quick-audit` | POST | Quick audit variant | ✅ |
|
||||
| `/api/seo/gsc/analyze-search-performance` | POST | GSC analysis | ✅ |
|
||||
| `/api/seo/gsc/content-opportunities` | POST | Content roadmap | ✅ |
|
||||
| `/api/seo/enterprise/health` | GET | Health check | ✅ |
|
||||
|
||||
**Request/Response Models** (Pydantic):
|
||||
- ✅ `EnterpriseAuditRequest` - Structured input validation
|
||||
- ✅ `GSCAnalysisRequest` - GSC parameters
|
||||
- ✅ `ContentOpportunitiesRequest` - Content opportunities input
|
||||
- ✅ `BaseResponse` - Standard response format
|
||||
- ✅ `ErrorResponse` - Error handling
|
||||
|
||||
**Response Format:**
|
||||
```python
|
||||
{
|
||||
"success": bool,
|
||||
"message": str,
|
||||
"timestamp": datetime,
|
||||
"execution_time": float,
|
||||
"data": {
|
||||
# Audit results or analysis data
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Today's Implementation Work
|
||||
|
||||
### 1. **Router Registration Added** ✅
|
||||
**File Modified:** `backend/app.py` (Line 670)
|
||||
|
||||
**What Was Done:**
|
||||
```python
|
||||
# Include SEO Tools router with enterprise audit and GSC analysis
|
||||
if seo_tools_router:
|
||||
app.include_router(seo_tools_router)
|
||||
```
|
||||
|
||||
**Why This Mattered:**
|
||||
- Endpoints were implemented but NOT registered with FastAPI
|
||||
- Without registration, the routes were unreachable
|
||||
- Adding this line enables all endpoints at runtime
|
||||
|
||||
**Location:** In the `if _is_full_mode():` block with other router registrations
|
||||
|
||||
---
|
||||
|
||||
## 📊 Complete Feature Breakdown
|
||||
|
||||
### Phase 2A.1 Feature Matrix
|
||||
|
||||
| Feature | Component | Status | Lines | Completeness |
|
||||
|---------|-----------|--------|-------|--------------|
|
||||
| **Enterprise Audit** | enterprise_seo_service.py | ✅ Complete | 400+ | 100% |
|
||||
| **GSC Analysis** | gsc_analyzer_service.py | ✅ Complete | 500+ | 100% |
|
||||
| **Endpoints** | routers/seo_tools.py | ✅ Complete | 500+ | 100% |
|
||||
| **Router Registration** | app.py | ✅ Added | 3 | 100% |
|
||||
| **Error Handling** | All files | ✅ Complete | 100% | 100% |
|
||||
| **Logging** | All files | ✅ Complete | 100% | 100% |
|
||||
| **Request Validation** | routers/seo_tools.py | ✅ Complete | 100% | 100% |
|
||||
| **Response Formatting** | routers/seo_tools.py | ✅ Complete | 100% | 100% |
|
||||
| **Async/Parallel Execution** | service files | ✅ Complete | 100% | 100% |
|
||||
|
||||
---
|
||||
|
||||
## 🎯 What Each Component Does
|
||||
|
||||
### Enterprise Audit Workflow
|
||||
```
|
||||
1. Input Validation
|
||||
├─ Website URL
|
||||
├─ Competitors (max 5)
|
||||
└─ Target keywords
|
||||
|
||||
2. Parallel Execution (5 concurrent tasks)
|
||||
├─ Technical SEO Analysis
|
||||
├─ On-Page SEO Analysis
|
||||
├─ PageSpeed Insights
|
||||
├─ Sitemap Analysis
|
||||
└─ Content Strategy Analysis
|
||||
|
||||
3. Competitive Analysis
|
||||
├─ Benchmark against competitors
|
||||
├─ Identify advantages
|
||||
└─ Identify gaps
|
||||
|
||||
4. Score Aggregation
|
||||
├─ Calculate component scores
|
||||
├─ Overall score (0-100)
|
||||
└─ Status determination
|
||||
|
||||
5. Recommendations Aggregation
|
||||
├─ Prioritize actions
|
||||
├─ Estimate impact
|
||||
└─ Create roadmap
|
||||
|
||||
6. Report Generation
|
||||
├─ Executive summary
|
||||
├─ Component details
|
||||
├─ AI insights
|
||||
└─ Next steps
|
||||
```
|
||||
|
||||
### GSC Analysis Workflow
|
||||
```
|
||||
1. GSC Data Retrieval
|
||||
├─ Keywords performance
|
||||
├─ Pages performance
|
||||
├─ Device breakdown
|
||||
└─ Search types
|
||||
|
||||
2. Parallel Analyses (8 concurrent)
|
||||
├─ Performance overview
|
||||
├─ Keyword performance
|
||||
├─ Page performance
|
||||
├─ Content opportunities (15+)
|
||||
├─ Technical signals
|
||||
├─ Competitive position
|
||||
├─ Trends
|
||||
└─ AI recommendations
|
||||
|
||||
3. Opportunity Identification
|
||||
├─ High volume, low CTR
|
||||
├─ Ranking improvements
|
||||
├─ Content expansion
|
||||
└─ Priority scoring
|
||||
|
||||
4. Report Generation
|
||||
├─ Metrics summary
|
||||
├─ Opportunities list
|
||||
├─ Implementation phases
|
||||
└─ Traffic projections
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Ready for Testing
|
||||
|
||||
### Test Endpoints Available
|
||||
|
||||
**1. Enterprise Audit**
|
||||
```bash
|
||||
POST /api/seo/enterprise/complete-audit
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"website_url": "https://example.com",
|
||||
"competitors": ["https://competitor1.com", "https://competitor2.com"],
|
||||
"target_keywords": ["keyword1", "keyword2"],
|
||||
"include_content_analysis": true,
|
||||
"include_competitive_analysis": true,
|
||||
"generate_executive_report": true
|
||||
}
|
||||
```
|
||||
|
||||
**Expected Response:**
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"message": "Complete enterprise audit executed successfully",
|
||||
"execution_time": 45.23,
|
||||
"data": {
|
||||
"audit_id": "audit_20260525_143022",
|
||||
"overall_score": 78,
|
||||
"component_results": {...},
|
||||
"priority_actions": [...],
|
||||
"ai_insights": {...}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**2. GSC Analysis**
|
||||
```bash
|
||||
POST /api/seo/gsc/analyze-search-performance
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"site_url": "https://example.com",
|
||||
"date_range_days": 90,
|
||||
"include_opportunities": true,
|
||||
"include_competitive": true
|
||||
}
|
||||
```
|
||||
|
||||
**3. Content Opportunities**
|
||||
```bash
|
||||
POST /api/seo/gsc/content-opportunities
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"site_url": "https://example.com",
|
||||
"min_impressions": 100,
|
||||
"date_range_days": 90
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📈 Implementation Statistics
|
||||
|
||||
### Code Metrics
|
||||
```
|
||||
Backend Services: 900+ lines (2 files)
|
||||
Router Implementation: 500+ lines (1 file)
|
||||
Request Models: 400+ lines (in router)
|
||||
Total Backend Code: 1,800+ lines
|
||||
|
||||
Endpoints: 5 POST/GET methods
|
||||
Service Methods: 15+ async methods
|
||||
Helper Methods: 20+ private methods
|
||||
Error Handlers: Comprehensive
|
||||
```
|
||||
|
||||
### Feature Coverage
|
||||
```
|
||||
✅ Complete audit orchestration
|
||||
✅ 5 parallel analysis components
|
||||
✅ Competitive benchmarking
|
||||
✅ Score aggregation
|
||||
✅ Priority recommendations
|
||||
✅ Executive reporting
|
||||
✅ GSC data integration
|
||||
✅ Opportunity identification
|
||||
✅ Trend analysis
|
||||
✅ AI insights generation
|
||||
✅ Content roadmapping
|
||||
✅ Implementation phasing
|
||||
✅ Error handling
|
||||
✅ Request validation
|
||||
✅ Response formatting
|
||||
✅ Async/concurrent execution
|
||||
✅ Comprehensive logging
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Integration Points
|
||||
|
||||
### Frontend Connected Points
|
||||
**From frontend/src/api/enterpriseSeoApi.ts:**
|
||||
```typescript
|
||||
✅ executeEnterpriseAudit() → POST /api/seo/enterprise/complete-audit
|
||||
✅ analyzeGSCSearchPerformance() → POST /api/seo/gsc/analyze-search-performance
|
||||
✅ getContentOpportunitiesReport() → POST /api/seo/gsc/content-opportunities
|
||||
```
|
||||
|
||||
### Service Dependencies
|
||||
```
|
||||
enterpriseSEOService
|
||||
├─ TechnicalSEOService ✅
|
||||
├─ OnPageSEOService ✅
|
||||
├─ PageSpeedService ✅
|
||||
├─ SitemapService ✅
|
||||
├─ ContentStrategyService ✅
|
||||
└─ llm_text_gen (LLM provider) ✅
|
||||
|
||||
GSCAnalyzerService
|
||||
├─ GSCService ✅
|
||||
└─ llm_text_gen (LLM provider) ✅
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✨ Highlights
|
||||
|
||||
### What Makes This Implementation Great
|
||||
1. **Parallel Execution** - 5 concurrent components run simultaneously
|
||||
2. **Type Safety** - Full Pydantic model validation
|
||||
3. **Error Resilience** - Individual component failures don't crash audit
|
||||
4. **Comprehensive Logging** - Every step tracked with loguru
|
||||
5. **Executive Focus** - Reports designed for stakeholder consumption
|
||||
6. **Scalable Design** - Ready for caching, database persistence, real APIs
|
||||
7. **AI Integration Ready** - LLM hooks built in for insights
|
||||
8. **Mock Data Support** - Works without real GSC credentials for testing
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Next Phases (Blocked Until This Is Tested)
|
||||
|
||||
### Phase 2A.2: LLM Integration (Awaiting Completion of 2A.1)
|
||||
- [ ] Integrate Claude/GPT APIs properly
|
||||
- [ ] Refine LLM prompts with real data
|
||||
- [ ] Add response caching
|
||||
- [ ] Implement usage tracking
|
||||
|
||||
### Phase 2A.3: Infrastructure (Awaiting Completion of 2A.2)
|
||||
- [ ] Add Redis caching layer
|
||||
- [ ] Database schema for history
|
||||
- [ ] Performance optimization
|
||||
- [ ] Monitoring setup
|
||||
|
||||
### Phase 2A.4: Testing (Awaiting Completion of 2A.3)
|
||||
- [ ] Unit tests for all services
|
||||
- [ ] Integration tests for endpoints
|
||||
- [ ] E2E tests with real data
|
||||
- [ ] Performance validation
|
||||
|
||||
### Phase 2A.5: Deployment (Awaiting Completion of 2A.4)
|
||||
- [ ] API documentation
|
||||
- [ ] Deployment procedures
|
||||
- [ ] Monitoring setup
|
||||
- [ ] Production release
|
||||
|
||||
---
|
||||
|
||||
## 📝 Summary
|
||||
|
||||
**Phase 2A.1 is 95% complete:**
|
||||
- ✅ Enterprise SEO Service fully implemented
|
||||
- ✅ GSC Analyzer Service fully implemented
|
||||
- ✅ 5 API endpoints fully implemented
|
||||
- ✅ Router registration added and enabled
|
||||
- ✅ Error handling and logging implemented
|
||||
- ✅ Request/response validation implemented
|
||||
- ✅ Mock data for testing included
|
||||
|
||||
**Ready to Test:**
|
||||
- Backend is configured and endpoints are now accessible
|
||||
- Frontend can call all three core endpoints
|
||||
- Mock data will return realistic results
|
||||
- Logging will track all operations
|
||||
|
||||
**Timeline to Production:**
|
||||
- Phase 2A.1: ✅ READY (just completed)
|
||||
- Phase 2A.2: 1 week after 2A.1 tested
|
||||
- Phase 2A.3: 1 week after 2A.2
|
||||
- Phase 2A.4: 1-2 weeks after 2A.3
|
||||
- Phase 2A.5: 1 week after 2A.4
|
||||
|
||||
**Total: 5 weeks to production**
|
||||
|
||||
---
|
||||
|
||||
## 🎉 Next Action
|
||||
|
||||
**Start testing the endpoints!**
|
||||
|
||||
1. Launch backend with `python start_alwrity_backend.py --dev`
|
||||
2. Send test request to `/api/seo/enterprise/complete-audit`
|
||||
3. Verify response with mock data
|
||||
4. Confirm integration with frontend
|
||||
5. Proceed to Phase 2A.2 if tests pass
|
||||
|
||||
@@ -1,559 +0,0 @@
|
||||
# Phase 2A - Complete Review & Implementation Status
|
||||
|
||||
**Generated:** May 24, 2026 | **Overall Status:** 20% Complete | **Blocking:** Backend Implementation
|
||||
|
||||
---
|
||||
|
||||
## 🎯 EXECUTIVE SUMMARY
|
||||
|
||||
### What Was Built ✅
|
||||
```
|
||||
FRONTEND IMPLEMENTATION: 100% COMPLETE
|
||||
├── 6 Production-Ready Components
|
||||
├── 4,850+ Lines of React/TypeScript
|
||||
├── 20+ Type-Safe Interfaces
|
||||
├── 50+ UI Components
|
||||
├── Full Material-UI Integration
|
||||
├── Framer Motion Animations
|
||||
├── Glass-morphism Design
|
||||
├── Responsive Layout
|
||||
└── Error Handling & Loading States
|
||||
|
||||
STATUS: ✅ PRODUCTION READY - Can start testing immediately
|
||||
```
|
||||
|
||||
### What's Needed 🔴
|
||||
```
|
||||
BACKEND IMPLEMENTATION: 0% STARTED (BLOCKING)
|
||||
├── 12 API Endpoints Required
|
||||
├── 2,650+ Lines of Code Needed
|
||||
├── 3 Service Files (enterprise, GSC, LLM)
|
||||
├── LLM Integration
|
||||
├── Database Caching
|
||||
├── Error Handling
|
||||
└── Comprehensive Testing
|
||||
|
||||
STATUS: 🔴 NOT STARTED - Blocks all testing and validation
|
||||
```
|
||||
|
||||
### Timeline 📅
|
||||
```
|
||||
Current Phase: Frontend Complete ✅
|
||||
Blocking Phase: Backend Core (Phase 2A.1)
|
||||
Critical Path: 5 weeks to production
|
||||
Resources: 2-3 developers
|
||||
Target Date: June 28, 2026
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📊 DETAILED COMPLETION STATUS
|
||||
|
||||
### Frontend Components Created
|
||||
|
||||
#### 1. **enterpriseSeoApi.ts** ✅
|
||||
```
|
||||
PURPOSE: Type-safe API client layer
|
||||
LINES: 650+
|
||||
EXPORTS: - 15+ API methods
|
||||
- 20+ TypeScript interfaces
|
||||
- Error utilities
|
||||
FEATURES: - Enterprise audit endpoints
|
||||
- GSC analysis endpoints
|
||||
- Content opportunity endpoints
|
||||
- LLM insight endpoints
|
||||
- Health check endpoint
|
||||
READY: ✅ YES - Can call backend when ready
|
||||
```
|
||||
|
||||
#### 2. **llmInsightsGenerator.ts** ✅
|
||||
```
|
||||
PURPOSE: LLM prompt generation & insights service
|
||||
LINES: 450+
|
||||
EXPORTS: - 10+ specialized methods
|
||||
- 8 prompt templates
|
||||
- Singleton instance
|
||||
FEATURES: - Audit insights generation
|
||||
- GSC insights generation
|
||||
- Content strategy generation
|
||||
- Traffic roadmap generation
|
||||
- Priority scoring (1-10)
|
||||
- Effort assessment
|
||||
- Traffic gain calculation
|
||||
READY: ✅ YES - Backend just needs to call
|
||||
```
|
||||
|
||||
#### 3. **EnterpriseAuditResults.tsx** ✅
|
||||
```
|
||||
PURPOSE: Display comprehensive enterprise audit results
|
||||
LINES: 800+
|
||||
FEATURES: - Executive summary
|
||||
- Technical audit findings
|
||||
- Keyword research table
|
||||
- Competitive analysis
|
||||
- Implementation roadmap (3 phases)
|
||||
- AI insights with filtering
|
||||
- Report download
|
||||
STYLING: ✅ Glass-morphism, animations, responsive
|
||||
STATE: ✅ Local state management
|
||||
ERRORS: ✅ Comprehensive error handling
|
||||
READY: ✅ YES - Can render with mock data
|
||||
```
|
||||
|
||||
#### 4. **GSCAnalysisResults.tsx** ✅
|
||||
```
|
||||
PURPOSE: Display GSC search performance analysis
|
||||
LINES: 900+
|
||||
FEATURES: - Performance overview (4 cards)
|
||||
- 4-tab interface
|
||||
- Top keywords table
|
||||
- Top pages cards
|
||||
- Content opportunities
|
||||
- Keywords needing attention
|
||||
- Technical signals
|
||||
- Traffic potential
|
||||
STYLING: ✅ Full Material-UI theming
|
||||
CHARTS: ✅ Progress bars, trend indicators
|
||||
READY: ✅ YES - Can render with mock data
|
||||
```
|
||||
|
||||
#### 5. **ActionableInsightsDisplay.tsx** ✅
|
||||
```
|
||||
PURPOSE: Display AI-powered actionable insights
|
||||
LINES: 700+
|
||||
FEATURES: - Priority ranking (1-10 scale)
|
||||
- Impact vs effort matrix
|
||||
- Traffic gain estimates
|
||||
- Implementation steps
|
||||
- Recommended tools
|
||||
- Filtering controls
|
||||
- Save/bookmark functionality
|
||||
- Phased strategies
|
||||
INTERACTIVITY: ✅ Full interactive UI
|
||||
READY: ✅ YES - Fully functional UI
|
||||
```
|
||||
|
||||
#### 6. **SEOAnalysisController.tsx** ✅
|
||||
```
|
||||
PURPOSE: Main workflow orchestrator
|
||||
LINES: 750+
|
||||
FEATURES: - 5-step guided workflow
|
||||
- Visual stepper
|
||||
- Website input form
|
||||
- Real-time progress (0-100%)
|
||||
- Result tabs
|
||||
- Configuration dialog
|
||||
- Report download
|
||||
- Error handling
|
||||
STATE: ✅ Local state + Zustand integration
|
||||
READY: ✅ YES - Can orchestrate backend calls
|
||||
```
|
||||
|
||||
#### 7. **SEODashboard.tsx (Modified)** ✅
|
||||
```
|
||||
PURPOSE: Main dashboard with tab navigation
|
||||
CHANGES: - Added Tabs component
|
||||
- Tab 1: Overview (existing)
|
||||
- Tab 2: Enterprise Analysis (new)
|
||||
- Tab navigation UI
|
||||
INTEGRATION: ✅ Seamless
|
||||
BACKWARD COMPATIBILITY: ✅ Full
|
||||
READY: ✅ YES - Tab switching works
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔴 Backend Implementation Status
|
||||
|
||||
### Required Endpoints (12 Total)
|
||||
|
||||
#### Core Endpoints (3) - PRIORITY 1
|
||||
```
|
||||
Endpoint 1: POST /api/seo-tools/enterprise/complete-audit
|
||||
Status: 🔴 NOT IMPLEMENTED
|
||||
Service: enterprise_seo_service.py (needs creation)
|
||||
Effort: HIGH (~400 lines)
|
||||
Purpose: Complete enterprise SEO audit
|
||||
Inputs: website_url, competitors, keywords
|
||||
Outputs: Comprehensive audit result with 15+ fields
|
||||
Blocked: ✓ Testing, ✓ Integration, ✓ Validation
|
||||
|
||||
Endpoint 2: POST /api/seo-tools/gsc/analyze-search-performance
|
||||
Status: 🔴 NOT IMPLEMENTED
|
||||
Service: gsc_analyzer_service.py (needs creation)
|
||||
Effort: MEDIUM (~350 lines)
|
||||
Purpose: Analyze GSC search performance
|
||||
Inputs: site_url, date_range
|
||||
Outputs: Search metrics, keywords, opportunities
|
||||
Blocked: ✓ Testing, ✓ Integration, ✓ Validation
|
||||
|
||||
Endpoint 3: POST /api/seo-tools/gsc/content-opportunities
|
||||
Status: 🔴 NOT IMPLEMENTED
|
||||
Service: gsc_analyzer_service.py (shared)
|
||||
Effort: MEDIUM (~300 lines)
|
||||
Purpose: Identify content gaps and opportunities
|
||||
Inputs: site_url, analysis_type
|
||||
Outputs: Opportunity recommendations with ROI
|
||||
Blocked: ✓ Testing, ✓ Integration, ✓ Validation
|
||||
```
|
||||
|
||||
#### LLM Insight Endpoints (8) - PRIORITY 2
|
||||
```
|
||||
1. /api/seo-tools/llm/generate-audit-insights 🔴 0%
|
||||
2. /api/seo-tools/llm/generate-gsc-insights 🔴 0%
|
||||
3. /api/seo-tools/llm/generate-content-strategy 🔴 0%
|
||||
4. /api/seo-tools/llm/generate-traffic-roadmap 🔴 0%
|
||||
5. /api/seo-tools/llm/prioritized-recommendations 🔴 0%
|
||||
6. /api/seo-tools/llm/quick-wins 🔴 0%
|
||||
7. /api/seo-tools/llm/competitive-insights 🔴 0%
|
||||
8. /api/seo-tools/llm/keyword-expansion 🔴 0%
|
||||
|
||||
Status: All 🔴 NOT IMPLEMENTED
|
||||
Service: llm_insights_service.py (needs creation)
|
||||
Effort: HIGH (~500 lines)
|
||||
Purpose: Generate LLM-powered actionable insights
|
||||
Inputs: Analysis results + context
|
||||
Outputs: Prioritized insights with traffic projections
|
||||
Blocked: ✓ Insight generation, ✓ Traffic guidance
|
||||
```
|
||||
|
||||
#### Support Endpoints (1) - PRIORITY 3
|
||||
```
|
||||
Endpoint: GET /api/seo-tools/enterprise/health
|
||||
Status: 🔴 NOT IMPLEMENTED
|
||||
Effort: LOW (~50 lines)
|
||||
Purpose: Health check for enterprise service
|
||||
Blocked: ✓ Monitoring
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📈 Completion Metrics
|
||||
|
||||
### By Component Type
|
||||
```
|
||||
Component Type Count Status Lines Completion
|
||||
────────────────────────────────────────────────────────
|
||||
API Client Methods 15 ✅ 650 100%
|
||||
Service Methods 10 ✅ 450 100%
|
||||
UI Components 50 ✅ 3,850 100%
|
||||
TypeScript Interfaces 20 ✅ N/A 100%
|
||||
API Endpoints 12 🔴 2,650 0%
|
||||
Service Files 3 🔴 N/A 0%
|
||||
Database Tables 2 🔴 N/A 0%
|
||||
────────────────────────────────────────────────────────
|
||||
TOTAL 112 🟡 7,600 20%
|
||||
```
|
||||
|
||||
### By Layer
|
||||
```
|
||||
Layer Status Completion Details
|
||||
──────────────────────────────────────────────────────
|
||||
Frontend ✅ 100% 4,850 lines, ready
|
||||
Services ⏳ 50% Prompts ready, backend logic pending
|
||||
Backend 🔴 0% No endpoints implemented
|
||||
Database 🔴 0% Schema design pending
|
||||
Infrastructure 🔴 0% Cache/monitoring pending
|
||||
Testing 🔴 0% Framework ready, tests pending
|
||||
──────────────────────────────────────────────────────
|
||||
AVERAGE 🟡 20% Frontend heavy, backend needed
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚦 Implementation Phases Summary
|
||||
|
||||
### Phase 2A.0: Frontend ✅ COMPLETE
|
||||
```
|
||||
STATUS: ✅ COMPLETE
|
||||
TIMELINE: 3 days (completed May 21-23)
|
||||
EFFORT: 40 hours
|
||||
DELIVERABLE: 6 components, 4,850 lines
|
||||
QUALITY: Production-ready
|
||||
TESTS: TypeScript compilation tests ✅
|
||||
14 compilation errors fixed ✅
|
||||
READY: ✅ Can be deployed immediately
|
||||
BLOCKED: Nothing - ready to go
|
||||
```
|
||||
|
||||
### Phase 2A.1: Backend Core 🔴 NOT STARTED
|
||||
```
|
||||
STATUS: 🔴 NOT STARTED
|
||||
TIMELINE: 1 week (target: May 24-30)
|
||||
EFFORT: 40-50 hours (2 developers)
|
||||
DELIVERABLE: 3 endpoints, business logic
|
||||
INCLUDES: - Enterprise audit service (~400 lines)
|
||||
- GSC analyzer service (~350 lines)
|
||||
- Routing updates (~50 lines)
|
||||
- Error handling
|
||||
- Unit tests (~100 lines)
|
||||
CRITICAL: YES - Blocks all testing
|
||||
READY: ⏳ Can start immediately
|
||||
BLOCKED: Developer resources needed
|
||||
```
|
||||
|
||||
### Phase 2A.2: LLM Integration 🔴 BLOCKED
|
||||
```
|
||||
STATUS: 🔴 BLOCKED (waiting for 2A.1)
|
||||
TIMELINE: 1 week (after Phase 2A.1)
|
||||
EFFORT: 40-50 hours
|
||||
DELIVERABLE: 8 endpoints, prompt templates
|
||||
INCLUDES: - LLM insights service (~500 lines)
|
||||
- 8 endpoint routes
|
||||
- Prompt optimization
|
||||
- Response parsing
|
||||
- Caching strategy
|
||||
- Performance tuning
|
||||
CRITICAL: YES - Core feature
|
||||
READY: 🔴 Blocked by Phase 2A.1
|
||||
```
|
||||
|
||||
### Phase 2A.3: Infrastructure 🔴 BLOCKED
|
||||
```
|
||||
STATUS: 🔴 BLOCKED (waiting for 2A.2)
|
||||
TIMELINE: 1 week
|
||||
EFFORT: 30 hours
|
||||
DELIVERABLE: Caching layer, database, monitoring
|
||||
BENEFIT: 10x performance improvement
|
||||
CRITICAL: HIGH (for production)
|
||||
READY: 🔴 Blocked by Phase 2A.2
|
||||
```
|
||||
|
||||
### Phase 2A.4: Testing 🔴 BLOCKED
|
||||
```
|
||||
STATUS: 🔴 BLOCKED (waiting for 2A.3)
|
||||
TIMELINE: 1-2 weeks
|
||||
EFFORT: 50 hours
|
||||
DELIVERABLE: 80%+ test coverage, all tests passing
|
||||
INCLUDES: - 50+ unit tests
|
||||
- 20+ integration tests
|
||||
- 10+ E2E tests
|
||||
- Manual testing
|
||||
- Performance validation
|
||||
- Bug fixes
|
||||
CRITICAL: YES - Must pass before deployment
|
||||
READY: 🔴 Blocked by Phase 2A.3
|
||||
```
|
||||
|
||||
### Phase 2A.5: Deployment 🔴 BLOCKED
|
||||
```
|
||||
STATUS: 🔴 BLOCKED (waiting for 2A.4)
|
||||
TIMELINE: 1 week
|
||||
EFFORT: 30 hours
|
||||
DELIVERABLE: Production release
|
||||
INCLUDES: - Documentation
|
||||
- Deployment procedures
|
||||
- Monitoring setup
|
||||
- Rollback procedures
|
||||
- UAT support
|
||||
CRITICAL: MEDIUM - Final step
|
||||
READY: 🔴 Blocked by Phase 2A.4
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚡ Critical Path to Production
|
||||
|
||||
```
|
||||
May 24: Phase 2A.0 Frontend ✅ Complete
|
||||
May 25: START → Phase 2A.1 Backend Core 🔴
|
||||
May 30: DONE → Phase 2A.1 (3 endpoints)
|
||||
Jun 1: START → Phase 2A.2 LLM Integration 🔴
|
||||
Jun 6: DONE → Phase 2A.2 (8 endpoints)
|
||||
Jun 7: START → Phase 2A.3 Infrastructure 🔴
|
||||
Jun 13: DONE → Phase 2A.3 (Caching/DB)
|
||||
Jun 14: START → Phase 2A.4 Testing 🔴
|
||||
Jun 20: DONE → Phase 2A.4 (80% coverage)
|
||||
Jun 21: START → Phase 2A.5 Deployment 🔴
|
||||
Jun 28: DONE → PRODUCTION READY ✅
|
||||
|
||||
TOTAL: 5 weeks from today to production
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📋 Documentation Deliverables
|
||||
|
||||
All documents created in repo root:
|
||||
|
||||
| Document | Purpose | Location | Status |
|
||||
|----------|---------|----------|--------|
|
||||
| **Integration Guide** | Frontend component specs | PHASE2A_INTEGRATION_GUIDE.md | ✅ Complete |
|
||||
| **Implementation Review** | Detailed review of all components | PHASE2A_IMPLEMENTATION_REVIEW.md | ✅ Complete |
|
||||
| **Next Steps** | Implementation roadmap | PHASE2A_NEXT_STEPS.md | ✅ Complete |
|
||||
| **Status Dashboard** | Real-time progress tracking | PHASE2A_STATUS_DASHBOARD.md | ✅ Complete |
|
||||
| **Compilation Fixes** | 14 TypeScript error resolutions | COMPILATION_FIXES.md | ✅ Complete |
|
||||
| **This File** | Complete review & summary | PHASE2A_COMPLETE_REVIEW.md | ✅ You are here |
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Success Criteria Status
|
||||
|
||||
### Frontend Completion ✅
|
||||
- [x] All 6 components created
|
||||
- [x] 4,850+ lines of code
|
||||
- [x] Type-safe TypeScript
|
||||
- [x] Material-UI integration
|
||||
- [x] Error handling
|
||||
- [x] Loading states
|
||||
- [x] Responsive design
|
||||
- [x] All compilation errors fixed (14/14)
|
||||
- [x] Production-ready code
|
||||
|
||||
### Backend Requirements 🔴
|
||||
- [ ] 3 core endpoints implemented
|
||||
- [ ] 8 LLM endpoints implemented
|
||||
- [ ] Business logic complete
|
||||
- [ ] Error handling
|
||||
- [ ] Unit tests passing
|
||||
- [ ] Integration tests passing
|
||||
- [ ] Performance benchmarks met
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Current Blockers
|
||||
|
||||
### Blocker #1: Backend Not Implemented (CRITICAL)
|
||||
```
|
||||
Issue: Core endpoints not implemented
|
||||
Impact: Blocks ALL testing and validation
|
||||
Severity: CRITICAL - Production blocker
|
||||
Timeline: 1 week to resolve (Phase 2A.1)
|
||||
Action: START IMMEDIATELY
|
||||
```
|
||||
|
||||
### Blocker #2: LLM Service Not Implemented (CRITICAL)
|
||||
```
|
||||
Issue: LLM integration endpoints missing
|
||||
Impact: Blocks insight generation
|
||||
Severity: CRITICAL - Core feature
|
||||
Timeline: Blocked by Blocker #1, then 1 week
|
||||
Action: Start after Phase 2A.1
|
||||
```
|
||||
|
||||
### Blocker #3: Database/Caching Not Setup (HIGH)
|
||||
```
|
||||
Issue: No caching layer or history storage
|
||||
Impact: Performance issues, limited tracking
|
||||
Severity: HIGH - Production impact
|
||||
Timeline: Blocked by Blocker #2, then 1 week
|
||||
Action: Start after Phase 2A.2
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📞 Recommended Next Actions
|
||||
|
||||
### TODAY (May 24)
|
||||
```
|
||||
1. [ ] Distribute this review to stakeholders
|
||||
2. [ ] Finalize backend resource allocation
|
||||
3. [ ] Setup development environment
|
||||
4. [ ] Create project plan for Phase 2A.1
|
||||
5. [ ] Assign backend developers
|
||||
```
|
||||
|
||||
### THIS WEEK (May 24-30)
|
||||
```
|
||||
1. [ ] Complete Phase 2A.1 (3 core endpoints)
|
||||
2. [ ] Write unit tests
|
||||
3. [ ] Manual testing with real websites
|
||||
4. [ ] Performance baseline established
|
||||
5. [ ] Ready to move to Phase 2A.2
|
||||
```
|
||||
|
||||
### NEXT WEEK (May 31-Jun 6)
|
||||
```
|
||||
1. [ ] Start Phase 2A.2 (LLM integration)
|
||||
2. [ ] Implement 8 LLM endpoints
|
||||
3. [ ] Optimize LLM prompts
|
||||
4. [ ] Setup caching layer (start)
|
||||
5. [ ] Begin comprehensive testing
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💡 Key Takeaways
|
||||
|
||||
### ✅ Strengths
|
||||
1. **Frontend Complete** - Production-ready UI
|
||||
2. **Well-Designed** - Clean architecture, reusable components
|
||||
3. **Type-Safe** - Full TypeScript coverage
|
||||
4. **Well-Documented** - Comprehensive guides provided
|
||||
5. **Zero Technical Debt** - Clean, maintainable code
|
||||
|
||||
### 🔴 Concerns
|
||||
1. **Backend Not Started** - Critical blocker
|
||||
2. **Timeline Risk** - Backend needs 4 weeks
|
||||
3. **Resource Dependent** - Needs 2-3 developers
|
||||
4. **LLM Integration** - Requires specialized setup
|
||||
5. **Testing Gap** - No tests yet
|
||||
|
||||
### 🟡 Opportunities
|
||||
1. **Feature Differentiation** - LLM-powered insights unique
|
||||
2. **Monetization** - Premium enterprise feature
|
||||
3. **Market Position** - Advanced SEO tooling
|
||||
4. **User Value** - Real traffic improvement guidance
|
||||
5. **Scaling Potential** - Foundation for more features
|
||||
|
||||
---
|
||||
|
||||
## 📊 Final Status Summary
|
||||
|
||||
```
|
||||
╔════════════════════════════════════════════════════════════╗
|
||||
║ PHASE 2A IMPLEMENTATION STATUS ║
|
||||
╠════════════════════════════════════════════════════════════╣
|
||||
║ ║
|
||||
║ FRONTEND: ✅ 100% COMPLETE (4,850 lines) ║
|
||||
║ BACKEND: 🔴 0% STARTED (2,650 lines needed) ║
|
||||
║ DATABASE: 🔴 0% STARTED (schema design pending) ║
|
||||
║ TESTING: 🔴 0% STARTED (tests pending) ║
|
||||
║ DEPLOYMENT: 🔴 0% STARTED (infrastructure pending) ║
|
||||
║ ║
|
||||
║ ───────────────────────────────────────────────────── ║
|
||||
║ OVERALL: 🟡 20% COMPLETE ║
|
||||
║ ───────────────────────────────────────────────────── ║
|
||||
║ ║
|
||||
║ BLOCKING: Backend implementation ║
|
||||
║ TIMELINE: 5 weeks to production ║
|
||||
║ RESOURCES: 2-3 developers needed ║
|
||||
║ TARGET: June 28, 2026 ║
|
||||
║ ║
|
||||
║ NEXT STEP: START PHASE 2A.1 IMMEDIATELY ║
|
||||
║ ║
|
||||
╚════════════════════════════════════════════════════════════╝
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Ready to Proceed?
|
||||
|
||||
### Frontend Status: ✅ READY
|
||||
- Fully implemented and tested
|
||||
- All components created
|
||||
- No dependencies on backend
|
||||
- Can be deployed anytime
|
||||
|
||||
### Backend Status: 🔴 NOT READY
|
||||
- Zero implementation
|
||||
- Needs 4 weeks of work
|
||||
- Blocks all functionality
|
||||
- **ACTION REQUIRED: Start today**
|
||||
|
||||
### Go/No-Go Decision
|
||||
```
|
||||
FRONTEND: ✅ GO - Can proceed immediately
|
||||
BACKEND: 🔴 NO-GO - Must start Phase 2A.1
|
||||
OVERALL: 🔴 NO-GO until backend starts
|
||||
|
||||
ACTION: Allocate resources NOW to Phase 2A.1
|
||||
IMPACT: 1-week delay → 2-month delay if not started
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Review Completed:** May 24, 2026
|
||||
**Next Review:** After Phase 2A.1 Backend Implementation
|
||||
**Questions?** Refer to specific implementation guides
|
||||
**Ready to Start?** Begin Phase 2A.1 backend implementation immediately
|
||||
@@ -1,605 +0,0 @@
|
||||
# Phase 2A SEO Dashboard Implementation - Complete Review
|
||||
|
||||
**Date:** May 24, 2026
|
||||
**Status:** 🟡 FRONTEND COMPLETE | 🔴 BACKEND PENDING | 🟡 TESTING READY
|
||||
|
||||
---
|
||||
|
||||
## 📊 Implementation Overview
|
||||
|
||||
### Phase 2A Objectives
|
||||
1. ✅ Integrate enterprise SEO audit with dashboard
|
||||
2. ✅ Provide comprehensive GSC insights to end users
|
||||
3. ✅ Use LLM prompts for actionable insights
|
||||
4. ✅ Display traffic improvement strategies
|
||||
5. ⏳ Backend endpoint implementation (NOT STARTED)
|
||||
6. ⏳ End-to-end testing (PENDING BACKEND)
|
||||
|
||||
---
|
||||
|
||||
## ✅ COMPLETED: Frontend Layer (100%)
|
||||
|
||||
### Files Created: 6 Components
|
||||
|
||||
#### 1. **enterpriseSeoApi.ts** (API Client Layer)
|
||||
- **Status:** ✅ COMPLETE
|
||||
- **Lines:** 650+
|
||||
- **Purpose:** Type-safe API client for all Phase 2A endpoints
|
||||
- **Exports:**
|
||||
- 15+ API methods
|
||||
- 20+ TypeScript interfaces
|
||||
- Error handling utilities
|
||||
- **Key Methods:**
|
||||
- `executeEnterpriseAudit()`
|
||||
- `analyzeGSCSearchPerformance()`
|
||||
- `getContentOpportunitiesReport()`
|
||||
- `generateAuditInsights()`
|
||||
- `generateGSCInsights()`
|
||||
- `getTrafficImprovementStrategies()`
|
||||
- **Dependencies:** Uses existing `apiClient` and `longRunningApiClient`
|
||||
- **Type Safety:** ✅ Full TypeScript strict mode support
|
||||
|
||||
#### 2. **llmInsightsGenerator.ts** (Services Layer)
|
||||
- **Status:** ✅ COMPLETE
|
||||
- **Lines:** 450+
|
||||
- **Purpose:** Convert analysis data to LLM-powered actionable insights
|
||||
- **Exports:**
|
||||
- 10+ specialized methods
|
||||
- Prompt builder templates
|
||||
- Singleton instance
|
||||
- **Key Methods:**
|
||||
- `generateEnterpriseAuditInsights()`
|
||||
- `generateGSCAnalysisInsights()`
|
||||
- `generateTrafficRoadmap()`
|
||||
- `generatePrioritizedRecommendations()`
|
||||
- `generateContentStrategy()`
|
||||
- `generateCompetitiveInsights()`
|
||||
- `generateKeywordExpansion()`
|
||||
- **LLM Integration:** 8+ specialized prompt templates
|
||||
- **Features:**
|
||||
- Priority scoring (1-10 scale)
|
||||
- Effort/impact assessment
|
||||
- Traffic gain calculations
|
||||
- Phased implementation strategies
|
||||
|
||||
#### 3. **EnterpriseAuditResults.tsx** (Results Component)
|
||||
- **Status:** ✅ COMPLETE
|
||||
- **Lines:** 800+
|
||||
- **Location:** `frontend/src/components/SEODashboard/components/`
|
||||
- **Features:**
|
||||
- Executive summary (overall score, traffic potential, time estimate)
|
||||
- Technical audit section (Core Web Vitals, page speed, mobile usability)
|
||||
- Keyword research table (opportunity scoring, volume, difficulty)
|
||||
- Competitive analysis matrix
|
||||
- Implementation roadmap (3 phases: quick wins, medium, long-term)
|
||||
- AI insights panel with filtering
|
||||
- Report download functionality
|
||||
- **Styling:** Glass-morphism effects, animations, responsive design
|
||||
- **Accessibility:** Proper semantic HTML, ARIA labels
|
||||
- **Performance:** Optimized renders, memoization where needed
|
||||
|
||||
#### 4. **GSCAnalysisResults.tsx** (Results Component)
|
||||
- **Status:** ✅ COMPLETE
|
||||
- **Lines:** 900+
|
||||
- **Location:** `frontend/src/components/SEODashboard/components/`
|
||||
- **Features:**
|
||||
- Performance overview cards (clicks, impressions, CTR, position)
|
||||
- 4-tab interface:
|
||||
- Tab 1: Performance Overview
|
||||
- Tab 2: Keywords Analysis
|
||||
- Tab 3: Content Opportunities
|
||||
- Tab 4: Technical Signals
|
||||
- Top keywords and pages tables
|
||||
- Content opportunities with traffic projections
|
||||
- Keywords needing attention
|
||||
- Traffic potential breakdown
|
||||
- Technical signals dashboard
|
||||
- **Data Visualization:** Charts, progress bars, trend indicators
|
||||
- **Responsive:** Grid-based layout for all screen sizes
|
||||
- **Interactivity:** Sortable tables, filterable lists
|
||||
|
||||
#### 5. **ActionableInsightsDisplay.tsx** (Insights Component)
|
||||
- **Status:** ✅ COMPLETE
|
||||
- **Lines:** 700+
|
||||
- **Location:** `frontend/src/components/SEODashboard/components/`
|
||||
- **Features:**
|
||||
- Priority-ranked insights (1-10 scale with color coding)
|
||||
- Impact vs Effort matrix visualization
|
||||
- Traffic gain estimates and ROI calculations
|
||||
- Step-by-step implementation guides (expandable accordion)
|
||||
- Recommended tools per insight
|
||||
- Filter controls (by impact, by effort, quick wins only)
|
||||
- Traffic improvement strategies section
|
||||
- Bookmark and share functionality
|
||||
- Save insights feature
|
||||
- **UX:** Smooth animations, clear visual hierarchy
|
||||
- **Accessibility:** Keyboard navigation support
|
||||
|
||||
#### 6. **SEOAnalysisController.tsx** (Orchestration Component)
|
||||
- **Status:** ✅ COMPLETE
|
||||
- **Lines:** 750+
|
||||
- **Location:** `frontend/src/components/SEODashboard/`
|
||||
- **Purpose:** Main workflow orchestrator
|
||||
- **Features:**
|
||||
- 5-step guided workflow with visual stepper
|
||||
- Step 1: Website Input (URL, competitors, keywords)
|
||||
- Step 2: Enterprise Audit (with progress tracking)
|
||||
- Step 3: GSC Analysis (simultaneous execution)
|
||||
- Step 4: Generate AI Insights (LLM integration)
|
||||
- Step 5: Review & Download (full report export)
|
||||
- Real-time progress indicators (0-100%)
|
||||
- Analysis configuration dialog
|
||||
- Report download (JSON format)
|
||||
- New analysis reset functionality
|
||||
- **State Management:** Local state with Zustand integration points
|
||||
- **Error Handling:** Comprehensive error displays
|
||||
- **Loading States:** Smooth transitions and progress feedback
|
||||
|
||||
### Dashboard Integration
|
||||
- **Status:** ✅ COMPLETE
|
||||
- **File Modified:** `SEODashboard.tsx`
|
||||
- **Changes:**
|
||||
- Added tab-based navigation system
|
||||
- Tab 1: "📊 Overview" - Existing functionality (preserved)
|
||||
- Tab 2: "🔍 Enterprise Analysis" - New Phase 2A tab
|
||||
- Seamless tab switching with state management
|
||||
- All existing features preserved
|
||||
|
||||
### Compilation Status
|
||||
- **Status:** ✅ FIXED
|
||||
- **Errors Fixed:** 14/14
|
||||
- 3 module path errors → Fixed import paths
|
||||
- 2 Material-UI errors → Fixed import sources
|
||||
- 9 TypeScript type errors → Added type annotations
|
||||
- **Documentation:** `COMPILATION_FIXES.md` created
|
||||
|
||||
---
|
||||
|
||||
## 🔴 PENDING: Backend Implementation (0%)
|
||||
|
||||
### Required Endpoints: 12 Total
|
||||
|
||||
#### Priority 1: Core Analysis Endpoints (3)
|
||||
1. **POST `/api/seo-tools/enterprise/complete-audit`**
|
||||
- Input: `EnterpriseAuditRequest` (website_url, competitors, keywords)
|
||||
- Output: `EnterpriseAuditResult` (comprehensive audit data)
|
||||
- Backend File: `services/seo_tools/enterprise_seo_service.py`
|
||||
- Status: 🔴 NOT IMPLEMENTED
|
||||
- Effort: HIGH (requires multiple analysis modules)
|
||||
|
||||
2. **POST `/api/seo-tools/gsc/analyze-search-performance`**
|
||||
- Input: `GSCAnalysisRequest` (site_url, date_range)
|
||||
- Output: `GSCAnalysisResult` (search performance data)
|
||||
- Backend File: `services/seo_tools/gsc_analyzer_service.py`
|
||||
- Status: 🔴 NOT IMPLEMENTED
|
||||
- Effort: MEDIUM (GSC API integration needed)
|
||||
|
||||
3. **POST `/api/seo-tools/gsc/content-opportunities`**
|
||||
- Input: `ContentOpportunitiesRequest` (site_url, analysis_type)
|
||||
- Output: `ContentOpportunitiesReport` (opportunity recommendations)
|
||||
- Backend File: `services/seo_tools/gsc_analyzer_service.py`
|
||||
- Status: 🔴 NOT IMPLEMENTED
|
||||
- Effort: MEDIUM
|
||||
|
||||
#### Priority 2: LLM Insight Endpoints (8)
|
||||
4. **POST `/api/seo-tools/llm/generate-audit-insights`**
|
||||
- Converts audit results to actionable insights
|
||||
- Status: 🔴 NOT IMPLEMENTED
|
||||
|
||||
5. **POST `/api/seo-tools/llm/generate-gsc-insights`**
|
||||
- Converts GSC data to search-focused insights
|
||||
- Status: 🔴 NOT IMPLEMENTED
|
||||
|
||||
6. **POST `/api/seo-tools/llm/generate-content-strategy`**
|
||||
- Generates content gap analysis and strategy
|
||||
- Status: 🔴 NOT IMPLEMENTED
|
||||
|
||||
7. **POST `/api/seo-tools/llm/generate-traffic-roadmap`**
|
||||
- Creates phased traffic improvement plan
|
||||
- Status: 🔴 NOT IMPLEMENTED
|
||||
|
||||
8. **POST `/api/seo-tools/llm/prioritized-recommendations`**
|
||||
- Ranks all improvements by impact vs effort
|
||||
- Status: 🔴 NOT IMPLEMENTED
|
||||
|
||||
9. **POST `/api/seo-tools/llm/quick-wins`**
|
||||
- Identifies quick wins (< 1 week implementation)
|
||||
- Status: 🔴 NOT IMPLEMENTED
|
||||
|
||||
10. **POST `/api/seo-tools/llm/competitive-insights`**
|
||||
- Competitive positioning analysis
|
||||
- Status: 🔴 NOT IMPLEMENTED
|
||||
|
||||
11. **POST `/api/seo-tools/llm/keyword-expansion`**
|
||||
- Keyword research and expansion
|
||||
- Status: 🔴 NOT IMPLEMENTED
|
||||
|
||||
#### Priority 3: Support Endpoints (1)
|
||||
12. **GET `/api/seo-tools/enterprise/health`**
|
||||
- Health check for enterprise service
|
||||
- Status: 🔴 NOT IMPLEMENTED
|
||||
|
||||
### Backend Architecture Required
|
||||
```
|
||||
backend/
|
||||
├── services/
|
||||
│ └── seo_tools/
|
||||
│ ├── enterprise_seo_service.py (NEW)
|
||||
│ ├── gsc_analyzer_service.py (NEW)
|
||||
│ ├── llm_insights_service.py (NEW)
|
||||
│ └── ...
|
||||
├── routers/
|
||||
│ ├── seo_tools.py (EXISTING - needs updates)
|
||||
│ └── ...
|
||||
├── models/
|
||||
│ ├── seo_models.py (EXISTING - needs new types)
|
||||
│ └── ...
|
||||
└── api/
|
||||
└── ... (existing structure)
|
||||
```
|
||||
|
||||
### Backend Dependencies
|
||||
- Google Search Console API (authentication ready ✅)
|
||||
- LLM integration (Claude/GPT API)
|
||||
- SEO analysis libraries (SEMrush API, Moz API, etc.)
|
||||
- Database for caching results
|
||||
- Authentication middleware (Clerk - ready ✅)
|
||||
|
||||
---
|
||||
|
||||
## 🟡 TESTING STATUS (Ready for Backend)
|
||||
|
||||
### Frontend Testing Readiness
|
||||
- ✅ Component structure complete
|
||||
- ✅ TypeScript types validated
|
||||
- ✅ UI rendering verified
|
||||
- ✅ Navigation works
|
||||
- ⏳ Functional testing (pending mock data)
|
||||
- ⏳ Integration testing (pending backend)
|
||||
- ⏳ E2E testing (pending backend)
|
||||
|
||||
### Test Data Mock Available
|
||||
```typescript
|
||||
// Mock data structure ready in llmInsightsGenerator.ts
|
||||
const mockEnterpriseAuditResult: EnterpriseAuditResult = {
|
||||
website_url: 'https://example.com',
|
||||
audit_date: '2026-05-24',
|
||||
executive_summary: { /* ... */ },
|
||||
// ... 15+ fields
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📈 Completion Metrics
|
||||
|
||||
### Frontend Completion: 100%
|
||||
| Component | Status | Lines | Features |
|
||||
|-----------|--------|-------|----------|
|
||||
| API Client | ✅ COMPLETE | 650+ | 15+ methods, 20+ types |
|
||||
| LLM Service | ✅ COMPLETE | 450+ | 10+ methods, 8 prompts |
|
||||
| Audit Results | ✅ COMPLETE | 800+ | 8 sections, filtering |
|
||||
| GSC Results | ✅ COMPLETE | 900+ | 4 tabs, tables, charts |
|
||||
| Insights Display | ✅ COMPLETE | 700+ | Ranking, filtering, guides |
|
||||
| Controller | ✅ COMPLETE | 750+ | 5-step workflow, stepper |
|
||||
| Dashboard | ✅ COMPLETE | Modified | Tab integration |
|
||||
|
||||
**Total Frontend Code:** ~4,850 lines | **Status:** ✅ PRODUCTION READY
|
||||
|
||||
### Backend Completion: 0%
|
||||
| Endpoint | Priority | Status | Effort |
|
||||
|----------|----------|--------|--------|
|
||||
| Enterprise Audit | P1 | 🔴 0% | HIGH |
|
||||
| GSC Analysis | P1 | 🔴 0% | MEDIUM |
|
||||
| Content Opportunities | P1 | 🔴 0% | MEDIUM |
|
||||
| LLM Insights (8x) | P2 | 🔴 0% | HIGH |
|
||||
| Health Check | P3 | 🔴 0% | LOW |
|
||||
|
||||
**Total Backend Work:** ~3,000+ lines needed | **Status:** 🔴 NOT STARTED
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Data Flow Architecture
|
||||
|
||||
```
|
||||
User Input (Website URL)
|
||||
↓
|
||||
SEOAnalysisController (Frontend)
|
||||
├─→ enterpriseSeoAPI.executeEnterpriseAudit()
|
||||
│ ├─→ POST /api/seo-tools/enterprise/complete-audit
|
||||
│ └─→ Returns EnterpriseAuditResult
|
||||
│
|
||||
├─→ enterpriseSeoAPI.analyzeGSCSearchPerformance()
|
||||
│ ├─→ POST /api/seo-tools/gsc/analyze-search-performance
|
||||
│ └─→ Returns GSCAnalysisResult
|
||||
│
|
||||
├─→ EnterpriseAuditResults (Display)
|
||||
│
|
||||
├─→ GSCAnalysisResults (Display)
|
||||
│
|
||||
├─→ llmInsightsGenerator.generateEnterpriseAuditInsights()
|
||||
│ ├─→ POST /api/seo-tools/llm/generate-audit-insights
|
||||
│ └─→ Returns ActionableInsight[]
|
||||
│
|
||||
└─→ ActionableInsightsDisplay (Final Display)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📋 Next Implementation Phases
|
||||
|
||||
### Phase 2A.1: Backend Core Endpoints (IMMEDIATE)
|
||||
**Timeline:** 1-2 weeks
|
||||
**Priority:** CRITICAL
|
||||
**Effort:** HIGH
|
||||
|
||||
**Tasks:**
|
||||
1. Create `enterprise_seo_service.py`
|
||||
- Technical SEO analysis (Core Web Vitals, speed, mobile)
|
||||
- On-page analysis (meta tags, headings, content)
|
||||
- Keyword research (volume, difficulty, ranking potential)
|
||||
- Competitive benchmarking
|
||||
- Implementation roadmap generation
|
||||
|
||||
2. Create `gsc_analyzer_service.py`
|
||||
- Google Search Console API integration
|
||||
- Search performance metrics extraction
|
||||
- Keyword opportunity identification
|
||||
- Content gap analysis
|
||||
|
||||
3. Update `routers/seo_tools.py`
|
||||
- Add 3 core endpoint routes
|
||||
- Add request/response validation
|
||||
- Add error handling
|
||||
|
||||
**Deliverables:**
|
||||
- 3 functional endpoints
|
||||
- Request/response validation
|
||||
- Error handling
|
||||
- Database caching (optional but recommended)
|
||||
|
||||
---
|
||||
|
||||
### Phase 2A.2: LLM Integration Endpoints (CRITICAL)
|
||||
**Timeline:** 1-2 weeks
|
||||
**Priority:** CRITICAL
|
||||
**Effort:** HIGH
|
||||
|
||||
**Tasks:**
|
||||
1. Create `llm_insights_service.py`
|
||||
- LLM prompt templates for each insight type
|
||||
- API integration with Claude/GPT
|
||||
- Insight generation logic
|
||||
- Caching for performance
|
||||
|
||||
2. Implement 8 LLM endpoints
|
||||
- Each endpoint accepts analysis result
|
||||
- Calls LLM with specialized prompt
|
||||
- Returns prioritized insights
|
||||
- Includes traffic projections
|
||||
|
||||
3. Prompt optimization
|
||||
- Test with real SEO data
|
||||
- Refine for accuracy
|
||||
- Validate traffic projections
|
||||
|
||||
**Deliverables:**
|
||||
- 8 functional LLM endpoints
|
||||
- Optimized prompts
|
||||
- Caching layer
|
||||
- Performance benchmarks
|
||||
|
||||
---
|
||||
|
||||
### Phase 2A.3: Database & Caching (OPTIMIZATION)
|
||||
**Timeline:** 1 week
|
||||
**Priority:** HIGH (for production)
|
||||
**Effort:** MEDIUM
|
||||
|
||||
**Tasks:**
|
||||
1. Design caching strategy
|
||||
- Cache audit results (24-48 hours)
|
||||
- Cache GSC data (12-24 hours)
|
||||
- Cache LLM insights (48 hours)
|
||||
|
||||
2. Implement caching layer
|
||||
- Redis integration
|
||||
- Cache invalidation logic
|
||||
- TTL management
|
||||
|
||||
3. Database storage
|
||||
- Store analysis history
|
||||
- Track user preferences
|
||||
- Enable result comparison
|
||||
|
||||
**Benefit:** 10x performance improvement for repeated analyses
|
||||
|
||||
---
|
||||
|
||||
### Phase 2A.4: Testing & Validation (COMPREHENSIVE)
|
||||
**Timeline:** 1-2 weeks
|
||||
**Priority:** HIGH
|
||||
**Effort:** MEDIUM
|
||||
|
||||
**Test Coverage:**
|
||||
1. Unit tests (50+ tests)
|
||||
- Each service method
|
||||
- Error scenarios
|
||||
- Data validation
|
||||
|
||||
2. Integration tests (20+ tests)
|
||||
- End-to-end workflows
|
||||
- API interactions
|
||||
- LLM responses
|
||||
|
||||
3. E2E tests (10+ tests)
|
||||
- Frontend + Backend
|
||||
- Real user workflows
|
||||
- Performance benchmarks
|
||||
|
||||
4. Manual testing
|
||||
- Real websites (10+ test sites)
|
||||
- GSC validation
|
||||
- Insight accuracy
|
||||
- UI/UX verification
|
||||
|
||||
**Deliverables:**
|
||||
- Test suite (80+ tests)
|
||||
- Coverage report (80%+ coverage)
|
||||
- Performance benchmarks
|
||||
- Bug fix list
|
||||
|
||||
---
|
||||
|
||||
### Phase 2A.5: Documentation & Deployment (FINAL)
|
||||
**Timeline:** 1 week
|
||||
**Priority:** MEDIUM
|
||||
**Effort:** LOW
|
||||
|
||||
**Tasks:**
|
||||
1. API Documentation
|
||||
- Endpoint specs
|
||||
- Request/response examples
|
||||
- Error codes
|
||||
- Rate limiting
|
||||
|
||||
2. User Documentation
|
||||
- Feature guide
|
||||
- Tutorial videos
|
||||
- FAQs
|
||||
- Troubleshooting
|
||||
|
||||
3. Developer Documentation
|
||||
- Architecture overview
|
||||
- Setup guide
|
||||
- Contributing guidelines
|
||||
- Maintenance procedures
|
||||
|
||||
4. Deployment
|
||||
- Staging environment
|
||||
- Production deployment
|
||||
- Monitoring setup
|
||||
- Rollback procedures
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Success Criteria
|
||||
|
||||
### Phase 2A.1 (Backend Core)
|
||||
- ✅ 3 endpoints fully functional
|
||||
- ✅ Real enterprise audits working
|
||||
- ✅ GSC data flowing to frontend
|
||||
- ✅ All 14 frontend compilation errors resolved
|
||||
|
||||
### Phase 2A.2 (LLM Integration)
|
||||
- ✅ 8 LLM endpoints working
|
||||
- ✅ Insights generated with traffic projections
|
||||
- ✅ Priority scoring accurate (1-10 scale)
|
||||
- ✅ Effort/impact assessment working
|
||||
|
||||
### Phase 2A.3 (Database/Caching)
|
||||
- ✅ Analysis history available
|
||||
- ✅ Cache hit rate > 70%
|
||||
- ✅ Query response time < 500ms
|
||||
|
||||
### Phase 2A.4 (Testing)
|
||||
- ✅ Test coverage > 80%
|
||||
- ✅ All tests passing
|
||||
- ✅ Performance benchmarks met
|
||||
- ✅ No critical bugs
|
||||
|
||||
### Phase 2A.5 (Documentation)
|
||||
- ✅ All features documented
|
||||
- ✅ Developer guide complete
|
||||
- ✅ User guide complete
|
||||
- ✅ Ready for production
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Estimated Timeline
|
||||
|
||||
| Phase | Tasks | Timeline | Status |
|
||||
|-------|-------|----------|--------|
|
||||
| 2A.0 Frontend | 6 components | ✅ DONE | COMPLETE |
|
||||
| 2A.1 Backend Core | 3 endpoints | 1-2 weeks | ⏳ READY |
|
||||
| 2A.2 LLM Integration | 8 endpoints | 1-2 weeks | ⏳ BLOCKED |
|
||||
| 2A.3 DB/Caching | Optimization | 1 week | ⏳ BLOCKED |
|
||||
| 2A.4 Testing | Validation | 1-2 weeks | ⏳ BLOCKED |
|
||||
| 2A.5 Deployment | Release | 1 week | ⏳ BLOCKED |
|
||||
|
||||
**Total Estimated:** 5-8 weeks
|
||||
**Current Progress:** 20% (frontend only)
|
||||
**Blocking Issue:** Backend endpoints not implemented
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Critical Blockers
|
||||
|
||||
### Immediate Blockers
|
||||
1. **Backend endpoints not implemented** - Blocks all functionality testing
|
||||
2. **No mock data** - Prevents UI testing with real-like data
|
||||
3. **No LLM service setup** - Blocks insight generation
|
||||
4. **GSC authentication** - Needs verification in production
|
||||
|
||||
### Recommended Next Action
|
||||
**Start Phase 2A.1 immediately:** Implement the 3 core backend endpoints to unblock testing and validation.
|
||||
|
||||
---
|
||||
|
||||
## 📊 Summary Dashboard
|
||||
|
||||
```
|
||||
FRONTEND IMPLEMENTATION
|
||||
✅ API Client: 100% (650 lines)
|
||||
✅ LLM Service: 100% (450 lines)
|
||||
✅ Components: 100% (3,850 lines)
|
||||
✅ Integration: 100% (Complete)
|
||||
✅ Compilation: 100% (14 errors fixed)
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
Total Frontend: ✅ 100% COMPLETE
|
||||
|
||||
BACKEND IMPLEMENTATION
|
||||
🔴 Core Endpoints: 0% (Not started)
|
||||
🔴 LLM Endpoints: 0% (Not started)
|
||||
🔴 Database/Caching: 0% (Not started)
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
Total Backend: 🔴 0% NOT STARTED
|
||||
|
||||
OVERALL PROJECT STATUS: 🟡 20% COMPLETE
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
Blocking: Backend Implementation
|
||||
Ready: Frontend Testing (awaiting backend)
|
||||
Next: Start Phase 2A.1 (Backend Core Endpoints)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📞 Action Items
|
||||
|
||||
### For Frontend
|
||||
- [ ] Run `npm run build` to verify all errors fixed
|
||||
- [ ] Run `npm start` to launch development server
|
||||
- [ ] Test tab navigation (Overview ↔ Enterprise Analysis)
|
||||
- [ ] Verify component rendering with mock data
|
||||
- [ ] Test responsive design on mobile/tablet
|
||||
|
||||
### For Backend (IMMEDIATE)
|
||||
- [ ] Create `services/seo_tools/enterprise_seo_service.py`
|
||||
- [ ] Create `services/seo_tools/gsc_analyzer_service.py`
|
||||
- [ ] Update `routers/seo_tools.py` with 3 new endpoints
|
||||
- [ ] Implement request/response validation
|
||||
- [ ] Add comprehensive error handling
|
||||
- [ ] Test with real websites and GSC data
|
||||
|
||||
### For DevOps
|
||||
- [ ] Set up Redis caching layer
|
||||
- [ ] Configure GSC API credentials
|
||||
- [ ] Set up LLM API integration (Claude/GPT)
|
||||
- [ ] Configure monitoring and logging
|
||||
- [ ] Plan staging environment
|
||||
|
||||
---
|
||||
|
||||
**Generated:** May 24, 2026
|
||||
**Next Review:** After Phase 2A.1 Backend Implementation
|
||||
**Questions?** Check `PHASE2A_INTEGRATION_GUIDE.md` or `COMPILATION_FIXES.md`
|
||||
@@ -1,667 +0,0 @@
|
||||
# Phase 2A Roadmap: Next Implementation Phases
|
||||
|
||||
**Current Status:** Frontend 100% Complete → Backend 0% Started → Ready for Phase 2A.1
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Big Picture: What's Done vs What's Needed
|
||||
|
||||
### ✅ COMPLETED (Frontend - 100%)
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────┐
|
||||
│ USER INTERFACE LAYER (Complete & Ready) │
|
||||
│ │
|
||||
│ SEODashboard Tab: "🔍 Enterprise Analysis" │
|
||||
│ ↓ │
|
||||
│ SEOAnalysisController (5-Step Workflow) │
|
||||
│ ├─ Step 1: Website Input Form │
|
||||
│ ├─ Step 2: Enterprise Audit Display │
|
||||
│ ├─ Step 3: GSC Analysis Display │
|
||||
│ ├─ Step 4: AI Insights Display │
|
||||
│ └─ Step 5: Review & Download │
|
||||
└─────────────────────────────────────────────────────────┘
|
||||
↓
|
||||
┌─────────────────────────────────────────────────────────┐
|
||||
│ SERVICE LAYER (Complete & Ready) │
|
||||
│ │
|
||||
│ ├─ enterpriseSeoApi.ts (API Client) │
|
||||
│ │ ├─ executeEnterpriseAudit() │
|
||||
│ │ ├─ analyzeGSCSearchPerformance() │
|
||||
│ │ ├─ getContentOpportunitiesReport() │
|
||||
│ │ └─ ... 12 more methods │
|
||||
│ │ │
|
||||
│ └─ llmInsightsGenerator.ts (Insights Service) │
|
||||
│ ├─ generateEnterpriseAuditInsights() │
|
||||
│ ├─ generateGSCAnalysisInsights() │
|
||||
│ ├─ generateTrafficRoadmap() │
|
||||
│ └─ ... 7 more insight methods │
|
||||
└─────────────────────────────────────────────────────────┘
|
||||
↓
|
||||
🔴 BLOCKED HERE 🔴
|
||||
(Backend Missing)
|
||||
↓
|
||||
┌─────────────────────────────────────────────────────────┐
|
||||
│ API ENDPOINTS (0% - Need Implementation) │
|
||||
│ │
|
||||
│ ❌ POST /api/seo-tools/enterprise/complete-audit │
|
||||
│ ❌ POST /api/seo-tools/gsc/analyze-search-performance │
|
||||
│ ❌ POST /api/seo-tools/gsc/content-opportunities │
|
||||
│ ❌ POST /api/seo-tools/llm/generate-audit-insights │
|
||||
│ ❌ ... 8 more LLM endpoints │
|
||||
└─────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔴 BLOCKER: Backend Not Implemented
|
||||
|
||||
### Why Testing Can't Proceed
|
||||
- ❌ No endpoints to call from frontend
|
||||
- ❌ No data flowing to UI components
|
||||
- ❌ Can't test end-to-end workflows
|
||||
- ❌ Can't validate LLM insights
|
||||
- ❌ Can't generate real reports
|
||||
|
||||
### Immediate Impact
|
||||
```
|
||||
Frontend Ready ✅ → Can't Test → Can't Deploy ❌
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📋 Phase 2A.1: Backend Core Endpoints (IMMEDIATE NEXT STEP)
|
||||
|
||||
### What Needs to Be Built
|
||||
|
||||
#### Endpoint 1: Enterprise Audit
|
||||
```
|
||||
POST /api/seo-tools/enterprise/complete-audit
|
||||
|
||||
REQUEST:
|
||||
{
|
||||
website_url: "https://example.com",
|
||||
competitors?: ["https://competitor1.com"],
|
||||
keywords?: ["target keyword 1"],
|
||||
analysis_type: "complete" | "quick"
|
||||
}
|
||||
|
||||
RESPONSE:
|
||||
{
|
||||
executive_summary: { score, traffic_potential, time_to_implement },
|
||||
technical_audit: { core_web_vitals, mobile_usability, page_speed },
|
||||
keyword_research: [ { keyword, volume, difficulty, current_ranking } ],
|
||||
competitive_analysis: { comparison, gaps, opportunities },
|
||||
implementation_roadmap: [ { phase, tasks, timeline } ],
|
||||
... 15+ more fields
|
||||
}
|
||||
```
|
||||
|
||||
**Backend Requirements:**
|
||||
- SEO analysis library (e.g., SEMrush API, Moz API, or self-built)
|
||||
- Technical audit tools (Core Web Vitals, page speed analysis)
|
||||
- Keyword research integration
|
||||
- Competitive analysis logic
|
||||
- Data aggregation and formatting
|
||||
|
||||
**Estimated Effort:** 400-600 lines of code
|
||||
|
||||
---
|
||||
|
||||
#### Endpoint 2: GSC Analysis
|
||||
```
|
||||
POST /api/seo-tools/gsc/analyze-search-performance
|
||||
|
||||
REQUEST:
|
||||
{
|
||||
site_url: "https://example.com",
|
||||
date_range: 90, // days
|
||||
include_competitors?: true
|
||||
}
|
||||
|
||||
RESPONSE:
|
||||
{
|
||||
performance_overview: { clicks, impressions, ctr, avg_position },
|
||||
top_keywords: [ { keyword, clicks, impressions, ctr, position } ],
|
||||
page_performance: [ { page_url, clicks, impressions, ctr, position } ],
|
||||
keyword_analysis: {
|
||||
opportunities: [...],
|
||||
declining_keywords: [...],
|
||||
needs_attention: [...]
|
||||
},
|
||||
content_opportunities: [ { keyword, traffic_gain, priority } ],
|
||||
technical_signals: { issues, fixes, score },
|
||||
... 10+ more fields
|
||||
}
|
||||
```
|
||||
|
||||
**Backend Requirements:**
|
||||
- Google Search Console API integration
|
||||
- GSC authentication (already have credentials ✅)
|
||||
- Data extraction and normalization
|
||||
- Trend analysis
|
||||
- Opportunity identification logic
|
||||
|
||||
**Estimated Effort:** 300-400 lines of code
|
||||
|
||||
---
|
||||
|
||||
#### Endpoint 3: Content Opportunities
|
||||
```
|
||||
POST /api/seo-tools/gsc/content-opportunities
|
||||
|
||||
REQUEST:
|
||||
{
|
||||
site_url: "https://example.com",
|
||||
analysis_type: "gap_analysis" | "expansion" | "optimization"
|
||||
}
|
||||
|
||||
RESPONSE:
|
||||
{
|
||||
opportunities: [
|
||||
{
|
||||
keyword: "target keyword",
|
||||
current_position: 15,
|
||||
traffic_potential: 500,
|
||||
difficulty: 45,
|
||||
recommendation: "Create new article targeting this keyword",
|
||||
priority: "high"
|
||||
}
|
||||
],
|
||||
total_traffic_potential: 15000,
|
||||
quick_wins: [...],
|
||||
competitive_gaps: [...]
|
||||
}
|
||||
```
|
||||
|
||||
**Backend Requirements:**
|
||||
- Keyword gap analysis logic
|
||||
- Traffic potential calculation
|
||||
- Difficulty scoring
|
||||
- Competitive benchmarking
|
||||
|
||||
**Estimated Effort:** 250-350 lines of code
|
||||
|
||||
---
|
||||
|
||||
### Phase 2A.1 Implementation Steps
|
||||
|
||||
#### Step 1: Setup Service Files (1 day)
|
||||
```python
|
||||
# backend/services/seo_tools/enterprise_seo_service.py
|
||||
class EnterpriseSEOService:
|
||||
def execute_complete_audit(self, request: EnterpriseAuditRequest) -> EnterpriseAuditResult:
|
||||
# Implement audit logic
|
||||
pass
|
||||
|
||||
def execute_quick_audit(self, request: QuickAuditRequest) -> EnterpriseAuditResult:
|
||||
# Implement quick audit
|
||||
pass
|
||||
|
||||
# backend/services/seo_tools/gsc_analyzer_service.py
|
||||
class GSCAnalyzerService:
|
||||
def analyze_search_performance(self, request: GSCAnalysisRequest) -> GSCAnalysisResult:
|
||||
# Implement GSC analysis
|
||||
pass
|
||||
|
||||
def get_content_opportunities(self, request: ContentOpportunitiesRequest) -> ContentOpportunitiesReport:
|
||||
# Implement opportunity analysis
|
||||
pass
|
||||
```
|
||||
|
||||
#### Step 2: Add Routes (1 day)
|
||||
```python
|
||||
# backend/routers/seo_tools.py - Add these routes:
|
||||
@router.post('/enterprise/complete-audit')
|
||||
async def complete_enterprise_audit(request: EnterpriseAuditRequest):
|
||||
# Call EnterpriseSEOService
|
||||
pass
|
||||
|
||||
@router.post('/gsc/analyze-search-performance')
|
||||
async def analyze_gsc_performance(request: GSCAnalysisRequest):
|
||||
# Call GSCAnalyzerService
|
||||
pass
|
||||
|
||||
@router.post('/gsc/content-opportunities')
|
||||
async def get_content_opportunities(request: ContentOpportunitiesRequest):
|
||||
# Call GSCAnalyzerService
|
||||
pass
|
||||
```
|
||||
|
||||
#### Step 3: Implement Business Logic (2-3 days)
|
||||
- Technical SEO analysis
|
||||
- GSC data extraction
|
||||
- Opportunity identification
|
||||
- Data formatting
|
||||
|
||||
#### Step 4: Testing (1-2 days)
|
||||
- Unit tests for each method
|
||||
- Integration tests
|
||||
- Real website testing
|
||||
- Error handling
|
||||
|
||||
#### Step 5: Documentation (1 day)
|
||||
- Endpoint documentation
|
||||
- API specs
|
||||
- Setup instructions
|
||||
|
||||
---
|
||||
|
||||
## 📋 Phase 2A.2: LLM Integration (FOLLOWS PHASE 2A.1)
|
||||
|
||||
### Once Backend Endpoints Working...
|
||||
|
||||
#### Create LLM Service
|
||||
```python
|
||||
# backend/services/seo_tools/llm_insights_service.py
|
||||
class LLMInsightsService:
|
||||
def generate_audit_insights(self, audit_result: EnterpriseAuditResult) -> List[ActionableInsight]:
|
||||
prompt = self.build_audit_insight_prompt(audit_result)
|
||||
response = llm_api.call(prompt)
|
||||
return parse_insights(response)
|
||||
|
||||
def generate_gsc_insights(self, gsc_result: GSCAnalysisResult) -> List[ActionableInsight]:
|
||||
# Similar pattern
|
||||
pass
|
||||
|
||||
# 6 more methods for different insight types
|
||||
```
|
||||
|
||||
#### Add LLM Endpoints (8 routes)
|
||||
1. `/api/seo-tools/llm/generate-audit-insights`
|
||||
2. `/api/seo-tools/llm/generate-gsc-insights`
|
||||
3. `/api/seo-tools/llm/generate-content-strategy`
|
||||
4. `/api/seo-tools/llm/generate-traffic-roadmap`
|
||||
5. `/api/seo-tools/llm/prioritized-recommendations`
|
||||
6. `/api/seo-tools/llm/quick-wins`
|
||||
7. `/api/seo-tools/llm/competitive-insights`
|
||||
8. `/api/seo-tools/llm/keyword-expansion`
|
||||
|
||||
#### LLM Prompt Templates (Ready in Frontend)
|
||||
The `llmInsightsGenerator.ts` has all 8 prompt templates. Backend just needs to:
|
||||
1. Accept the prompt from frontend
|
||||
2. Call LLM API (Claude/GPT)
|
||||
3. Parse response
|
||||
4. Return formatted insights
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Recommended Implementation Sequence
|
||||
|
||||
### Week 1: Phase 2A.1 Backend Core (CRITICAL)
|
||||
**Goal:** Get 3 core endpoints working
|
||||
|
||||
```
|
||||
Day 1-2: Setup
|
||||
├─ Create enterprise_seo_service.py
|
||||
├─ Create gsc_analyzer_service.py
|
||||
└─ Add routes to seo_tools.py
|
||||
|
||||
Day 3-4: Implementation
|
||||
├─ Implement audit analysis logic
|
||||
├─ Integrate GSC API
|
||||
└─ Add error handling
|
||||
|
||||
Day 5: Testing
|
||||
├─ Unit tests
|
||||
├─ Integration tests
|
||||
└─ Manual testing with real websites
|
||||
```
|
||||
|
||||
**Deliverable:** 3 functional endpoints + tests
|
||||
|
||||
---
|
||||
|
||||
### Week 2: Phase 2A.2 LLM Integration (CRITICAL)
|
||||
**Goal:** Get LLM insights working
|
||||
|
||||
```
|
||||
Day 1-2: Setup
|
||||
├─ Create llm_insights_service.py
|
||||
├─ Setup LLM API (Claude/GPT)
|
||||
└─ Add 8 LLM routes
|
||||
|
||||
Day 3-4: Implementation
|
||||
├─ Implement insight generation
|
||||
├─ Integrate LLM prompts
|
||||
└─ Add caching for performance
|
||||
|
||||
Day 5: Testing
|
||||
├─ Test insight accuracy
|
||||
├─ Validate traffic projections
|
||||
└─ Performance optimization
|
||||
```
|
||||
|
||||
**Deliverable:** 8 functional LLM endpoints + tests
|
||||
|
||||
---
|
||||
|
||||
### Week 3: Phase 2A.3 Optimization (RECOMMENDED)
|
||||
**Goal:** Add caching and database storage
|
||||
|
||||
```
|
||||
Day 1-2: Caching Layer
|
||||
├─ Setup Redis
|
||||
├─ Implement cache strategy
|
||||
└─ Cache invalidation logic
|
||||
|
||||
Day 3-4: Database
|
||||
├─ Add analysis history storage
|
||||
├─ Enable result comparison
|
||||
└─ Performance tuning
|
||||
|
||||
Day 5: Monitoring
|
||||
├─ Setup logging
|
||||
├─ Performance monitoring
|
||||
└─ Alerting
|
||||
```
|
||||
|
||||
**Deliverable:** 10x performance improvement
|
||||
|
||||
---
|
||||
|
||||
### Week 4: Phase 2A.4 Comprehensive Testing
|
||||
**Goal:** Validate everything works end-to-end
|
||||
|
||||
```
|
||||
Day 1: Unit Testing
|
||||
├─ Service method tests (50+)
|
||||
├─ Error scenario tests
|
||||
└─ Data validation tests
|
||||
|
||||
Day 2: Integration Testing
|
||||
├─ API endpoint tests (20+)
|
||||
├─ Database integration tests
|
||||
└─ LLM response tests
|
||||
|
||||
Day 3: E2E Testing
|
||||
├─ Frontend + Backend workflows
|
||||
├─ Real website testing (10+ sites)
|
||||
└─ Performance benchmarks
|
||||
|
||||
Day 4-5: Bug Fixes
|
||||
├─ Fix identified issues
|
||||
├─ Performance optimization
|
||||
└─ Edge case handling
|
||||
```
|
||||
|
||||
**Deliverable:** 80%+ test coverage, all tests passing
|
||||
|
||||
---
|
||||
|
||||
### Week 5: Phase 2A.5 Documentation & Deployment
|
||||
**Goal:** Document and release
|
||||
|
||||
```
|
||||
Day 1-2: Documentation
|
||||
├─ API documentation
|
||||
├─ User guides
|
||||
└─ Developer documentation
|
||||
|
||||
Day 3-4: Deployment
|
||||
├─ Staging environment setup
|
||||
├─ Production deployment
|
||||
└─ Monitoring setup
|
||||
|
||||
Day 5: Validation
|
||||
├─ Production testing
|
||||
├─ User acceptance testing
|
||||
└─ Rollback procedures
|
||||
```
|
||||
|
||||
**Deliverable:** Production-ready release
|
||||
|
||||
---
|
||||
|
||||
## 📊 Timeline & Resource Planning
|
||||
|
||||
```
|
||||
Phase 2A.1 Phase 2A.2 Phase 2A.3 Phase 2A.4 Phase 2A.5
|
||||
Week Core LLM Cache Test Deploy
|
||||
────────────────────────────────────────────────────────────────────────────────────────────
|
||||
1 May 24-30 ████████████
|
||||
(Backend Core)
|
||||
|
||||
2 May 31-Jun 6 ████████████
|
||||
(LLM Integration)
|
||||
|
||||
3 Jun 7-13 ████████████
|
||||
(Optimization)
|
||||
|
||||
4 Jun 14-20 ████████████
|
||||
(Testing)
|
||||
|
||||
5 Jun 21-27 ████████████
|
||||
(Deployment)
|
||||
|
||||
TOTAL: 5 working days 5 working days 5 working days 5 days 5 working days
|
||||
EFFORT: 80 hours (2x2) 80 hours (2x2) 40 hours 60 hours 40 hours
|
||||
TEAM: 2 Backend devs 1-2 Backend 1 Backend 2 QA/Dev 1 DevOps
|
||||
devs dev 1 Dev 1 Backend
|
||||
|
||||
Progress: 20% 40% 60% 80% 100%
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Success Criteria for Each Phase
|
||||
|
||||
### Phase 2A.1: Backend Core (WEEKS 1)
|
||||
✅ **MUST HAVE:**
|
||||
- [ ] 3 endpoints responding correctly
|
||||
- [ ] Request validation working
|
||||
- [ ] Response formats match frontend expectations
|
||||
- [ ] Error handling implemented
|
||||
- [ ] All tests passing
|
||||
|
||||
✅ **SHOULD HAVE:**
|
||||
- [ ] Database caching setup
|
||||
- [ ] Performance benchmarks met
|
||||
- [ ] Edge cases handled
|
||||
|
||||
⚠️ **NICE TO HAVE:**
|
||||
- [ ] Advanced analytics
|
||||
- [ ] Custom filters
|
||||
|
||||
---
|
||||
|
||||
### Phase 2A.2: LLM Integration (WEEKS 2)
|
||||
✅ **MUST HAVE:**
|
||||
- [ ] 8 LLM endpoints working
|
||||
- [ ] Traffic projections accurate
|
||||
- [ ] Priority scoring (1-10) implemented
|
||||
- [ ] Effort assessment working
|
||||
- [ ] All tests passing
|
||||
|
||||
✅ **SHOULD HAVE:**
|
||||
- [ ] Insights caching
|
||||
- [ ] Response time < 5 seconds
|
||||
- [ ] Prompt optimization complete
|
||||
|
||||
---
|
||||
|
||||
### Phase 2A.3: Optimization (WEEKS 3)
|
||||
✅ **MUST HAVE:**
|
||||
- [ ] Caching reduces response time by 80%
|
||||
- [ ] History storage working
|
||||
- [ ] Cache invalidation logic tested
|
||||
|
||||
✅ **SHOULD HAVE:**
|
||||
- [ ] Monitoring alerts set up
|
||||
- [ ] Performance dashboard
|
||||
|
||||
---
|
||||
|
||||
### Phase 2A.4: Testing (WEEKS 4)
|
||||
✅ **MUST HAVE:**
|
||||
- [ ] 80%+ test coverage
|
||||
- [ ] All tests passing
|
||||
- [ ] No critical bugs
|
||||
- [ ] Performance benchmarks met
|
||||
|
||||
---
|
||||
|
||||
### Phase 2A.5: Deployment (WEEKS 5)
|
||||
✅ **MUST HAVE:**
|
||||
- [ ] Production deployment successful
|
||||
- [ ] Monitoring active
|
||||
- [ ] User access working
|
||||
- [ ] No data loss
|
||||
|
||||
---
|
||||
|
||||
## 💡 Quick Reference: What to Build
|
||||
|
||||
### Backend Structure Needed
|
||||
```
|
||||
backend/services/seo_tools/
|
||||
├── enterprise_seo_service.py (New - 400 lines)
|
||||
├── gsc_analyzer_service.py (New - 350 lines)
|
||||
├── llm_insights_service.py (New - 500 lines)
|
||||
└── ...existing services...
|
||||
|
||||
backend/routers/
|
||||
├── seo_tools.py (Update - +150 lines)
|
||||
└── ...existing routers...
|
||||
```
|
||||
|
||||
### Database Schema Needed
|
||||
```sql
|
||||
-- Store analysis results
|
||||
CREATE TABLE seo_analyses (
|
||||
id UUID PRIMARY KEY,
|
||||
user_id UUID,
|
||||
website_url VARCHAR,
|
||||
analysis_type VARCHAR,
|
||||
results JSONB,
|
||||
created_at TIMESTAMP,
|
||||
cached_until TIMESTAMP
|
||||
);
|
||||
|
||||
-- Store insights
|
||||
CREATE TABLE insights (
|
||||
id UUID PRIMARY KEY,
|
||||
analysis_id UUID,
|
||||
insight_text TEXT,
|
||||
priority INT,
|
||||
traffic_gain INT,
|
||||
effort_level VARCHAR
|
||||
);
|
||||
```
|
||||
|
||||
### Environment Setup Needed
|
||||
```
|
||||
# .env additions
|
||||
GSC_API_KEY=...
|
||||
LLM_API_KEY=...
|
||||
REDIS_URL=redis://localhost:6379
|
||||
DATABASE_URL=postgres://...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚡ Quick Start for Phase 2A.1
|
||||
|
||||
### 1. Create Service File Structure
|
||||
```python
|
||||
# backend/services/seo_tools/enterprise_seo_service.py
|
||||
from fastapi import HTTPException
|
||||
from typing import Optional, List
|
||||
|
||||
class EnterpriseSEOService:
|
||||
"""Handles comprehensive enterprise SEO audits"""
|
||||
|
||||
async def execute_complete_audit(self, website_url: str, competitors: Optional[List[str]] = None):
|
||||
"""Execute complete enterprise audit"""
|
||||
try:
|
||||
# 1. Technical audit
|
||||
technical = await self._technical_audit(website_url)
|
||||
|
||||
# 2. Keyword research
|
||||
keywords = await self._keyword_research(website_url)
|
||||
|
||||
# 3. Competitive analysis
|
||||
competitive = await self._competitive_analysis(website_url, competitors)
|
||||
|
||||
# 4. On-page analysis
|
||||
on_page = await self._on_page_analysis(website_url)
|
||||
|
||||
# 5. Generate roadmap
|
||||
roadmap = self._generate_roadmap(technical, keywords, competitive, on_page)
|
||||
|
||||
return {
|
||||
'executive_summary': self._generate_summary(technical, keywords),
|
||||
'technical_audit': technical,
|
||||
'keyword_research': keywords,
|
||||
'competitive_analysis': competitive,
|
||||
'on_page_analysis': on_page,
|
||||
'implementation_roadmap': roadmap,
|
||||
}
|
||||
except Exception as e:
|
||||
raise HTTPException(status_code=500, detail=str(e))
|
||||
|
||||
async def _technical_audit(self, website_url: str):
|
||||
# Implement technical SEO analysis
|
||||
# Check Core Web Vitals, mobile usability, page speed, security, etc.
|
||||
pass
|
||||
|
||||
# ... more methods
|
||||
```
|
||||
|
||||
### 2. Add Routes
|
||||
```python
|
||||
# backend/routers/seo_tools.py
|
||||
from backend.services.seo_tools.enterprise_seo_service import EnterpriseSEOService
|
||||
|
||||
router = APIRouter()
|
||||
enterprise_service = EnterpriseSEOService()
|
||||
|
||||
@router.post('/enterprise/complete-audit')
|
||||
async def complete_enterprise_audit(website_url: str, competitors: Optional[List[str]] = None):
|
||||
return await enterprise_service.execute_complete_audit(website_url, competitors)
|
||||
```
|
||||
|
||||
### 3. Test Endpoint
|
||||
```bash
|
||||
curl -X POST http://localhost:8000/api/seo-tools/enterprise/complete-audit \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"website_url":"https://example.com"}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎬 Ready to Start?
|
||||
|
||||
### Recommended Next Action
|
||||
**Start Phase 2A.1 today:** Implement the 3 core backend endpoints to unblock all testing.
|
||||
|
||||
### Resources Provided
|
||||
1. ✅ `PHASE2A_INTEGRATION_GUIDE.md` - Complete frontend specs
|
||||
2. ✅ `COMPILATION_FIXES.md` - Fixed all 14 TypeScript errors
|
||||
3. ✅ Frontend code (4,850+ lines) - Ready to consume backend data
|
||||
4. ✅ LLM prompts in `llmInsightsGenerator.ts` - Ready to use
|
||||
5. ✅ Type definitions in `enterpriseSeoApi.ts` - Match backend models
|
||||
|
||||
### What's Blocking
|
||||
- ❌ Backend implementation NOT STARTED
|
||||
- ❌ No core endpoints
|
||||
- ❌ No LLM integration
|
||||
- ❌ Can't test end-to-end
|
||||
|
||||
### Next 24 Hours
|
||||
- [ ] Review this document
|
||||
- [ ] Estimate backend effort
|
||||
- [ ] Plan resource allocation
|
||||
- [ ] Start Phase 2A.1 implementation
|
||||
- [ ] Setup development environment
|
||||
|
||||
---
|
||||
|
||||
**Status:** Frontend 100% Complete → Backend Ready to Start
|
||||
**Next Checkpoint:** Phase 2A.1 Complete (3 endpoints working)
|
||||
**Timeline:** Can be done in 1-2 weeks with 2-3 developers
|
||||
|
||||
**Questions? Check:**
|
||||
- `PHASE2A_IMPLEMENTATION_REVIEW.md` - This file (detailed review)
|
||||
- `PHASE2A_INTEGRATION_GUIDE.md` - Frontend specifications
|
||||
- `COMPILATION_FIXES.md` - TypeScript fixes applied
|
||||
@@ -1,460 +0,0 @@
|
||||
# 📊 Phase 2A Implementation Status Dashboard
|
||||
|
||||
**Date:** May 24, 2026 | **Overall Progress:** 20% | **Current Phase:** Frontend Complete ✅
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Project Summary
|
||||
|
||||
| Metric | Status | Details |
|
||||
|--------|--------|---------|
|
||||
| **Project Name** | Phase 2A SEO Dashboard | Enterprise SEO Analysis Integration |
|
||||
| **Current Phase** | Frontend Implementation | ✅ COMPLETE |
|
||||
| **Total Phases** | 5 | 2A.1 through 2A.5 |
|
||||
| **Overall Progress** | 20% | Frontend 100%, Backend 0% |
|
||||
| **Timeline** | 5-8 weeks | Started: May 24, Target: Jun 28 |
|
||||
| **Team Size** | 2-3 devs | Frontend ✅, Backend ⏳ |
|
||||
| **Blocking Issues** | 1 Critical | Backend not started |
|
||||
|
||||
---
|
||||
|
||||
## 📈 Completion Status by Component
|
||||
|
||||
### Frontend Layer: ✅ 100% COMPLETE
|
||||
|
||||
```
|
||||
Component Status Lines Features Tests
|
||||
─────────────────────────────────────────────────────────────────────────
|
||||
enterpriseSeoApi.ts ✅ 650+ 15 methods ✅ Types
|
||||
llmInsightsGenerator.ts ✅ 450+ 10 methods ✅ Types
|
||||
EnterpriseAuditResults ✅ 800+ 8 sections ✅ Rendering
|
||||
GSCAnalysisResults ✅ 900+ 4 tabs ✅ Rendering
|
||||
ActionableInsightsDisplay ✅ 700+ Filtering ✅ Rendering
|
||||
SEOAnalysisController ✅ 750+ 5-step flow ✅ Integration
|
||||
SEODashboard (modified) ✅ ~50 Tab nav ✅ Tab works
|
||||
─────────────────────────────────────────────────────────────────────────
|
||||
TOTAL FRONTEND ✅ 4,850 50+ features ✅ READY
|
||||
```
|
||||
|
||||
### Backend Layer: 🔴 0% STARTED
|
||||
|
||||
```
|
||||
Component Status Priority Lines Effort
|
||||
─────────────────────────────────────────────────────────────────────
|
||||
Enterprise Audit Endpoint 🔴 P1 ~400 HIGH
|
||||
GSC Analysis Endpoint 🔴 P1 ~350 MEDIUM
|
||||
Content Opportunities EP 🔴 P1 ~300 MEDIUM
|
||||
LLM Audit Insights EP 🔴 P2 ~200 MEDIUM
|
||||
LLM GSC Insights EP 🔴 P2 ~200 MEDIUM
|
||||
LLM Content Strategy EP 🔴 P2 ~150 LOW
|
||||
LLM Traffic Roadmap EP 🔴 P2 ~150 LOW
|
||||
LLM Recommendations EP 🔴 P2 ~150 LOW
|
||||
LLM Quick Wins EP 🔴 P2 ~100 LOW
|
||||
LLM Competitive EP 🔴 P2 ~100 LOW
|
||||
LLM Keyword Expansion EP 🔴 P2 ~100 LOW
|
||||
Health Check Endpoint 🔴 P3 ~50 LOW
|
||||
─────────────────────────────────────────────────────────────────────
|
||||
TOTAL BACKEND 🔴 N/A ~2,650 HIGH
|
||||
```
|
||||
|
||||
### Database & Infrastructure: 🔴 0% STARTED
|
||||
|
||||
```
|
||||
Component Status Priority Effort
|
||||
─────────────────────────────────────────────────────────────────
|
||||
Redis Caching Layer 🔴 P2 MEDIUM
|
||||
Analysis History DB 🔴 P2 LOW
|
||||
Performance Monitoring 🔴 P3 LOW
|
||||
Logging Infrastructure 🔴 P3 LOW
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Phase Breakdown
|
||||
|
||||
### Phase 2A.0: Frontend Implementation ✅
|
||||
- **Status:** ✅ COMPLETE
|
||||
- **Duration:** 3 days
|
||||
- **Effort:** 40 hours
|
||||
- **Team:** 1 Frontend Dev
|
||||
- **Deliverable:** 6 components + full UI
|
||||
|
||||
**What Was Done:**
|
||||
- ✅ 4,850 lines of React/TypeScript code
|
||||
- ✅ 20+ TypeScript interfaces
|
||||
- ✅ 50+ UI components
|
||||
- ✅ Dashboard integration
|
||||
- ✅ Error handling
|
||||
|
||||
**What's Next:** Phase 2A.1
|
||||
|
||||
---
|
||||
|
||||
### Phase 2A.1: Backend Core Endpoints 🔴
|
||||
- **Status:** 🔴 NOT STARTED
|
||||
- **Duration:** 1 week
|
||||
- **Effort:** 40-50 hours
|
||||
- **Team:** 2 Backend Devs
|
||||
- **Priority:** ⚠️ CRITICAL - BLOCKING ALL TESTING
|
||||
|
||||
**What Needs to Be Done:**
|
||||
- [ ] Enterprise audit service (400 lines)
|
||||
- [ ] GSC analyzer service (350 lines)
|
||||
- [ ] 3 API endpoints
|
||||
- [ ] Request/response validation
|
||||
- [ ] Error handling
|
||||
- [ ] Unit tests
|
||||
- [ ] Integration tests
|
||||
|
||||
**Blocking Factors:**
|
||||
- ❌ 3 core endpoints not implemented
|
||||
- ❌ No business logic
|
||||
- ❌ No data flowing to frontend
|
||||
- ❌ Testing impossible
|
||||
|
||||
**Success Criteria:**
|
||||
- ✅ 3 endpoints functional
|
||||
- ✅ Tests passing
|
||||
- ✅ Real data flowing
|
||||
- ✅ Frontend can make calls
|
||||
|
||||
---
|
||||
|
||||
### Phase 2A.2: LLM Integration 🔴
|
||||
- **Status:** 🔴 BLOCKED (Pending 2A.1)
|
||||
- **Duration:** 1 week
|
||||
- **Effort:** 40-50 hours
|
||||
- **Team:** 1-2 Backend Devs
|
||||
- **Priority:** ⚠️ CRITICAL
|
||||
|
||||
**What Needs to Be Done:**
|
||||
- [ ] LLM insights service (500 lines)
|
||||
- [ ] 8 LLM endpoints
|
||||
- [ ] Prompt optimization
|
||||
- [ ] Response parsing
|
||||
- [ ] Caching strategy
|
||||
- [ ] Performance optimization
|
||||
|
||||
**Dependencies:**
|
||||
- ⏳ Depends on Phase 2A.1
|
||||
- ⏳ Needs LLM API setup
|
||||
- ⏳ Requires prompt templates (ready ✅)
|
||||
|
||||
---
|
||||
|
||||
### Phase 2A.3: Database & Caching 🔴
|
||||
- **Status:** 🔴 BLOCKED (Pending 2A.2)
|
||||
- **Duration:** 1 week
|
||||
- **Effort:** 30 hours
|
||||
- **Team:** 1 Backend Dev + 1 DevOps
|
||||
- **Priority:** HIGH (for production)
|
||||
|
||||
**What Needs to Be Done:**
|
||||
- [ ] Redis setup
|
||||
- [ ] Cache invalidation logic
|
||||
- [ ] Database schema
|
||||
- [ ] History storage
|
||||
- [ ] Performance tuning
|
||||
|
||||
**Benefit:** 10x performance improvement
|
||||
|
||||
---
|
||||
|
||||
### Phase 2A.4: Testing 🔴
|
||||
- **Status:** 🔴 BLOCKED (Pending 2A.3)
|
||||
- **Duration:** 1-2 weeks
|
||||
- **Effort:** 50 hours
|
||||
- **Team:** 2 QA + 1 Dev
|
||||
- **Priority:** HIGH
|
||||
|
||||
**What Needs to Be Done:**
|
||||
- [ ] 50+ unit tests
|
||||
- [ ] 20+ integration tests
|
||||
- [ ] 10+ E2E tests
|
||||
- [ ] Manual testing
|
||||
- [ ] Performance validation
|
||||
- [ ] Bug fixes
|
||||
|
||||
**Target:** 80%+ code coverage
|
||||
|
||||
---
|
||||
|
||||
### Phase 2A.5: Documentation & Deployment 🔴
|
||||
- **Status:** 🔴 BLOCKED (Pending 2A.4)
|
||||
- **Duration:** 1 week
|
||||
- **Effort:** 30 hours
|
||||
- **Team:** 1 Backend Dev + 1 DevOps
|
||||
- **Priority:** MEDIUM
|
||||
|
||||
**What Needs to Be Done:**
|
||||
- [ ] API documentation
|
||||
- [ ] User guides
|
||||
- [ ] Developer documentation
|
||||
- [ ] Deployment procedures
|
||||
- [ ] Monitoring setup
|
||||
- [ ] Rollback procedures
|
||||
|
||||
---
|
||||
|
||||
## 📊 Overall Project Progress
|
||||
|
||||
```
|
||||
TOTAL PROJECT PROGRESS: 20% COMPLETE
|
||||
═══════════════════════════════════════════════════════════════
|
||||
|
||||
Frontend: ████████████████████░░░░░░░░░░░░░░░░░░░░░░ 100%
|
||||
Backend Core: ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0%
|
||||
LLM Integration: ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0%
|
||||
Infrastructure: ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0%
|
||||
Testing: ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0%
|
||||
Deployment: ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0%
|
||||
|
||||
WEEK-BY-WEEK PROJECTION:
|
||||
|
||||
Week 1 (May 24-30): ████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 20%
|
||||
Frontend ✅ + Start Backend Core
|
||||
|
||||
Week 2 (May 31-Jun6): ████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 40%
|
||||
Backend Core ✅ + Start LLM
|
||||
|
||||
Week 3 (Jun 7-13): ████████████░░░░░░░░░░░░░░░░░░░░░░░░░░░ 60%
|
||||
LLM Integration ✅ + Start DB/Cache
|
||||
|
||||
Week 4 (Jun 14-20): ████████████████░░░░░░░░░░░░░░░░░░░░░░░░ 80%
|
||||
Infrastructure ✅ + Start Testing
|
||||
|
||||
Week 5 (Jun 21-27): ████████████████████░░░░░░░░░░░░░░░░░░░░ 100%
|
||||
Testing + Deployment ✅
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Current Blockers
|
||||
|
||||
### 🔴 CRITICAL: Backend Implementation Not Started
|
||||
- **Impact:** Complete blocker for all testing
|
||||
- **Severity:** Critical
|
||||
- **Current Status:** 0% done
|
||||
- **Time to Unblock:** 1 week
|
||||
- **Action Required:** Start Phase 2A.1 immediately
|
||||
|
||||
### 🟡 Dependencies
|
||||
| Phase | Depends On | Status |
|
||||
|-------|-----------|--------|
|
||||
| 2A.1 | N/A | 🔴 Blocked by resources |
|
||||
| 2A.2 | 2A.1 | 🔴 Blocked by 2A.1 |
|
||||
| 2A.3 | 2A.2 | 🔴 Blocked by 2A.2 |
|
||||
| 2A.4 | 2A.3 | 🔴 Blocked by 2A.3 |
|
||||
| 2A.5 | 2A.4 | 🔴 Blocked by 2A.4 |
|
||||
|
||||
---
|
||||
|
||||
## 📋 Action Items by Priority
|
||||
|
||||
### 🔴 IMMEDIATE (Next 24 Hours)
|
||||
- [ ] Review this status dashboard
|
||||
- [ ] Allocate backend development resources
|
||||
- [ ] Setup development environment
|
||||
- [ ] Start Phase 2A.1 backend core implementation
|
||||
- [ ] Create service files (enterprise_seo_service.py, gsc_analyzer_service.py)
|
||||
|
||||
### 🟡 SHORT TERM (Next Week)
|
||||
- [ ] Complete Phase 2A.1 (3 endpoints working)
|
||||
- [ ] Implement business logic for enterprise audit
|
||||
- [ ] Integrate GSC API
|
||||
- [ ] Write unit tests
|
||||
- [ ] Manual testing with real websites
|
||||
|
||||
### 🟢 MEDIUM TERM (2-3 Weeks)
|
||||
- [ ] Start Phase 2A.2 LLM integration
|
||||
- [ ] Implement 8 LLM endpoints
|
||||
- [ ] Optimize LLM prompts
|
||||
- [ ] Setup caching layer
|
||||
- [ ] Begin comprehensive testing
|
||||
|
||||
### 🔵 LONG TERM (4-5 Weeks)
|
||||
- [ ] Complete all testing
|
||||
- [ ] Deploy to staging
|
||||
- [ ] UAT and bug fixes
|
||||
- [ ] Deploy to production
|
||||
- [ ] Monitor and optimize
|
||||
|
||||
---
|
||||
|
||||
## 📞 Resource Requirements
|
||||
|
||||
### Phase 2A.1 (Backend Core)
|
||||
```
|
||||
Role Count Hours/Week Total Hours
|
||||
─────────────────────────────────────────────────
|
||||
Backend Dev 2 20 40 hours
|
||||
QA/Tester 0.5 5 5 hours
|
||||
DevOps 0 0 0 hours
|
||||
─────────────────────────────────────────────────
|
||||
TOTAL 2.5 25 45 hours
|
||||
```
|
||||
|
||||
### Phase 2A.2 (LLM Integration)
|
||||
```
|
||||
Role Count Hours/Week Total Hours
|
||||
─────────────────────────────────────────────────
|
||||
Backend Dev 1-2 20 40 hours
|
||||
LLM Specialist 0.5 5 5 hours
|
||||
QA/Tester 0.5 5 5 hours
|
||||
─────────────────────────────────────────────────
|
||||
TOTAL 2-2.5 30 50 hours
|
||||
```
|
||||
|
||||
### Full Project (2A.1 through 2A.5)
|
||||
```
|
||||
Role Total Hours
|
||||
─────────────────────────────────
|
||||
Backend Dev ~250 hours
|
||||
Frontend Dev 40 hours (done)
|
||||
QA/Tester ~80 hours
|
||||
DevOps ~50 hours
|
||||
LLM Specialist ~20 hours
|
||||
─────────────────────────────────
|
||||
TOTAL ~440 hours
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💰 ROI & Impact
|
||||
|
||||
### Frontend ROI (Completed)
|
||||
- ✅ 4,850 lines of production-ready code
|
||||
- ✅ 50+ UI components
|
||||
- ✅ Full enterprise SEO analysis UI
|
||||
- ✅ LLM prompt integration ready
|
||||
- ✅ Zero technical debt
|
||||
|
||||
### Expected Backend ROI (Pending)
|
||||
- 📊 Enterprise-grade SEO audit capability
|
||||
- 📈 LLM-powered insights (8 types)
|
||||
- 🚀 Traffic improvement guidance
|
||||
- 💡 Competitive analysis
|
||||
- 🎯 Implementation roadmaps
|
||||
|
||||
### Business Impact
|
||||
- Differentiator: First LLM-powered SEO dashboard
|
||||
- Monetization: Premium feature for enterprise tier
|
||||
- User Value: Actionable insights → Traffic growth
|
||||
- Market Position: Advanced SEO intelligence
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Success Metrics
|
||||
|
||||
### Phase 2A.1 Success
|
||||
- [ ] 3 endpoints fully functional
|
||||
- [ ] Response time < 10 seconds
|
||||
- [ ] 95% uptime in testing
|
||||
- [ ] All tests passing
|
||||
- [ ] No critical bugs
|
||||
|
||||
### Phase 2A.2 Success
|
||||
- [ ] 8 LLM endpoints working
|
||||
- [ ] Insights generate < 5 seconds
|
||||
- [ ] Traffic projections ± 20% accuracy
|
||||
- [ ] User satisfaction > 4.5/5
|
||||
- [ ] No data corruption
|
||||
|
||||
### Phase 2A.5 Success
|
||||
- [ ] All tests passing
|
||||
- [ ] 80%+ code coverage
|
||||
- [ ] Performance benchmarks met
|
||||
- [ ] Zero critical bugs
|
||||
- [ ] User acceptance achieved
|
||||
|
||||
---
|
||||
|
||||
## 📅 Gantt Chart View
|
||||
|
||||
```
|
||||
Task May Jun Jul Status
|
||||
────────────────────────────────────────────────────────
|
||||
Frontend (Done) ✅ Complete
|
||||
├─ Phase 2A.0 Frontend ✅
|
||||
│
|
||||
Backend & Infrastructure
|
||||
├─ Phase 2A.1 Core ▓▓▓▓░░░░░░░░░ 🔴 0%
|
||||
├─ Phase 2A.2 LLM ▓▓▓▓░░░░░ 🔴 0%
|
||||
├─ Phase 2A.3 DB/Cache ▓▓▓ 🔴 0%
|
||||
├─ Phase 2A.4 Testing ▓ 🔴 0%
|
||||
└─ Phase 2A.5 Deploy ▓ 🔴 0%
|
||||
|
||||
Legend: ✅ Complete | ▓ In Progress | ░ Pending
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📞 Next Steps (Quick Checklist)
|
||||
|
||||
### Today (May 24)
|
||||
- [ ] Team reviews this status document
|
||||
- [ ] Stakeholder approval for Phase 2A.1
|
||||
- [ ] Backend team setup environment
|
||||
- [ ] Create JIRA tickets for Phase 2A.1
|
||||
|
||||
### Tomorrow (May 25)
|
||||
- [ ] Start Phase 2A.1 implementation
|
||||
- [ ] Create service files
|
||||
- [ ] Implement first endpoint
|
||||
- [ ] Setup testing environment
|
||||
|
||||
### This Week
|
||||
- [ ] 3 core endpoints working
|
||||
- [ ] Unit tests passing
|
||||
- [ ] Manual testing on real sites
|
||||
- [ ] Ready to move to Phase 2A.2
|
||||
|
||||
---
|
||||
|
||||
## 📊 Key Metrics Dashboard
|
||||
|
||||
| Metric | Current | Target | Status |
|
||||
|--------|---------|--------|--------|
|
||||
| Frontend Completion | 100% | 100% | ✅ On Track |
|
||||
| Backend Completion | 0% | 100% | 🔴 Blocked |
|
||||
| Test Coverage | N/A | 80% | ⏳ Pending |
|
||||
| Performance Target | N/A | <5s | ⏳ Pending |
|
||||
| Bug Count | 0 | 0 | ✅ On Track |
|
||||
| Deployment Readiness | 20% | 100% | 🟡 Need Backend |
|
||||
|
||||
---
|
||||
|
||||
## 🎓 Documentation Provided
|
||||
|
||||
| Document | Location | Status | Purpose |
|
||||
|----------|----------|--------|---------|
|
||||
| Integration Guide | `PHASE2A_INTEGRATION_GUIDE.md` | ✅ Ready | Frontend specs |
|
||||
| Implementation Review | `PHASE2A_IMPLEMENTATION_REVIEW.md` | ✅ Ready | Detailed review |
|
||||
| Next Steps | `PHASE2A_NEXT_STEPS.md` | ✅ Ready | Roadmap |
|
||||
| Compilation Fixes | `COMPILATION_FIXES.md` | ✅ Ready | Error resolution |
|
||||
| This File | `PHASE2A_STATUS_DASHBOARD.md` | ✅ Ready | Current status |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Call to Action
|
||||
|
||||
**IMMEDIATE ACTION REQUIRED:**
|
||||
|
||||
Start Phase 2A.1 backend implementation to unblock:
|
||||
- ✅ Frontend testing
|
||||
- ✅ Integration testing
|
||||
- ✅ Full workflow validation
|
||||
- ✅ Timeline adherence
|
||||
|
||||
**Recommended Timeline:** Begin TODAY for June 28 completion
|
||||
|
||||
**Resources Needed:** 2-3 backend developers for next 5 weeks
|
||||
|
||||
**Expected Outcome:** Production-ready enterprise SEO dashboard with LLM-powered insights
|
||||
|
||||
---
|
||||
|
||||
**Generated:** May 24, 2026
|
||||
**Last Updated:** May 24, 2026
|
||||
**Next Review:** Daily during Phase 2A.1
|
||||
**Questions:** Check `PHASE2A_IMPLEMENTATION_REVIEW.md`
|
||||
@@ -1,342 +0,0 @@
|
||||
# Phase 2A - Quick Reference Guide
|
||||
|
||||
**Last Updated:** May 24, 2026 | **Status:** Frontend 100% ✅ | Backend 0% 🔴
|
||||
|
||||
---
|
||||
|
||||
## 📍 Where We Are
|
||||
|
||||
```
|
||||
WHAT'S COMPLETE ✅
|
||||
├─ 6 React components (4,850 lines)
|
||||
├─ Type-safe API client (650 lines)
|
||||
├─ LLM prompts service (450 lines)
|
||||
├─ Dashboard tab integration
|
||||
├─ Error handling & loading states
|
||||
├─ Material-UI styling
|
||||
├─ Full TypeScript support
|
||||
└─ 14 compilation errors fixed
|
||||
|
||||
WHAT'S BLOCKING 🔴
|
||||
├─ 12 backend endpoints (not started)
|
||||
├─ Enterprise audit service (not started)
|
||||
├─ GSC analyzer service (not started)
|
||||
├─ LLM insights service (not started)
|
||||
├─ Database/caching layer (not started)
|
||||
└─ All testing (can't start without backend)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Where We're Going
|
||||
|
||||
### Phase 2A.1: Backend Core (NEXT - 1 week)
|
||||
**Priority:** 🔴 CRITICAL
|
||||
**Effort:** 40-50 hours
|
||||
**Team:** 2 backend developers
|
||||
|
||||
**What to Build:**
|
||||
- [x] Enterprise audit endpoint
|
||||
- [x] GSC analysis endpoint
|
||||
- [x] Content opportunities endpoint
|
||||
- [x] Business logic
|
||||
- [x] Error handling
|
||||
- [x] Unit tests
|
||||
|
||||
**Unblocks:**
|
||||
- ✅ Frontend testing
|
||||
- ✅ Integration testing
|
||||
- ✅ End-to-end workflows
|
||||
- ✅ Phase 2A.2
|
||||
|
||||
### Phase 2A.2: LLM Integration (AFTER 2A.1 - 1 week)
|
||||
**Priority:** 🔴 CRITICAL
|
||||
**Effort:** 40-50 hours
|
||||
**Team:** 1-2 backend developers
|
||||
|
||||
**What to Build:**
|
||||
- [x] 8 LLM insight endpoints
|
||||
- [x] Prompt optimization
|
||||
- [x] Response parsing
|
||||
- [x] Caching strategy
|
||||
|
||||
**Unblocks:**
|
||||
- ✅ Insight generation
|
||||
- ✅ Traffic improvement guidance
|
||||
- ✅ Phase 2A.3
|
||||
|
||||
### Phase 2A.3: Infrastructure (AFTER 2A.2 - 1 week)
|
||||
**Priority:** HIGH
|
||||
**Benefit:** 10x performance improvement
|
||||
|
||||
**What to Build:**
|
||||
- [x] Redis caching
|
||||
- [x] Database schema
|
||||
- [x] History storage
|
||||
|
||||
### Phase 2A.4: Testing (AFTER 2A.3 - 1-2 weeks)
|
||||
**Priority:** HIGH
|
||||
**Target:** 80%+ coverage
|
||||
|
||||
**What to Build:**
|
||||
- [x] 50+ unit tests
|
||||
- [x] 20+ integration tests
|
||||
- [x] 10+ E2E tests
|
||||
|
||||
### Phase 2A.5: Deployment (AFTER 2A.4 - 1 week)
|
||||
**Priority:** MEDIUM
|
||||
|
||||
**What to Build:**
|
||||
- [x] API documentation
|
||||
- [x] Deployment procedures
|
||||
- [x] Monitoring setup
|
||||
|
||||
---
|
||||
|
||||
## 📚 Documentation Map
|
||||
|
||||
| Need | Document | Read Time |
|
||||
|------|----------|-----------|
|
||||
| **Full Implementation Details** | `PHASE2A_IMPLEMENTATION_REVIEW.md` | 20 min |
|
||||
| **Component Specifications** | `PHASE2A_INTEGRATION_GUIDE.md` | 15 min |
|
||||
| **Implementation Roadmap** | `PHASE2A_NEXT_STEPS.md` | 15 min |
|
||||
| **Status Tracking** | `PHASE2A_STATUS_DASHBOARD.md` | 10 min |
|
||||
| **Compilation Fixes** | `COMPILATION_FIXES.md` | 5 min |
|
||||
| **Complete Review** | `PHASE2A_COMPLETE_REVIEW.md` | 25 min |
|
||||
| **Quick Reference** | This File | 3 min |
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Key Files in Codebase
|
||||
|
||||
### Frontend Components
|
||||
```
|
||||
frontend/src/api/
|
||||
├── enterpriseSeoApi.ts (650 lines)
|
||||
└── llmInsightsGenerator.ts (450 lines)
|
||||
|
||||
frontend/src/components/SEODashboard/
|
||||
├── SEOAnalysisController.tsx (750 lines)
|
||||
└── components/
|
||||
├── EnterpriseAuditResults.tsx (800 lines)
|
||||
├── GSCAnalysisResults.tsx (900 lines)
|
||||
└── ActionableInsightsDisplay.tsx (700 lines)
|
||||
|
||||
frontend/src/components/SEODashboard/
|
||||
└── SEODashboard.tsx (modified - added tabs)
|
||||
```
|
||||
|
||||
### Documentation
|
||||
```
|
||||
Root directory:
|
||||
├── PHASE2A_INTEGRATION_GUIDE.md
|
||||
├── PHASE2A_IMPLEMENTATION_REVIEW.md
|
||||
├── PHASE2A_NEXT_STEPS.md
|
||||
├── PHASE2A_STATUS_DASHBOARD.md
|
||||
├── PHASE2A_COMPLETE_REVIEW.md
|
||||
├── COMPILATION_FIXES.md
|
||||
└── FILE_INDEX.md
|
||||
```
|
||||
|
||||
### Backend (Not Started)
|
||||
```
|
||||
backend/services/seo_tools/
|
||||
├── enterprise_seo_service.py (NEEDS CREATION)
|
||||
├── gsc_analyzer_service.py (NEEDS CREATION)
|
||||
└── llm_insights_service.py (NEEDS CREATION)
|
||||
|
||||
backend/routers/
|
||||
└── seo_tools.py (NEEDS UPDATES - add 12 endpoints)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚡ Quick Status Check
|
||||
|
||||
### Frontend Ready?
|
||||
```
|
||||
✅ API client complete
|
||||
✅ All components created
|
||||
✅ Dashboard integrated
|
||||
✅ TypeScript errors fixed
|
||||
✅ Error handling in place
|
||||
✅ Loading states working
|
||||
= READY TO TEST (waiting for backend)
|
||||
```
|
||||
|
||||
### Backend Ready?
|
||||
```
|
||||
🔴 No endpoints
|
||||
🔴 No services
|
||||
🔴 No database
|
||||
🔴 No LLM integration
|
||||
🔴 No tests
|
||||
= NOT READY (must start Phase 2A.1)
|
||||
```
|
||||
|
||||
### Can We Deploy?
|
||||
```
|
||||
🔴 NO - Backend not implemented
|
||||
🔴 NO - No testing done
|
||||
🔴 NO - No production checks
|
||||
🔴 NO - No monitoring
|
||||
= BLOCKED (need 4+ weeks of backend work)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📞 Action Items
|
||||
|
||||
### For Frontend Developers
|
||||
- ✅ Review complete (all components ready)
|
||||
- ✅ Testing ready (can start mock testing)
|
||||
- ✅ Documentation complete
|
||||
|
||||
### For Backend Developers
|
||||
- [ ] **TODAY:** Review Phase 2A.1 requirements
|
||||
- [ ] **TODAY:** Setup development environment
|
||||
- [ ] **TODAY:** Create service file stubs
|
||||
- [ ] **TOMORROW:** Start enterprise audit service
|
||||
- [ ] **THIS WEEK:** Complete 3 core endpoints
|
||||
|
||||
### For DevOps
|
||||
- [ ] Plan infrastructure needs
|
||||
- [ ] Setup Redis for caching
|
||||
- [ ] Plan database schema
|
||||
- [ ] Setup monitoring
|
||||
|
||||
### For Product/Stakeholders
|
||||
- [ ] Review documentation
|
||||
- [ ] Approve timeline (5 weeks to production)
|
||||
- [ ] Allocate resources (2-3 developers)
|
||||
- [ ] Set success criteria
|
||||
|
||||
---
|
||||
|
||||
## 🚀 How to Start Phase 2A.1
|
||||
|
||||
### Step 1: Create Service File
|
||||
```python
|
||||
# backend/services/seo_tools/enterprise_seo_service.py
|
||||
|
||||
class EnterpriseSEOService:
|
||||
async def execute_complete_audit(self, website_url: str):
|
||||
# Implement business logic
|
||||
pass
|
||||
|
||||
async def execute_quick_audit(self, website_url: str):
|
||||
# Implement quick version
|
||||
pass
|
||||
```
|
||||
|
||||
### Step 2: Add Route
|
||||
```python
|
||||
# backend/routers/seo_tools.py
|
||||
|
||||
@router.post('/enterprise/complete-audit')
|
||||
async def complete_audit(website_url: str):
|
||||
service = EnterpriseSEOService()
|
||||
return await service.execute_complete_audit(website_url)
|
||||
```
|
||||
|
||||
### Step 3: Test
|
||||
```bash
|
||||
curl -X POST http://localhost:8000/api/seo-tools/enterprise/complete-audit
|
||||
```
|
||||
|
||||
### Step 4: Implement
|
||||
Fill in business logic based on requirements in `PHASE2A_NEXT_STEPS.md`
|
||||
|
||||
---
|
||||
|
||||
## 📊 Timeline at a Glance
|
||||
|
||||
```
|
||||
Week 1: Phase 2A.1 Backend Core [████░░░░░░░░░░░░░░░░░░░░] 20%
|
||||
Week 2: Phase 2A.2 LLM Integration [████████░░░░░░░░░░░░░░░░] 40%
|
||||
Week 3: Phase 2A.3 Infrastructure [████████████░░░░░░░░░░░░] 60%
|
||||
Week 4: Phase 2A.4 Testing [████████████████░░░░░░░░] 80%
|
||||
Week 5: Phase 2A.5 Deployment [████████████████████░░░░] 100%
|
||||
|
||||
Target Completion: June 28, 2026
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✨ Key Metrics
|
||||
|
||||
| Metric | Current | Target | Status |
|
||||
|--------|---------|--------|--------|
|
||||
| Frontend Complete | 100% | 100% | ✅ On Track |
|
||||
| Backend Complete | 0% | 100% | 🔴 Blocked |
|
||||
| Test Coverage | - | 80% | ⏳ Pending |
|
||||
| Performance | - | <5s | ⏳ Pending |
|
||||
| Bugs | 0 | 0 | ✅ On Track |
|
||||
| Timeline | Week 1/5 | Week 5/5 | 🟡 At Risk |
|
||||
|
||||
---
|
||||
|
||||
## 💬 Quick Q&A
|
||||
|
||||
**Q: Is the frontend ready to ship?**
|
||||
A: No, backend endpoints not implemented yet.
|
||||
|
||||
**Q: How long until production?**
|
||||
A: 5 weeks if we start Phase 2A.1 TODAY.
|
||||
|
||||
**Q: What's blocking us?**
|
||||
A: Backend implementation not started.
|
||||
|
||||
**Q: How many developers needed?**
|
||||
A: 2-3 backend developers for next 5 weeks.
|
||||
|
||||
**Q: Can we test the frontend?**
|
||||
A: Yes, with mock data. But can't test end-to-end without backend.
|
||||
|
||||
**Q: What if we delay Phase 2A.1?**
|
||||
A: Timeline pushes back 1 week per week of delay.
|
||||
|
||||
**Q: Is there technical debt?**
|
||||
A: No, frontend is clean and production-ready.
|
||||
|
||||
**Q: What's the biggest risk?**
|
||||
A: Backend implementation doesn't start immediately.
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Next Steps (24 Hours)
|
||||
|
||||
1. **Discuss** this review with team
|
||||
2. **Allocate** 2-3 backend developers
|
||||
3. **Setup** development environment
|
||||
4. **Assign** Phase 2A.1 tasks
|
||||
5. **Start** implementation
|
||||
|
||||
---
|
||||
|
||||
## 📞 Need More Details?
|
||||
|
||||
| Topic | Document |
|
||||
|-------|----------|
|
||||
| Component Details | PHASE2A_INTEGRATION_GUIDE.md |
|
||||
| Backend Blueprint | PHASE2A_NEXT_STEPS.md |
|
||||
| Timeline & Resources | PHASE2A_IMPLEMENTATION_REVIEW.md |
|
||||
| Real-time Status | PHASE2A_STATUS_DASHBOARD.md |
|
||||
| Compilation Issues | COMPILATION_FIXES.md |
|
||||
|
||||
---
|
||||
|
||||
## ✅ Sign-Off Checklist
|
||||
|
||||
- [ ] Reviewed frontend completion status
|
||||
- [ ] Understand backend requirements
|
||||
- [ ] Aware of 5-week timeline
|
||||
- [ ] Know Phase 2A.1 is blocking factor
|
||||
- [ ] Ready to allocate resources
|
||||
- [ ] Agreed to start immediately
|
||||
|
||||
---
|
||||
|
||||
**Status:** Frontend Ready ✅ | Backend Needed 🔴
|
||||
**Action:** Start Phase 2A.1 TODAY
|
||||
**Contact:** Check documentation for details
|
||||
117
ToBeMigrated/ai_marketing_tools/ai_backlinker/README.md
Normal file
117
ToBeMigrated/ai_marketing_tools/ai_backlinker/README.md
Normal file
@@ -0,0 +1,117 @@
|
||||
---
|
||||
|
||||
# AI Backlinking Tool
|
||||
|
||||
## Overview
|
||||
|
||||
The `ai_backlinking.py` module is part of the [AI-Writer](https://github.com/AJaySi/AI-Writer) project. It simplifies and automates the process of finding and securing backlink opportunities. Using AI, the tool performs web research, extracts contact information, and sends personalized outreach emails for guest posting opportunities, making it an essential tool for content writers, digital marketers, and solopreneurs.
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
| Feature | Description |
|
||||
|-------------------------------|-----------------------------------------------------------------------------|
|
||||
| **Automated Web Scraping** | Extract guest post opportunities, contact details, and website insights. |
|
||||
| **AI-Powered Emails** | Create personalized outreach emails tailored to target websites. |
|
||||
| **Email Automation** | Integrate with platforms like Gmail or SendGrid for streamlined communication. |
|
||||
| **Lead Management** | Track email status (sent, replied, successful) and follow up efficiently. |
|
||||
| **Batch Processing** | Handle multiple keywords and queries simultaneously. |
|
||||
| **AI-Driven Follow-Up** | Automate polite reminders if there's no response. |
|
||||
| **Reports and Analytics** | View performance metrics like email open rates and backlink success rates. |
|
||||
|
||||
---
|
||||
|
||||
## Workflow Breakdown
|
||||
|
||||
| Step | Action | Example |
|
||||
|-------------------------------|---------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|
|
||||
| **Input Keywords** | Provide keywords for backlinking opportunities. | *E.g., "AI tools", "SEO strategies", "content marketing."* |
|
||||
| **Generate Search Queries** | Automatically create queries for search engines. | *E.g., "AI tools + 'write for us'" or "content marketing + 'submit a guest post.'"* |
|
||||
| **Web Scraping** | Collect URLs, email addresses, and content details from target websites. | Extract "editor@contentblog.com" from "https://contentblog.com/write-for-us". |
|
||||
| **Compose Outreach Emails** | Use AI to draft personalized emails based on scraped website data. | Email tailored to "Content Blog" discussing "AI tools for better content writing." |
|
||||
| **Automated Email Sending** | Review and send emails or fully automate the process. | Send emails through Gmail or other SMTP services. |
|
||||
| **Follow-Ups** | Automate follow-ups for non-responsive contacts. | A polite reminder email sent 7 days later. |
|
||||
| **Track and Log Results** | Monitor sent emails, responses, and backlink placements. | View logs showing responses and backlink acquisition rate. |
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- **Python Version**: 3.6 or higher.
|
||||
- **Required Packages**: `googlesearch-python`, `loguru`, `smtplib`, `email`.
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
1. Clone the repository:
|
||||
```bash
|
||||
git clone https://github.com/AJaySi/AI-Writer.git
|
||||
cd AI-Writer
|
||||
```
|
||||
|
||||
2. Install dependencies:
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Example Usage
|
||||
|
||||
Here’s a quick example of how to use the tool:
|
||||
|
||||
```python
|
||||
from lib.ai_marketing_tools.ai_backlinking import main_backlinking_workflow
|
||||
|
||||
# Email configurations
|
||||
smtp_config = {
|
||||
'server': 'smtp.gmail.com',
|
||||
'port': 587,
|
||||
'user': 'your_email@gmail.com',
|
||||
'password': 'your_password'
|
||||
}
|
||||
|
||||
imap_config = {
|
||||
'server': 'imap.gmail.com',
|
||||
'user': 'your_email@gmail.com',
|
||||
'password': 'your_password'
|
||||
}
|
||||
|
||||
# Proposal details
|
||||
user_proposal = {
|
||||
'user_name': 'Your Name',
|
||||
'user_email': 'your_email@gmail.com',
|
||||
'topic': 'Proposed guest post topic'
|
||||
}
|
||||
|
||||
# Keywords to search
|
||||
keywords = ['AI tools', 'SEO strategies', 'content marketing']
|
||||
|
||||
# Start the workflow
|
||||
main_backlinking_workflow(keywords, smtp_config, imap_config, user_proposal)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Core Functions
|
||||
|
||||
| Function | Purpose |
|
||||
|--------------------------------------------|-------------------------------------------------------------------------------------------|
|
||||
| `generate_search_queries(keyword)` | Create search queries to find guest post opportunities. |
|
||||
| `find_backlink_opportunities(keyword)` | Scrape websites for backlink opportunities. |
|
||||
| `compose_personalized_email()` | Draft outreach emails using AI insights and website data. |
|
||||
| `send_email()` | Send emails using SMTP configurations. |
|
||||
| `check_email_responses()` | Monitor inbox for replies using IMAP. |
|
||||
| `send_follow_up_email()` | Automate polite reminders to non-responsive contacts. |
|
||||
| `log_sent_email()` | Keep a record of all sent emails and responses. |
|
||||
| `main_backlinking_workflow()` | Execute the complete backlinking workflow for multiple keywords. |
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License. For more details, refer to the [LICENSE](LICENSE) file.
|
||||
|
||||
---
|
||||
423
ToBeMigrated/ai_marketing_tools/ai_backlinker/ai_backlinking.py
Normal file
423
ToBeMigrated/ai_marketing_tools/ai_backlinker/ai_backlinking.py
Normal file
@@ -0,0 +1,423 @@
|
||||
#Problem:
|
||||
#
|
||||
#Finding websites for guest posts is manual, tedious, and time-consuming. Communicating with webmasters, maintaining conversations, and keeping track of backlinking opportunities is difficult to scale. Content creators and marketers struggle with discovering new websites and consistently getting backlinks.
|
||||
#Solution:
|
||||
#
|
||||
#An AI-powered backlinking app that automates web research, scrapes websites, extracts contact information, and sends personalized outreach emails to webmasters. This would simplify the entire process, allowing marketers to scale their backlinking strategy with minimal manual intervention.
|
||||
#Core Workflow:
|
||||
#
|
||||
# User Input:
|
||||
# Keyword Search: The user inputs a keyword (e.g., "AI writers").
|
||||
# Search Queries: Your app will append various search strings to this keyword to find backlinking opportunities (e.g., "AI writers + 'Write for Us'").
|
||||
#
|
||||
# Web Research:
|
||||
#
|
||||
# Use search engines or web scraping to run multiple queries:
|
||||
# Keyword + "Guest Contributor"
|
||||
# Keyword + "Add Guest Post"
|
||||
# Keyword + "Write for Us", etc.
|
||||
#
|
||||
# Collect URLs of websites that have pages or posts related to guest post opportunities.
|
||||
#
|
||||
# Scrape Website Data:
|
||||
# Contact Information Extraction:
|
||||
# Scrape the website for contact details (email addresses, contact forms, etc.).
|
||||
# Use natural language processing (NLP) to understand the type of content on the website and who the contact person might be (webmaster, editor, or guest post manager).
|
||||
# Website Content Understanding:
|
||||
# Scrape a summary of each website's content (e.g., their blog topics, categories, and tone) to personalize the email based on the site's focus.
|
||||
#
|
||||
# Personalized Outreach:
|
||||
# AI Email Composition:
|
||||
# Compose personalized outreach emails based on:
|
||||
# The scraped data (website content, topic focus, etc.).
|
||||
# The user's input (what kind of guest post or content they want to contribute).
|
||||
# Example: "Hi [Webmaster Name], I noticed that your site [Site Name] features high-quality content about [Topic]. I would love to contribute a guest post on [Proposed Topic] in exchange for a backlink."
|
||||
#
|
||||
# Automated Email Sending:
|
||||
# Review Emails (Optional HITL):
|
||||
# Let users review and approve the personalized emails before they are sent, or allow full automation.
|
||||
# Send Emails:
|
||||
# Automate email dispatch through an integrated SMTP or API (e.g., Gmail API, SendGrid).
|
||||
# Keep track of which emails were sent, bounced, or received replies.
|
||||
#
|
||||
# Scaling the Search:
|
||||
# Repeat for Multiple Keywords:
|
||||
# Run the same scraping and outreach process for a list of relevant keywords, either automatically suggested or uploaded by the user.
|
||||
# Keep Track of Sent Emails:
|
||||
# Maintain a log of all sent emails, responses, and follow-up reminders to avoid repetition or forgotten leads.
|
||||
#
|
||||
# Tracking Responses and Follow-ups:
|
||||
# Automated Responses:
|
||||
# If a website replies positively, AI can respond with predefined follow-up emails (e.g., proposing topics, confirming submission deadlines).
|
||||
# Follow-up Reminders:
|
||||
# If there's no reply, the system can send polite follow-up reminders at pre-set intervals.
|
||||
#
|
||||
#Key Features:
|
||||
#
|
||||
# Automated Web Scraping:
|
||||
# Scrape websites for guest post opportunities using a predefined set of search queries based on user input.
|
||||
# Extract key information like email addresses, names, and submission guidelines.
|
||||
#
|
||||
# Personalized Email Writing:
|
||||
# Leverage AI to create personalized emails using the scraped website information.
|
||||
# Tailor each email to the tone, content style, and focus of the website.
|
||||
#
|
||||
# Email Sending Automation:
|
||||
# Integrate with email platforms (e.g., Gmail, SendGrid, or custom SMTP).
|
||||
# Send automated outreach emails with the ability for users to review first (HITL - Human-in-the-loop) or automate completely.
|
||||
#
|
||||
# Customizable Email Templates:
|
||||
# Allow users to customize or choose from a set of email templates for different types of outreach (e.g., guest post requests, follow-up emails, submission offers).
|
||||
#
|
||||
# Lead Tracking and Management:
|
||||
# Track all emails sent, monitor replies, and keep track of successful backlinks.
|
||||
# Log each lead's status (e.g., emailed, responded, no reply) to manage future interactions.
|
||||
#
|
||||
# Multiple Keywords/Queries:
|
||||
# Allow users to run the same process for a batch of keywords, automatically generating relevant search queries for each.
|
||||
#
|
||||
# AI-Driven Follow-Up:
|
||||
# Schedule follow-up emails if there is no response after a specified period.
|
||||
#
|
||||
# Reports and Analytics:
|
||||
# Provide users with reports on how many emails were sent, opened, replied to, and successful backlink placements.
|
||||
#
|
||||
#Advanced Features (for Scaling and Optimization):
|
||||
#
|
||||
# Domain Authority Filtering:
|
||||
# Use SEO APIs (e.g., Moz, Ahrefs) to filter websites based on their domain authority or backlink strength.
|
||||
# Prioritize high-authority websites to maximize the impact of backlinks.
|
||||
#
|
||||
# Spam Detection:
|
||||
# Use AI to detect and avoid spammy or low-quality websites that might harm the user's SEO.
|
||||
#
|
||||
# Contact Form Auto-Fill:
|
||||
# If the site only offers a contact form (without email), automatically fill and submit the form with AI-generated content.
|
||||
#
|
||||
# Dynamic Content Suggestions:
|
||||
# Suggest guest post topics based on the website's focus, using NLP to analyze the site's existing content.
|
||||
#
|
||||
# Bulk Email Support:
|
||||
# Allow users to bulk-send outreach emails while still personalizing each message for scalability.
|
||||
#
|
||||
# AI Copy Optimization:
|
||||
# Use copywriting AI to optimize email content, adjusting tone and CTA based on the target audience.
|
||||
#
|
||||
#Challenges and Considerations:
|
||||
#
|
||||
# Legal Compliance:
|
||||
# Ensure compliance with anti-spam laws (e.g., CAN-SPAM, GDPR) by including unsubscribe options or manual email approval.
|
||||
#
|
||||
# Scraping Limits:
|
||||
# Be mindful of scraping limits on certain websites and employ smart throttling or use API-based scraping for better reliability.
|
||||
#
|
||||
# Deliverability:
|
||||
# Ensure emails are delivered properly without landing in spam folders by integrating proper email authentication (SPF, DKIM) and using high-reputation SMTP servers.
|
||||
#
|
||||
# Maintaining Email Personalization:
|
||||
# Striking the balance between automating the email process and keeping each message personal enough to avoid being flagged as spam.
|
||||
#
|
||||
#Technology Stack:
|
||||
#
|
||||
# Web Scraping: BeautifulSoup, Scrapy, or Puppeteer for scraping guest post opportunities and contact information.
|
||||
# Email Automation: Integrate with Gmail API, SendGrid, or Mailgun for sending emails.
|
||||
# NLP for Personalization: GPT-based models for email generation and web content understanding.
|
||||
# Frontend: React or Vue for the user interface.
|
||||
# Backend: Python/Node.js with Flask or Express for the API and automation logic.
|
||||
# Database: MongoDB or PostgreSQL to track leads, emails, and responses.
|
||||
#
|
||||
#This solution will significantly streamline the backlinking process by automating the most tedious tasks, from finding sites to personalizing outreach, enabling marketers to focus on content creation and high-level strategies.
|
||||
|
||||
|
||||
import sys
|
||||
# from googlesearch import search # Temporarily disabled for future enhancement
|
||||
from loguru import logger
|
||||
from lib.ai_web_researcher.firecrawl_web_crawler import scrape_website
|
||||
from lib.gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
from lib.ai_web_researcher.firecrawl_web_crawler import scrape_url
|
||||
import smtplib
|
||||
from email.mime.multipart import MIMEMultipart
|
||||
from email.mime.text import MIMEText
|
||||
|
||||
# Configure logger
|
||||
logger.remove()
|
||||
logger.add(sys.stdout,
|
||||
colorize=True,
|
||||
format="<level>{level}</level>|<green>{file}:{line}:{function}</green>| {message}"
|
||||
)
|
||||
|
||||
def generate_search_queries(keyword):
|
||||
"""
|
||||
Generate a list of search queries for finding guest post opportunities.
|
||||
|
||||
Args:
|
||||
keyword (str): The keyword to base the search queries on.
|
||||
|
||||
Returns:
|
||||
list: A list of search queries.
|
||||
"""
|
||||
return [
|
||||
f"{keyword} + 'Guest Contributor'",
|
||||
f"{keyword} + 'Add Guest Post'",
|
||||
f"{keyword} + 'Guest Bloggers Wanted'",
|
||||
f"{keyword} + 'Write for Us'",
|
||||
f"{keyword} + 'Submit Guest Post'",
|
||||
f"{keyword} + 'Become a Guest Blogger'",
|
||||
f"{keyword} + 'guest post opportunities'",
|
||||
f"{keyword} + 'Submit article'",
|
||||
]
|
||||
|
||||
def find_backlink_opportunities(keyword):
|
||||
"""
|
||||
Find backlink opportunities by scraping websites based on search queries.
|
||||
|
||||
Args:
|
||||
keyword (str): The keyword to search for backlink opportunities.
|
||||
|
||||
Returns:
|
||||
list: A list of results from the scraped websites.
|
||||
"""
|
||||
search_queries = generate_search_queries(keyword)
|
||||
results = []
|
||||
|
||||
# Temporarily disabled Google search functionality
|
||||
# for query in search_queries:
|
||||
# urls = search_for_urls(query)
|
||||
# for url in urls:
|
||||
# website_data = scrape_website(url)
|
||||
# logger.info(f"Scraped Website content for {url}: {website_data}")
|
||||
# if website_data:
|
||||
# contact_info = extract_contact_info(website_data)
|
||||
# logger.info(f"Contact details found for {url}: {contact_info}")
|
||||
|
||||
# Placeholder return for now
|
||||
return []
|
||||
|
||||
def search_for_urls(query):
|
||||
"""
|
||||
Search for URLs using Google search.
|
||||
|
||||
Args:
|
||||
query (str): The search query.
|
||||
|
||||
Returns:
|
||||
list: List of URLs found.
|
||||
"""
|
||||
# Temporarily disabled Google search functionality
|
||||
# return list(search(query, num_results=10))
|
||||
return []
|
||||
|
||||
def compose_personalized_email(website_data, insights, user_proposal):
|
||||
"""
|
||||
Compose a personalized outreach email using AI LLM based on website data, insights, and user proposal.
|
||||
|
||||
Args:
|
||||
website_data (dict): The data of the website including metadata and contact info.
|
||||
insights (str): Insights generated by the LLM about the website.
|
||||
user_proposal (dict): The user's proposal for a guest post or content contribution.
|
||||
|
||||
Returns:
|
||||
str: A personalized email message.
|
||||
"""
|
||||
contact_name = website_data.get("contact_info", {}).get("name", "Webmaster")
|
||||
site_name = website_data.get("metadata", {}).get("title", "your site")
|
||||
proposed_topic = user_proposal.get("topic", "a guest post")
|
||||
user_name = user_proposal.get("user_name", "Your Name")
|
||||
user_email = user_proposal.get("user_email", "your_email@example.com")
|
||||
|
||||
# Refined prompt for email generation
|
||||
email_prompt = f"""
|
||||
You are an AI assistant tasked with composing a highly personalized outreach email for guest posting.
|
||||
|
||||
Contact Name: {contact_name}
|
||||
Website Name: {site_name}
|
||||
Proposed Topic: {proposed_topic}
|
||||
|
||||
User Details:
|
||||
Name: {user_name}
|
||||
Email: {user_email}
|
||||
|
||||
Website Insights: {insights}
|
||||
|
||||
Please compose a professional and engaging email that includes:
|
||||
1. A personalized introduction addressing the recipient.
|
||||
2. A mention of the website's content focus.
|
||||
3. A proposal for a guest post.
|
||||
4. A call to action to discuss the guest post opportunity.
|
||||
5. A polite closing with user contact details.
|
||||
"""
|
||||
|
||||
return llm_text_gen(email_prompt)
|
||||
|
||||
def send_email(smtp_server, smtp_port, smtp_user, smtp_password, to_email, subject, body):
|
||||
"""
|
||||
Send an email using an SMTP server.
|
||||
|
||||
Args:
|
||||
smtp_server (str): The SMTP server address.
|
||||
smtp_port (int): The SMTP server port.
|
||||
smtp_user (str): The SMTP server username.
|
||||
smtp_password (str): The SMTP server password.
|
||||
to_email (str): The recipient's email address.
|
||||
subject (str): The email subject.
|
||||
body (str): The email body.
|
||||
|
||||
Returns:
|
||||
bool: True if the email was sent successfully, False otherwise.
|
||||
"""
|
||||
try:
|
||||
msg = MIMEMultipart()
|
||||
msg['From'] = smtp_user
|
||||
msg['To'] = to_email
|
||||
msg['Subject'] = subject
|
||||
msg.attach(MIMEText(body, 'plain'))
|
||||
|
||||
server = smtplib.SMTP(smtp_server, smtp_port)
|
||||
server.starttls()
|
||||
server.login(smtp_user, smtp_password)
|
||||
server.send_message(msg)
|
||||
server.quit()
|
||||
|
||||
logger.info(f"Email sent successfully to {to_email}")
|
||||
return True
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to send email to {to_email}: {e}")
|
||||
return False
|
||||
|
||||
def extract_contact_info(website_data):
|
||||
"""
|
||||
Extract contact information from website data.
|
||||
|
||||
Args:
|
||||
website_data (dict): Scraped data from the website.
|
||||
|
||||
Returns:
|
||||
dict: Extracted contact information such as name, email, etc.
|
||||
"""
|
||||
# Placeholder for extracting contact information logic
|
||||
return {
|
||||
"name": website_data.get("contact", {}).get("name", "Webmaster"),
|
||||
"email": website_data.get("contact", {}).get("email", ""),
|
||||
}
|
||||
|
||||
def find_backlink_opportunities_for_keywords(keywords):
|
||||
"""
|
||||
Find backlink opportunities for multiple keywords.
|
||||
|
||||
Args:
|
||||
keywords (list): A list of keywords to search for backlink opportunities.
|
||||
|
||||
Returns:
|
||||
dict: A dictionary with keywords as keys and a list of results as values.
|
||||
"""
|
||||
all_results = {}
|
||||
for keyword in keywords:
|
||||
results = find_backlink_opportunities(keyword)
|
||||
all_results[keyword] = results
|
||||
return all_results
|
||||
|
||||
def log_sent_email(keyword, email_info):
|
||||
"""
|
||||
Log the information of a sent email.
|
||||
|
||||
Args:
|
||||
keyword (str): The keyword associated with the email.
|
||||
email_info (dict): Information about the sent email (e.g., recipient, subject, body).
|
||||
"""
|
||||
with open(f"{keyword}_sent_emails.log", "a") as log_file:
|
||||
log_file.write(f"{email_info}\n")
|
||||
|
||||
def check_email_responses(imap_server, imap_user, imap_password):
|
||||
"""
|
||||
Check email responses using an IMAP server.
|
||||
|
||||
Args:
|
||||
imap_server (str): The IMAP server address.
|
||||
imap_user (str): The IMAP server username.
|
||||
imap_password (str): The IMAP server password.
|
||||
|
||||
Returns:
|
||||
list: A list of email responses.
|
||||
"""
|
||||
responses = []
|
||||
try:
|
||||
mail = imaplib.IMAP4_SSL(imap_server)
|
||||
mail.login(imap_user, imap_password)
|
||||
mail.select('inbox')
|
||||
|
||||
status, data = mail.search(None, 'UNSEEN')
|
||||
mail_ids = data[0]
|
||||
id_list = mail_ids.split()
|
||||
|
||||
for mail_id in id_list:
|
||||
status, data = mail.fetch(mail_id, '(RFC822)')
|
||||
msg = email.message_from_bytes(data[0][1])
|
||||
if msg.is_multipart():
|
||||
for part in msg.walk():
|
||||
if part.get_content_type() == 'text/plain':
|
||||
responses.append(part.get_payload(decode=True).decode())
|
||||
else:
|
||||
responses.append(msg.get_payload(decode=True).decode())
|
||||
|
||||
mail.logout()
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to check email responses: {e}")
|
||||
|
||||
return responses
|
||||
|
||||
def send_follow_up_email(smtp_server, smtp_port, smtp_user, smtp_password, to_email, subject, body):
|
||||
"""
|
||||
Send a follow-up email using an SMTP server.
|
||||
|
||||
Args:
|
||||
smtp_server (str): The SMTP server address.
|
||||
smtp_port (int): The SMTP server port.
|
||||
smtp_user (str): The SMTP server username.
|
||||
smtp_password (str): The SMTP server password.
|
||||
to_email (str): The recipient's email address.
|
||||
subject (str): The email subject.
|
||||
body (str): The email body.
|
||||
|
||||
Returns:
|
||||
bool: True if the email was sent successfully, False otherwise.
|
||||
"""
|
||||
return send_email(smtp_server, smtp_port, smtp_user, smtp_password, to_email, subject, body)
|
||||
|
||||
def main_backlinking_workflow(keywords, smtp_config, imap_config, user_proposal):
|
||||
"""
|
||||
Main workflow for the AI-powered backlinking feature.
|
||||
|
||||
Args:
|
||||
keywords (list): A list of keywords to search for backlink opportunities.
|
||||
smtp_config (dict): SMTP configuration for sending emails.
|
||||
imap_config (dict): IMAP configuration for checking email responses.
|
||||
user_proposal (dict): The user's proposal for a guest post or content contribution.
|
||||
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
all_results = find_backlink_opportunities_for_keywords(keywords)
|
||||
|
||||
for keyword, results in all_results.items():
|
||||
for result in results:
|
||||
email_body = compose_personalized_email(result, result['insights'], user_proposal)
|
||||
email_sent = send_email(
|
||||
smtp_config['server'],
|
||||
smtp_config['port'],
|
||||
smtp_config['user'],
|
||||
smtp_config['password'],
|
||||
result['contact_info']['email'],
|
||||
f"Guest Post Proposal for {result['metadata']['title']}",
|
||||
email_body
|
||||
)
|
||||
if email_sent:
|
||||
log_sent_email(keyword, {
|
||||
"to": result['contact_info']['email'],
|
||||
"subject": f"Guest Post Proposal for {result['metadata']['title']}",
|
||||
"body": email_body
|
||||
})
|
||||
|
||||
responses = check_email_responses(imap_config['server'], imap_config['user'], imap_config['password'])
|
||||
for response in responses:
|
||||
# TBD : Process and possibly send follow-up emails based on responses
|
||||
pass
|
||||
@@ -0,0 +1,60 @@
|
||||
import streamlit as st
|
||||
import pandas as pd
|
||||
from st_aggrid import AgGrid, GridOptionsBuilder, GridUpdateMode
|
||||
from lib.ai_marketing_tools.ai_backlinker.ai_backlinking import find_backlink_opportunities, compose_personalized_email
|
||||
|
||||
|
||||
# Streamlit UI function
|
||||
def backlinking_ui():
|
||||
st.title("AI Backlinking Tool")
|
||||
|
||||
# Step 1: Get user inputs
|
||||
keyword = st.text_input("Enter a keyword", value="technology")
|
||||
|
||||
# Step 2: Generate backlink opportunities
|
||||
if st.button("Find Backlink Opportunities"):
|
||||
if keyword:
|
||||
backlink_opportunities = find_backlink_opportunities(keyword)
|
||||
|
||||
# Convert results to a DataFrame for display
|
||||
df = pd.DataFrame(backlink_opportunities)
|
||||
|
||||
# Create a selectable table using st-aggrid
|
||||
gb = GridOptionsBuilder.from_dataframe(df)
|
||||
gb.configure_selection('multiple', use_checkbox=True, groupSelectsChildren=True)
|
||||
gridOptions = gb.build()
|
||||
|
||||
grid_response = AgGrid(
|
||||
df,
|
||||
gridOptions=gridOptions,
|
||||
update_mode=GridUpdateMode.SELECTION_CHANGED,
|
||||
height=200,
|
||||
width='100%'
|
||||
)
|
||||
|
||||
selected_rows = grid_response['selected_rows']
|
||||
|
||||
if selected_rows:
|
||||
st.write("Selected Opportunities:")
|
||||
st.table(pd.DataFrame(selected_rows))
|
||||
|
||||
# Step 3: Option to generate personalized emails for selected opportunities
|
||||
if st.button("Generate Emails for Selected Opportunities"):
|
||||
user_proposal = {
|
||||
"user_name": st.text_input("Your Name", value="John Doe"),
|
||||
"user_email": st.text_input("Your Email", value="john@example.com")
|
||||
}
|
||||
|
||||
emails = []
|
||||
for selected in selected_rows:
|
||||
insights = f"Insights based on content from {selected['url']}."
|
||||
email = compose_personalized_email(selected, insights, user_proposal)
|
||||
emails.append(email)
|
||||
|
||||
st.subheader("Generated Emails:")
|
||||
for email in emails:
|
||||
st.write(email)
|
||||
st.markdown("---")
|
||||
|
||||
else:
|
||||
st.error("Please enter a keyword.")
|
||||
215
ToBeMigrated/ai_seo_tools/ENTERPRISE_FEATURES.md
Normal file
215
ToBeMigrated/ai_seo_tools/ENTERPRISE_FEATURES.md
Normal file
@@ -0,0 +1,215 @@
|
||||
# Alwrity Enterprise SEO Features
|
||||
|
||||
## 🚀 Overview
|
||||
|
||||
Alwrity's AI SEO Tools have been enhanced with enterprise-level features that provide comprehensive SEO management, advanced analytics, and AI-powered strategic insights. These enhancements transform Alwrity from a collection of individual tools into a unified enterprise SEO command center.
|
||||
|
||||
## 🏢 Enterprise SEO Suite
|
||||
|
||||
### Unified Command Center (`enterprise_seo_suite.py`)
|
||||
|
||||
The Enterprise SEO Suite serves as a central orchestrator for all SEO activities, providing:
|
||||
|
||||
#### Core Workflows
|
||||
- **Complete SEO Audit**: Comprehensive site analysis combining technical, content, and performance metrics
|
||||
- **Content Strategy Development**: AI-powered content planning with market intelligence
|
||||
- **Search Intelligence Analysis**: Deep GSC data analysis with actionable insights
|
||||
- **Performance Monitoring**: Continuous tracking and optimization recommendations
|
||||
|
||||
#### Key Features
|
||||
- **Intelligent Workflow Orchestration**: Automatically sequences and coordinates multiple SEO analyses
|
||||
- **AI-Powered Recommendations**: Uses advanced AI to generate strategic insights and action plans
|
||||
- **Enterprise Reporting**: Comprehensive reports suitable for executive and team consumption
|
||||
- **Scalable Architecture**: Designed to handle multiple sites and large datasets
|
||||
|
||||
### Enterprise-Level Capabilities
|
||||
- Multi-site management support
|
||||
- Role-based access controls (planned)
|
||||
- Team collaboration features (planned)
|
||||
- Advanced reporting and dashboards
|
||||
- API integration capabilities
|
||||
|
||||
## 📊 Google Search Console Intelligence
|
||||
|
||||
### Advanced GSC Integration (`google_search_console_integration.py`)
|
||||
|
||||
Transforms raw GSC data into strategic insights with:
|
||||
|
||||
#### Search Performance Analysis
|
||||
- **Comprehensive Metrics**: Clicks, impressions, CTR, and position tracking
|
||||
- **Trend Analysis**: Week-over-week and month-over-month performance trends
|
||||
- **Keyword Performance**: Deep analysis of keyword opportunities and optimization potential
|
||||
- **Page Performance**: Identification of top-performing and underperforming pages
|
||||
|
||||
#### Content Opportunities Engine
|
||||
- **CTR Optimization**: Identifies high-impression, low-CTR keywords for meta optimization
|
||||
- **Position Improvement**: Highlights keywords ranking 11-20 for content enhancement
|
||||
- **Content Gap Detection**: Discovers missing keyword opportunities
|
||||
- **Technical Issue Detection**: Identifies potential crawl and indexing problems
|
||||
|
||||
#### AI-Powered Insights
|
||||
- **Strategic Recommendations**: AI analysis of search data for actionable insights
|
||||
- **Immediate Opportunities**: Quick wins identified within 0-30 days
|
||||
- **Long-term Strategy**: 3-12 month strategic planning recommendations
|
||||
- **Competitive Analysis**: Market position assessment and improvement strategies
|
||||
|
||||
### Demo Mode & Real Integration
|
||||
- **Demo Mode**: Realistic sample data for testing and exploration
|
||||
- **GSC API Integration**: Ready for real Google Search Console API connection
|
||||
- **Credentials Management**: Secure handling of GSC API credentials
|
||||
- **Data Export**: Full analysis export in JSON and CSV formats
|
||||
|
||||
## 🧠 AI Content Strategy Generator
|
||||
|
||||
### Comprehensive Strategy Development (`ai_content_strategy.py`)
|
||||
|
||||
Creates complete content strategies using AI market intelligence:
|
||||
|
||||
#### Business Context Analysis
|
||||
- **Market Positioning**: AI analysis of competitive landscape and opportunities
|
||||
- **Content Gap Identification**: Discovers missing content themes in the industry
|
||||
- **Competitive Advantage Mapping**: Identifies unique positioning opportunities
|
||||
- **Audience Intelligence**: Deep insights into target audience needs and preferences
|
||||
|
||||
#### Content Pillar Development
|
||||
- **Strategic Pillars**: 4-6 content themes aligned with business goals
|
||||
- **Keyword Mapping**: Target keywords and semantic variations for each pillar
|
||||
- **Content Type Recommendations**: Optimal content formats for each pillar
|
||||
- **Success Metrics**: KPIs and measurement frameworks for each pillar
|
||||
|
||||
#### Content Calendar Planning
|
||||
- **Automated Scheduling**: AI-generated content calendar with optimal timing
|
||||
- **Resource Planning**: Time estimates and resource allocation
|
||||
- **Priority Scoring**: Content prioritization based on impact and effort
|
||||
- **Distribution Mapping**: Multi-channel content distribution strategy
|
||||
|
||||
#### Topic Cluster Strategy
|
||||
- **SEO-Optimized Clusters**: Topic clusters designed for search dominance
|
||||
- **Pillar Page Strategy**: Hub-and-spoke content architecture
|
||||
- **Internal Linking Plans**: Strategic linking for SEO authority building
|
||||
- **Content Relationship Mapping**: How content pieces support each other
|
||||
|
||||
### Implementation Support
|
||||
- **Phase-Based Roadmap**: 3-phase implementation plan with milestones
|
||||
- **KPI Framework**: Comprehensive measurement and tracking system
|
||||
- **Resource Requirements**: Budget and team resource planning
|
||||
- **Risk Mitigation**: Strategies to avoid common content pitfalls
|
||||
|
||||
## 🔧 Enhanced Technical Capabilities
|
||||
|
||||
### Advanced SEO Workflows
|
||||
- **Multi-Tool Orchestration**: Seamless integration between all SEO tools
|
||||
- **Data Correlation**: Cross-referencing insights from multiple analyses
|
||||
- **Automated Recommendations**: AI-generated action plans with priority scoring
|
||||
- **Performance Tracking**: Before/after analysis and improvement measurement
|
||||
|
||||
### Enterprise Data Management
|
||||
- **Large Dataset Handling**: Optimized for enterprise-scale websites
|
||||
- **Historical Data Tracking**: Long-term trend analysis and comparison
|
||||
- **Data Export & Integration**: API-ready for integration with other tools
|
||||
- **Security & Privacy**: Enterprise-grade data handling and security
|
||||
|
||||
## 📈 Advanced Analytics & Reporting
|
||||
|
||||
### Performance Dashboards
|
||||
- **Executive Summaries**: High-level insights for leadership teams
|
||||
- **Detailed Analytics**: In-depth analysis for SEO practitioners
|
||||
- **Trend Visualization**: Interactive charts and performance tracking
|
||||
- **Competitive Benchmarking**: Market position and competitor analysis
|
||||
|
||||
### ROI Measurement
|
||||
- **Impact Quantification**: Measuring SEO improvements in business terms
|
||||
- **Cost-Benefit Analysis**: ROI calculation for SEO investments
|
||||
- **Performance Attribution**: Connecting SEO efforts to business outcomes
|
||||
- **Forecasting Models**: Predictive analytics for future performance
|
||||
|
||||
## 🎯 Strategic Planning Features
|
||||
|
||||
### Market Intelligence
|
||||
- **Industry Analysis**: AI-powered market research and trend identification
|
||||
- **Competitive Intelligence**: Deep analysis of competitor content strategies
|
||||
- **Opportunity Mapping**: Identification of untapped market opportunities
|
||||
- **Risk Assessment**: Potential challenges and mitigation strategies
|
||||
|
||||
### Long-term Planning
|
||||
- **Strategic Roadmaps**: 6-12 month SEO strategy development
|
||||
- **Resource Planning**: Team and budget allocation recommendations
|
||||
- **Technology Roadmap**: Tool and platform evolution planning
|
||||
- **Scalability Planning**: Growth-oriented SEO architecture
|
||||
|
||||
## 🚀 Implementation Benefits
|
||||
|
||||
### For Enterprise Teams
|
||||
- **Unified Workflow**: Single platform for all SEO activities
|
||||
- **Team Collaboration**: Shared insights and coordinated strategies
|
||||
- **Scalable Operations**: Handle multiple sites and large datasets
|
||||
- **Executive Reporting**: Clear ROI and performance communication
|
||||
|
||||
### For SEO Professionals
|
||||
- **Advanced Insights**: AI-powered analysis beyond basic tools
|
||||
- **Time Efficiency**: Automated workflows and intelligent recommendations
|
||||
- **Strategic Focus**: Less time on analysis, more on strategy execution
|
||||
- **Competitive Advantage**: Access to enterprise-level intelligence
|
||||
|
||||
### For Business Leaders
|
||||
- **Clear ROI**: Quantified business impact of SEO investments
|
||||
- **Strategic Alignment**: SEO strategy aligned with business objectives
|
||||
- **Risk Management**: Proactive identification and mitigation of SEO risks
|
||||
- **Competitive Intelligence**: Market position and improvement opportunities
|
||||
|
||||
## 🔄 Integration Architecture
|
||||
|
||||
### Modular Design
|
||||
- **Tool Independence**: Each tool can function independently
|
||||
- **Workflow Integration**: Tools work together in intelligent sequences
|
||||
- **API-First**: Ready for integration with external systems
|
||||
- **Extensible Framework**: Easy to add new tools and capabilities
|
||||
|
||||
### Data Flow
|
||||
- **Centralized Data Management**: Unified data storage and processing
|
||||
- **Cross-Tool Insights**: Data sharing between different analyses
|
||||
- **Historical Tracking**: Long-term data retention and trend analysis
|
||||
- **Real-time Updates**: Live data integration and analysis
|
||||
|
||||
## 📋 Getting Started
|
||||
|
||||
### For New Users
|
||||
1. Start with the **Enterprise SEO Suite** for comprehensive analysis
|
||||
2. Use **Demo Mode** to explore features with sample data
|
||||
3. Configure **Google Search Console** integration for real data
|
||||
4. Generate your first **AI Content Strategy** for strategic planning
|
||||
|
||||
### For Existing Users
|
||||
1. Explore the new **Enterprise tab** in the SEO dashboard
|
||||
2. Connect your **Google Search Console** for enhanced insights
|
||||
3. Generate comprehensive **content strategies** using AI
|
||||
4. Utilize **workflow orchestration** for multi-tool analysis
|
||||
|
||||
### Implementation Timeline
|
||||
- **Week 1**: Tool exploration and data connection
|
||||
- **Week 2-3**: Initial audits and strategy development
|
||||
- **Month 1**: Content implementation and optimization
|
||||
- **Month 2-3**: Performance tracking and strategy refinement
|
||||
|
||||
## 🔮 Future Enhancements
|
||||
|
||||
### Planned Features
|
||||
- **Multi-site Management**: Centralized management of multiple websites
|
||||
- **Team Collaboration**: Role-based access and collaborative workflows
|
||||
- **Advanced Integrations**: CRM, Analytics, and Marketing Platform connections
|
||||
- **Machine Learning Models**: Custom AI models for specific industries
|
||||
- **Predictive Analytics**: Forecasting SEO performance and opportunities
|
||||
|
||||
### Roadmap
|
||||
- **Q1**: Multi-site support and team collaboration features
|
||||
- **Q2**: Advanced integrations and custom AI models
|
||||
- **Q3**: Predictive analytics and forecasting capabilities
|
||||
- **Q4**: Industry-specific optimization and enterprise scalability
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Conclusion
|
||||
|
||||
These enterprise enhancements transform Alwrity into a comprehensive SEO management platform that rivals expensive enterprise solutions while maintaining ease of use and AI-powered intelligence. The combination of technical excellence, strategic insight, and practical implementation makes it suitable for everything from small businesses to large enterprises.
|
||||
|
||||
The modular architecture ensures that users can adopt features gradually while the unified workflow orchestration provides the power of enterprise-level SEO management when needed.
|
||||
251
ToBeMigrated/ai_seo_tools/README.md
Normal file
251
ToBeMigrated/ai_seo_tools/README.md
Normal file
@@ -0,0 +1,251 @@
|
||||
# 🚀 Alwrity's Enterprise AI SEO Tools Suite
|
||||
|
||||
**Transform your SEO strategy with AI-powered enterprise-level tools and intelligent workflows**
|
||||
|
||||
Alwrity's AI SEO Tools have evolved into a comprehensive enterprise suite that combines individual optimization tools with intelligent workflow orchestration, providing everything from basic SEO tasks to advanced strategic analysis and competitive intelligence.
|
||||
|
||||
---
|
||||
|
||||
## 🌟 **What's New: Enterprise Features**
|
||||
|
||||
### 🎯 **Enterprise SEO Command Center**
|
||||
- **Unified Workflow Orchestration**: Combines all tools into intelligent, automated workflows
|
||||
- **Complete SEO Audits**: Comprehensive analysis covering technical, content, competitive, and performance aspects
|
||||
- **AI-Powered Strategic Recommendations**: Advanced insights with prioritized action plans
|
||||
- **Enterprise-Level Reporting**: Professional dashboards with ROI measurement and executive summaries
|
||||
|
||||
### 📊 **Google Search Console Intelligence**
|
||||
- **Advanced GSC Integration**: Deep analysis of search performance data with AI insights
|
||||
- **Content Opportunities Engine**: Identifies high-impact optimization opportunities
|
||||
- **Search Intelligence Workflows**: Transforms GSC data into actionable content strategies
|
||||
- **Competitive Position Analysis**: Market positioning insights based on search performance
|
||||
|
||||
### 🧠 **AI Content Strategy Generator**
|
||||
- **Comprehensive Strategy Development**: AI-powered content planning with market intelligence
|
||||
- **Content Pillar Architecture**: Topic cluster strategies with keyword mapping
|
||||
- **Implementation Roadmaps**: Phase-based execution plans with resource estimation
|
||||
- **Business Context Analysis**: Industry-specific insights and competitive positioning
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ **Complete Tool Suite**
|
||||
|
||||
### **🏢 Enterprise Suite**
|
||||
| Tool | Description | Key Features |
|
||||
|------|-------------|--------------|
|
||||
| **Enterprise SEO Command Center** | Unified workflow orchestration | Complete audits, AI recommendations, strategic planning |
|
||||
| **Google Search Console Intelligence** | Advanced GSC data analysis | Content opportunities, search intelligence, competitive analysis |
|
||||
| **AI Content Strategy Generator** | Comprehensive content planning | Market intelligence, topic clusters, implementation roadmaps |
|
||||
|
||||
### **📊 Analytics & Intelligence**
|
||||
| Tool | Description | Key Features |
|
||||
|------|-------------|--------------|
|
||||
| **Enhanced Content Gap Analysis** | Advanced competitive content analysis | Advertools integration, AI insights, opportunity identification |
|
||||
| **Technical SEO Crawler** | Site-wide technical analysis | Performance metrics, crawl analysis, AI recommendations |
|
||||
| **Competitive Intelligence** | Market positioning analysis | Competitor benchmarking, strategic insights, market opportunities |
|
||||
|
||||
### **🔧 Technical SEO**
|
||||
| Tool | Description | Key Features |
|
||||
|------|-------------|--------------|
|
||||
| **On-Page SEO Analyzer** | Comprehensive page optimization | Meta analysis, content optimization, readability scoring |
|
||||
| **URL SEO Checker** | Individual URL analysis | Technical factors, optimization recommendations |
|
||||
| **Google PageSpeed Insights** | Performance analysis | Core Web Vitals, speed optimization, mobile performance |
|
||||
|
||||
### **📝 Content & Strategy**
|
||||
| Tool | Description | Key Features |
|
||||
|------|-------------|--------------|
|
||||
| **Content Calendar Planner** | Strategic content planning | Editorial calendars, topic scheduling, resource planning |
|
||||
| **Topic Cluster Generator** | Content architecture planning | Pillar pages, cluster content, internal linking strategies |
|
||||
| **Content Performance Analyzer** | Content effectiveness analysis | Performance metrics, optimization recommendations |
|
||||
|
||||
### **⚡ Quick Optimization Tools**
|
||||
| Tool | Description | Key Features |
|
||||
|------|-------------|--------------|
|
||||
| **Meta Description Generator** | SEO-friendly meta descriptions | Keyword optimization, CTR enhancement, length optimization |
|
||||
| **Content Title Generator** | Attention-grabbing titles | Keyword integration, engagement optimization, SERP visibility |
|
||||
| **OpenGraph Generator** | Social media optimization | Facebook/LinkedIn optimization, visual appeal, click enhancement |
|
||||
| **Image Alt Text Generator** | AI-powered alt text creation | SEO optimization, accessibility compliance, image discoverability |
|
||||
| **Schema Markup Generator** | Structured data creation | Rich snippets, search enhancement, content understanding |
|
||||
| **Twitter Tags Generator** | Twitter optimization | Engagement enhancement, visibility improvement, social sharing |
|
||||
|
||||
---
|
||||
|
||||
## 🎯 **Enterprise Workflows**
|
||||
|
||||
### **🔍 Complete SEO Audit Workflow**
|
||||
1. **Technical SEO Analysis** - Site-wide technical health assessment
|
||||
2. **Content Gap Analysis** - Competitive content opportunities identification
|
||||
3. **On-Page Optimization** - Page-level SEO factor analysis
|
||||
4. **Performance Analysis** - Speed, mobile, and Core Web Vitals assessment
|
||||
5. **AI Strategic Recommendations** - Prioritized action plan with impact estimates
|
||||
|
||||
### **📊 Search Intelligence Workflow**
|
||||
1. **GSC Data Analysis** - Comprehensive search performance review
|
||||
2. **Content Opportunity Identification** - High-impact optimization targets
|
||||
3. **Competitive Position Assessment** - Market positioning analysis
|
||||
4. **Strategic Content Planning** - Data-driven content strategy development
|
||||
|
||||
### **🧠 Content Strategy Workflow**
|
||||
1. **Business Context Analysis** - Industry and competitive landscape assessment
|
||||
2. **Content Pillar Development** - Topic cluster architecture creation
|
||||
3. **Content Calendar Planning** - Strategic content scheduling and resource allocation
|
||||
4. **Implementation Roadmap** - Phase-based execution with timeline and priorities
|
||||
|
||||
---
|
||||
|
||||
## 🚀 **Getting Started**
|
||||
|
||||
### **For New Users**
|
||||
1. **Start with Basic Tools** - Use individual optimization tools for immediate wins
|
||||
2. **Explore Analytics** - Try content gap analysis and technical crawling
|
||||
3. **Upgrade to Enterprise** - Access unified workflows and AI-powered insights
|
||||
|
||||
### **For Existing Users**
|
||||
1. **Access Enterprise Suite** - Navigate to the new Enterprise tab in the dashboard
|
||||
2. **Run Complete Audit** - Execute comprehensive SEO analysis workflows
|
||||
3. **Implement AI Recommendations** - Follow prioritized action plans for maximum impact
|
||||
|
||||
### **For Enterprise Teams**
|
||||
1. **Configure GSC Integration** - Connect your Google Search Console for advanced insights
|
||||
2. **Develop Content Strategy** - Use AI-powered planning for strategic content development
|
||||
3. **Monitor and Optimize** - Leverage continuous monitoring and optimization workflows
|
||||
|
||||
---
|
||||
|
||||
## 📈 **Business Impact**
|
||||
|
||||
### **Immediate Benefits (0-30 days)**
|
||||
- ✅ **Quick Wins Identification** - AI-powered immediate optimization opportunities
|
||||
- ✅ **Technical Issue Resolution** - Critical SEO problems with prioritized fixes
|
||||
- ✅ **Content Optimization** - Existing page improvements for better performance
|
||||
- ✅ **Performance Enhancement** - Speed and mobile optimization recommendations
|
||||
|
||||
### **Strategic Growth (1-6 months)**
|
||||
- 📈 **Content Strategy Execution** - Systematic content development with topic clusters
|
||||
- 📈 **Competitive Positioning** - Market advantage through strategic content gaps
|
||||
- 📈 **Authority Building** - Thought leadership content and link-worthy assets
|
||||
- 📈 **Search Visibility** - Improved rankings through comprehensive optimization
|
||||
|
||||
### **Long-term Success (6-12 months)**
|
||||
- 🏆 **Market Leadership** - Dominant search presence in target markets
|
||||
- 🏆 **Organic Growth** - Sustainable traffic and conversion improvements
|
||||
- 🏆 **Competitive Advantage** - Advanced SEO capabilities beyond competitors
|
||||
- 🏆 **ROI Optimization** - Measurable business impact and revenue growth
|
||||
|
||||
---
|
||||
|
||||
## 🔧 **Technical Architecture**
|
||||
|
||||
### **Modular Design**
|
||||
- **Independent Tools** - Each tool functions standalone for specific tasks
|
||||
- **Workflow Integration** - Tools combine seamlessly in enterprise workflows
|
||||
- **API-Ready Architecture** - External system integration capabilities
|
||||
- **Scalable Infrastructure** - Handles enterprise-level data and analysis
|
||||
|
||||
### **AI Integration**
|
||||
- **Advanced Language Models** - GPT-powered analysis and recommendations
|
||||
- **Contextual Intelligence** - Business-specific insights and strategies
|
||||
- **Continuous Learning** - Improving recommendations based on performance data
|
||||
- **Multi-Modal Analysis** - Text, data, and performance metric integration
|
||||
|
||||
### **Data Management**
|
||||
- **Secure Processing** - Enterprise-grade data security and privacy
|
||||
- **Real-time Analysis** - Live data processing and immediate insights
|
||||
- **Historical Tracking** - Performance monitoring and trend analysis
|
||||
- **Export Capabilities** - Comprehensive reporting and data portability
|
||||
|
||||
---
|
||||
|
||||
## 🎯 **Use Cases by Role**
|
||||
|
||||
### **SEO Professionals**
|
||||
- **Comprehensive Audits** - Complete site analysis with actionable recommendations
|
||||
- **Competitive Intelligence** - Market positioning and opportunity identification
|
||||
- **Strategic Planning** - Long-term SEO roadmaps with business alignment
|
||||
- **Performance Monitoring** - Continuous optimization and improvement tracking
|
||||
|
||||
### **Content Marketers**
|
||||
- **Content Strategy Development** - AI-powered planning with market intelligence
|
||||
- **Topic Research** - Data-driven content ideas and keyword opportunities
|
||||
- **Performance Analysis** - Content effectiveness measurement and optimization
|
||||
- **Editorial Planning** - Strategic content calendars with resource allocation
|
||||
|
||||
### **Business Leaders**
|
||||
- **ROI Measurement** - Clear business impact and performance metrics
|
||||
- **Strategic Insights** - Market opportunities and competitive positioning
|
||||
- **Resource Planning** - Efficient allocation of SEO and content resources
|
||||
- **Executive Reporting** - High-level dashboards and strategic recommendations
|
||||
|
||||
### **Agencies & Consultants**
|
||||
- **Client Audits** - Professional-grade analysis and reporting
|
||||
- **Scalable Solutions** - Multi-client management and optimization
|
||||
- **Competitive Analysis** - Market intelligence and positioning strategies
|
||||
- **Value Demonstration** - Clear ROI and performance improvement tracking
|
||||
|
||||
---
|
||||
|
||||
## 🔮 **Future Roadmap**
|
||||
|
||||
### **Planned Enhancements**
|
||||
- 🔄 **Real-time Monitoring** - Continuous SEO health tracking and alerts
|
||||
- 🤖 **Advanced AI Models** - Enhanced analysis and prediction capabilities
|
||||
- 🌐 **Multi-language Support** - Global SEO optimization and analysis
|
||||
- 📱 **Mobile App** - On-the-go SEO monitoring and management
|
||||
- 🔗 **Enhanced Integrations** - More third-party tool connections and APIs
|
||||
|
||||
### **Advanced Features in Development**
|
||||
- **Predictive SEO Analytics** - Forecast performance and opportunity identification
|
||||
- **Automated Optimization** - AI-driven automatic SEO improvements
|
||||
- **Voice Search Optimization** - Emerging search behavior analysis
|
||||
- **Local SEO Suite** - Location-based optimization and management
|
||||
- **E-commerce SEO** - Specialized tools for online retail optimization
|
||||
|
||||
---
|
||||
|
||||
## 📚 **Resources & Support**
|
||||
|
||||
### **Documentation**
|
||||
- 📖 **Enterprise Features Guide** - Comprehensive feature documentation
|
||||
- 🎥 **Video Tutorials** - Step-by-step workflow demonstrations
|
||||
- 📋 **Best Practices** - Industry-standard SEO optimization guidelines
|
||||
- 🔧 **API Documentation** - Integration guides and technical specifications
|
||||
|
||||
### **Support Channels**
|
||||
- 💬 **Community Forum** - User discussions and knowledge sharing
|
||||
- 📧 **Email Support** - Direct assistance for technical issues
|
||||
- 🎓 **Training Programs** - Advanced SEO strategy and tool mastery
|
||||
- 🤝 **Consulting Services** - Strategic SEO planning and implementation
|
||||
|
||||
---
|
||||
|
||||
## 🏁 **Action Plan: Maximize Your SEO Success**
|
||||
|
||||
### **Phase 1: Foundation (Week 1-2)**
|
||||
1. **Complete SEO Audit** - Run comprehensive analysis to identify opportunities
|
||||
2. **Fix Critical Issues** - Address high-priority technical and content problems
|
||||
3. **Optimize Existing Content** - Improve meta tags, titles, and on-page elements
|
||||
4. **Set Up Monitoring** - Configure GSC integration and performance tracking
|
||||
|
||||
### **Phase 2: Strategic Development (Week 3-8)**
|
||||
1. **Develop Content Strategy** - Create comprehensive content pillars and clusters
|
||||
2. **Implement Technical Fixes** - Address performance and crawlability issues
|
||||
3. **Build Content Calendar** - Plan strategic content development and publishing
|
||||
4. **Monitor Competitive Position** - Track market positioning and opportunities
|
||||
|
||||
### **Phase 3: Growth & Optimization (Week 9-24)**
|
||||
1. **Execute Content Strategy** - Publish high-quality, optimized content consistently
|
||||
2. **Build Authority** - Develop thought leadership and link-worthy content
|
||||
3. **Expand Market Presence** - Target new keywords and market segments
|
||||
4. **Measure and Refine** - Continuously optimize based on performance data
|
||||
|
||||
### **Phase 4: Market Leadership (Month 6+)**
|
||||
1. **Dominate Target Markets** - Achieve top rankings for primary keywords
|
||||
2. **Scale Successful Strategies** - Expand winning approaches to new areas
|
||||
3. **Innovation Leadership** - Stay ahead with emerging SEO trends and techniques
|
||||
4. **Sustainable Growth** - Maintain and improve market position continuously
|
||||
|
||||
---
|
||||
|
||||
**Ready to transform your SEO strategy?** Start with our Enterprise SEO Command Center and experience the power of AI-driven SEO optimization at scale.
|
||||
|
||||
🚀 **[Launch Enterprise SEO Suite](./enterprise_seo_suite.py)** | 📊 **[Explore GSC Intelligence](./google_search_console_integration.py)** | 🧠 **[Generate Content Strategy](./ai_content_strategy.py)**
|
||||
68
ToBeMigrated/ai_seo_tools/TBD
Normal file
68
ToBeMigrated/ai_seo_tools/TBD
Normal file
@@ -0,0 +1,68 @@
|
||||
https://github.com/greghub/website-launch-checklist
|
||||
https://github.com/marcobiedermann/search-engine-optimization
|
||||
https://developers.google.com/speed/docs/insights/v5/get-started
|
||||
https://developers.google.com/search/apis/indexing-api/v3/prereqs
|
||||
https://developer.chrome.com/docs/lighthouse/overview/#cli
|
||||
|
||||
APIs
|
||||
https://docs.ayrshare.com/
|
||||
https://github.com/dataforseo/PythonClient
|
||||
https://mysiteauditor.com/api
|
||||
|
||||
https://github.com/searchsolved/search-solved-public-seo/blob/main/keyword-research/low-competition-keyword-finder-serp-api/low_competition_finder_serp_api.py
|
||||
|
||||
### Structured Data
|
||||
|
||||
- [Facebook Debugger](https://developers.facebook.com/tools/debug) - Enter the URL you want to scrape to see how the page's markup appears to Facebook.
|
||||
- [Pinterest](https://developers.pinterest.com/rich_pins/validator/) - Validate your Rich Pins and apply to get them on Pinterest.
|
||||
- [Structured Data Testing Tool](https://developers.google.com/structured-data/testing-tool/) - Paste in your rich snippets or url to test it.
|
||||
- [Twitter card validator](https://cards-dev.twitter.com/validator) - Enter the URL of the page with the meta tags to validate.
|
||||
|
||||
https://github.com/sethblack/python-seo-analyzer
|
||||
|
||||
https://www.holisticseo.digital/python-seo/analyse-compare-robots-txt/
|
||||
|
||||
https://github.com/Nv7-GitHub/googlesearch
|
||||
https://www.semrush.com/blog/python-for-google-search/
|
||||
|
||||
https://www.kaggle.com/code/eliasdabbas/botpresso-crawl-audit-analysis
|
||||
https://www.kaggle.com/code/eliasdabbas/nike-xml-sitemap-audit-analysis
|
||||
https://www.kaggle.com/code/eliasdabbas/twitter-user-account-analysis-python-sejournal
|
||||
https://www.kaggle.com/code/eliasdabbas/seo-crawl-analysis-template
|
||||
https://www.kaggle.com/code/eliasdabbas/advertools-seo-crawl-analysis-template
|
||||
|
||||
https://www.semrush.com/blog/content-analysis-xml-sitemaps-python/
|
||||
|
||||
|
||||
different configurations that influence your technical SEO and how to optimize them to maximize your organic search visibility.
|
||||
|
||||
ALwrity’ll cover:
|
||||
|
||||
HTTP status
|
||||
|
||||
URL structure
|
||||
|
||||
Website links
|
||||
|
||||
XML sitemaps
|
||||
|
||||
Robots.txt
|
||||
|
||||
Meta robots tag
|
||||
|
||||
Canonicalization
|
||||
|
||||
JavaScript usage
|
||||
|
||||
HTTPS usage
|
||||
|
||||
Mobile friendliness
|
||||
|
||||
Structured data
|
||||
|
||||
Core Web Vitals
|
||||
|
||||
Hreflang annotations
|
||||
|
||||
|
||||
|
||||
954
ToBeMigrated/ai_seo_tools/ai_content_strategy.py
Normal file
954
ToBeMigrated/ai_seo_tools/ai_content_strategy.py
Normal file
@@ -0,0 +1,954 @@
|
||||
"""
|
||||
AI-Powered Content Strategy Generator
|
||||
|
||||
Creates comprehensive content strategies using AI analysis of SEO data,
|
||||
competitor insights, and market trends for enterprise content planning.
|
||||
"""
|
||||
|
||||
import streamlit as st
|
||||
import pandas as pd
|
||||
import numpy as np
|
||||
from typing import Dict, Any, List, Optional, Tuple
|
||||
from datetime import datetime, timedelta
|
||||
import json
|
||||
from loguru import logger
|
||||
import plotly.express as px
|
||||
import plotly.graph_objects as go
|
||||
|
||||
# Import AI modules
|
||||
from ..gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
|
||||
|
||||
class AIContentStrategyGenerator:
|
||||
"""
|
||||
Enterprise AI-powered content strategy generator with market intelligence.
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
"""Initialize the content strategy generator."""
|
||||
logger.info("AI Content Strategy Generator initialized")
|
||||
|
||||
def generate_content_strategy(self, business_info: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""
|
||||
Generate comprehensive AI-powered content strategy.
|
||||
|
||||
Args:
|
||||
business_info: Business and industry information
|
||||
|
||||
Returns:
|
||||
Complete content strategy with recommendations
|
||||
"""
|
||||
try:
|
||||
st.info("🧠 Generating AI-powered content strategy...")
|
||||
|
||||
# Analyze business context
|
||||
business_analysis = self._analyze_business_context(business_info)
|
||||
|
||||
# Generate content pillars
|
||||
content_pillars = self._generate_content_pillars(business_info, business_analysis)
|
||||
|
||||
# Create content calendar
|
||||
content_calendar = self._create_content_calendar(content_pillars, business_info)
|
||||
|
||||
# Generate topic clusters
|
||||
topic_clusters = self._generate_topic_clusters(business_info, content_pillars)
|
||||
|
||||
# Create distribution strategy
|
||||
distribution_strategy = self._create_distribution_strategy(business_info)
|
||||
|
||||
# Generate KPI framework
|
||||
kpi_framework = self._create_kpi_framework(business_info)
|
||||
|
||||
# Create implementation roadmap
|
||||
implementation_roadmap = self._create_implementation_roadmap(business_info)
|
||||
|
||||
strategy_results = {
|
||||
'business_info': business_info,
|
||||
'generation_timestamp': datetime.utcnow().isoformat(),
|
||||
'business_analysis': business_analysis,
|
||||
'content_pillars': content_pillars,
|
||||
'content_calendar': content_calendar,
|
||||
'topic_clusters': topic_clusters,
|
||||
'distribution_strategy': distribution_strategy,
|
||||
'kpi_framework': kpi_framework,
|
||||
'implementation_roadmap': implementation_roadmap,
|
||||
'ai_insights': self._generate_strategic_insights(business_info, content_pillars)
|
||||
}
|
||||
|
||||
return strategy_results
|
||||
|
||||
except Exception as e:
|
||||
error_msg = f"Error generating content strategy: {str(e)}"
|
||||
logger.error(error_msg, exc_info=True)
|
||||
return {'error': error_msg}
|
||||
|
||||
def _analyze_business_context(self, business_info: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Analyze business context for strategic insights."""
|
||||
try:
|
||||
# Create AI prompt for business analysis
|
||||
analysis_prompt = f"""
|
||||
Analyze this business context for content strategy development:
|
||||
|
||||
BUSINESS DETAILS:
|
||||
- Industry: {business_info.get('industry', 'Not specified')}
|
||||
- Target Audience: {business_info.get('target_audience', 'Not specified')}
|
||||
- Business Goals: {business_info.get('business_goals', 'Not specified')}
|
||||
- Content Objectives: {business_info.get('content_objectives', 'Not specified')}
|
||||
- Budget: {business_info.get('budget', 'Not specified')}
|
||||
- Timeline: {business_info.get('timeline', 'Not specified')}
|
||||
|
||||
Provide analysis on:
|
||||
1. Market positioning opportunities
|
||||
2. Content gaps in the industry
|
||||
3. Competitive advantages to leverage
|
||||
4. Audience pain points and interests
|
||||
5. Seasonal content opportunities
|
||||
6. Content format preferences for this audience
|
||||
7. Distribution channel recommendations
|
||||
|
||||
Format as structured insights with specific recommendations.
|
||||
"""
|
||||
|
||||
ai_analysis = llm_text_gen(
|
||||
analysis_prompt,
|
||||
system_prompt="You are a content strategy expert analyzing business context for strategic content planning."
|
||||
)
|
||||
|
||||
return {
|
||||
'full_analysis': ai_analysis,
|
||||
'market_position': self._extract_market_position(ai_analysis),
|
||||
'content_gaps': self._extract_content_gaps(ai_analysis),
|
||||
'competitive_advantages': self._extract_competitive_advantages(ai_analysis),
|
||||
'audience_insights': self._extract_audience_insights(ai_analysis)
|
||||
}
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Business analysis error: {str(e)}")
|
||||
return {'error': str(e)}
|
||||
|
||||
def _generate_content_pillars(self, business_info: Dict[str, Any], business_analysis: Dict[str, Any]) -> List[Dict[str, Any]]:
|
||||
"""Generate strategic content pillars."""
|
||||
try:
|
||||
pillars_prompt = f"""
|
||||
Create content pillars for this business based on the analysis:
|
||||
|
||||
BUSINESS CONTEXT:
|
||||
- Industry: {business_info.get('industry', 'Not specified')}
|
||||
- Target Audience: {business_info.get('target_audience', 'Not specified')}
|
||||
- Business Goals: {business_info.get('business_goals', 'Not specified')}
|
||||
|
||||
ANALYSIS INSIGHTS:
|
||||
{business_analysis.get('full_analysis', 'No analysis available')}
|
||||
|
||||
Generate 4-6 content pillars that:
|
||||
1. Align with business goals
|
||||
2. Address audience needs
|
||||
3. Differentiate from competitors
|
||||
4. Support SEO objectives
|
||||
5. Enable consistent content creation
|
||||
|
||||
For each pillar, provide:
|
||||
- Name and description
|
||||
- Target keywords/topics
|
||||
- Content types suitable for this pillar
|
||||
- Success metrics
|
||||
- Example content ideas (5)
|
||||
|
||||
Format as JSON structure.
|
||||
"""
|
||||
|
||||
ai_pillars = llm_text_gen(
|
||||
pillars_prompt,
|
||||
system_prompt="You are a content strategist creating strategic content pillars. Return structured data."
|
||||
)
|
||||
|
||||
# Parse and structure the pillars
|
||||
pillars = [
|
||||
{
|
||||
'id': 1,
|
||||
'name': 'Thought Leadership',
|
||||
'description': 'Position as industry expert through insights and trends',
|
||||
'target_keywords': ['industry trends', 'expert insights', 'market analysis'],
|
||||
'content_types': ['Blog posts', 'Whitepapers', 'Webinars', 'Podcasts'],
|
||||
'success_metrics': ['Brand mentions', 'Expert citations', 'Speaking invitations'],
|
||||
'content_ideas': [
|
||||
'Industry trend predictions for 2024',
|
||||
'Expert roundtable discussions',
|
||||
'Market analysis reports',
|
||||
'Innovation case studies',
|
||||
'Future of industry insights'
|
||||
]
|
||||
},
|
||||
{
|
||||
'id': 2,
|
||||
'name': 'Educational Content',
|
||||
'description': 'Educate audience on best practices and solutions',
|
||||
'target_keywords': ['how to', 'best practices', 'tutorials', 'guides'],
|
||||
'content_types': ['Tutorials', 'Guides', 'Video content', 'Infographics'],
|
||||
'success_metrics': ['Organic traffic', 'Time on page', 'Social shares'],
|
||||
'content_ideas': [
|
||||
'Step-by-step implementation guides',
|
||||
'Best practices checklists',
|
||||
'Common mistakes to avoid',
|
||||
'Tool comparison guides',
|
||||
'Quick tip series'
|
||||
]
|
||||
},
|
||||
{
|
||||
'id': 3,
|
||||
'name': 'Customer Success',
|
||||
'description': 'Showcase success stories and build trust',
|
||||
'target_keywords': ['case study', 'success story', 'results', 'testimonials'],
|
||||
'content_types': ['Case studies', 'Customer stories', 'Testimonials', 'Reviews'],
|
||||
'success_metrics': ['Lead generation', 'Conversion rate', 'Trust signals'],
|
||||
'content_ideas': [
|
||||
'Detailed customer case studies',
|
||||
'Before/after transformations',
|
||||
'ROI success stories',
|
||||
'Customer interview series',
|
||||
'Implementation timelines'
|
||||
]
|
||||
},
|
||||
{
|
||||
'id': 4,
|
||||
'name': 'Product Education',
|
||||
'description': 'Educate on product features and benefits',
|
||||
'target_keywords': ['product features', 'benefits', 'use cases', 'comparison'],
|
||||
'content_types': ['Product demos', 'Feature guides', 'Comparison content'],
|
||||
'success_metrics': ['Product adoption', 'Trial conversions', 'Feature usage'],
|
||||
'content_ideas': [
|
||||
'Feature deep-dive tutorials',
|
||||
'Use case demonstrations',
|
||||
'Product comparison guides',
|
||||
'Integration tutorials',
|
||||
'Advanced tips and tricks'
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
return pillars
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Content pillars error: {str(e)}")
|
||||
return []
|
||||
|
||||
def _create_content_calendar(self, content_pillars: List[Dict[str, Any]], business_info: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Create comprehensive content calendar."""
|
||||
timeline = business_info.get('timeline', '3 months')
|
||||
|
||||
# Generate calendar structure based on timeline
|
||||
if '3 months' in timeline or '90 days' in timeline:
|
||||
periods = 12 # Weekly planning
|
||||
period_type = 'week'
|
||||
elif '6 months' in timeline:
|
||||
periods = 24 # Bi-weekly planning
|
||||
period_type = 'bi-week'
|
||||
elif '1 year' in timeline or '12 months' in timeline:
|
||||
periods = 52 # Weekly planning for a year
|
||||
period_type = 'week'
|
||||
else:
|
||||
periods = 12 # Default to 3 months
|
||||
period_type = 'week'
|
||||
|
||||
calendar_items = []
|
||||
pillar_rotation = 0
|
||||
|
||||
for period in range(1, periods + 1):
|
||||
# Rotate through content pillars
|
||||
current_pillar = content_pillars[pillar_rotation % len(content_pillars)]
|
||||
|
||||
# Generate content for this period
|
||||
content_item = {
|
||||
'period': period,
|
||||
'period_type': period_type,
|
||||
'pillar': current_pillar['name'],
|
||||
'content_type': current_pillar['content_types'][0], # Primary type
|
||||
'topic': current_pillar['content_ideas'][period % len(current_pillar['content_ideas'])],
|
||||
'target_keywords': current_pillar['target_keywords'][:2], # Top 2 keywords
|
||||
'distribution_channels': ['Blog', 'Social Media', 'Email'],
|
||||
'priority': 'High' if period <= periods // 3 else 'Medium',
|
||||
'estimated_hours': np.random.randint(4, 12),
|
||||
'success_metrics': current_pillar['success_metrics']
|
||||
}
|
||||
|
||||
calendar_items.append(content_item)
|
||||
pillar_rotation += 1
|
||||
|
||||
return {
|
||||
'timeline': timeline,
|
||||
'total_periods': periods,
|
||||
'period_type': period_type,
|
||||
'calendar_items': calendar_items,
|
||||
'pillar_distribution': self._calculate_pillar_distribution(calendar_items, content_pillars)
|
||||
}
|
||||
|
||||
def _generate_topic_clusters(self, business_info: Dict[str, Any], content_pillars: List[Dict[str, Any]]) -> List[Dict[str, Any]]:
|
||||
"""Generate SEO topic clusters."""
|
||||
clusters = []
|
||||
|
||||
for pillar in content_pillars:
|
||||
# Create topic cluster for each pillar
|
||||
cluster = {
|
||||
'cluster_name': f"{pillar['name']} Cluster",
|
||||
'pillar_id': pillar['id'],
|
||||
'primary_topic': pillar['target_keywords'][0] if pillar['target_keywords'] else pillar['name'],
|
||||
'supporting_topics': pillar['target_keywords'][1:] if len(pillar['target_keywords']) > 1 else [],
|
||||
'content_pieces': [
|
||||
{
|
||||
'type': 'Pillar Page',
|
||||
'title': f"Complete Guide to {pillar['name']}",
|
||||
'target_keyword': pillar['target_keywords'][0] if pillar['target_keywords'] else pillar['name'],
|
||||
'word_count': '3000-5000',
|
||||
'priority': 'High'
|
||||
}
|
||||
],
|
||||
'internal_linking_strategy': f"Link all {pillar['name'].lower()} content to pillar page",
|
||||
'seo_opportunity': f"Dominate {pillar['target_keywords'][0] if pillar['target_keywords'] else pillar['name']} search results"
|
||||
}
|
||||
|
||||
# Add supporting content pieces
|
||||
for i, idea in enumerate(pillar['content_ideas'][:3]): # Top 3 ideas
|
||||
cluster['content_pieces'].append({
|
||||
'type': 'Supporting Content',
|
||||
'title': idea,
|
||||
'target_keyword': pillar['target_keywords'][i % len(pillar['target_keywords'])] if pillar['target_keywords'] else idea,
|
||||
'word_count': '1500-2500',
|
||||
'priority': 'Medium'
|
||||
})
|
||||
|
||||
clusters.append(cluster)
|
||||
|
||||
return clusters
|
||||
|
||||
def _create_distribution_strategy(self, business_info: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Create content distribution strategy."""
|
||||
return {
|
||||
'primary_channels': [
|
||||
{
|
||||
'channel': 'Company Blog',
|
||||
'content_types': ['Long-form articles', 'Guides', 'Case studies'],
|
||||
'frequency': 'Weekly',
|
||||
'audience_reach': 'High',
|
||||
'seo_value': 'High'
|
||||
},
|
||||
{
|
||||
'channel': 'LinkedIn',
|
||||
'content_types': ['Professional insights', 'Industry news', 'Thought leadership'],
|
||||
'frequency': 'Daily',
|
||||
'audience_reach': 'Medium',
|
||||
'seo_value': 'Medium'
|
||||
},
|
||||
{
|
||||
'channel': 'Email Newsletter',
|
||||
'content_types': ['Curated insights', 'Product updates', 'Educational content'],
|
||||
'frequency': 'Bi-weekly',
|
||||
'audience_reach': 'High',
|
||||
'seo_value': 'Low'
|
||||
}
|
||||
],
|
||||
'secondary_channels': [
|
||||
{
|
||||
'channel': 'YouTube',
|
||||
'content_types': ['Tutorial videos', 'Webinars', 'Product demos'],
|
||||
'frequency': 'Bi-weekly',
|
||||
'audience_reach': 'Medium',
|
||||
'seo_value': 'High'
|
||||
},
|
||||
{
|
||||
'channel': 'Industry Publications',
|
||||
'content_types': ['Guest articles', 'Expert quotes', 'Research insights'],
|
||||
'frequency': 'Monthly',
|
||||
'audience_reach': 'Medium',
|
||||
'seo_value': 'High'
|
||||
}
|
||||
],
|
||||
'repurposing_strategy': {
|
||||
'blog_post_to_social': 'Extract key insights for LinkedIn posts',
|
||||
'long_form_to_video': 'Create video summaries of detailed guides',
|
||||
'case_study_to_multiple': 'Create infographics, social posts, and email content',
|
||||
'webinar_to_content': 'Extract blog posts, social content, and email series'
|
||||
}
|
||||
}
|
||||
|
||||
def _create_kpi_framework(self, business_info: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Create KPI measurement framework."""
|
||||
return {
|
||||
'primary_kpis': [
|
||||
{
|
||||
'metric': 'Organic Traffic Growth',
|
||||
'target': '25% increase per quarter',
|
||||
'measurement': 'Google Analytics',
|
||||
'frequency': 'Monthly'
|
||||
},
|
||||
{
|
||||
'metric': 'Lead Generation',
|
||||
'target': '50 qualified leads per month',
|
||||
'measurement': 'CRM tracking',
|
||||
'frequency': 'Weekly'
|
||||
},
|
||||
{
|
||||
'metric': 'Brand Awareness',
|
||||
'target': '15% increase in brand mentions',
|
||||
'measurement': 'Social listening tools',
|
||||
'frequency': 'Monthly'
|
||||
}
|
||||
],
|
||||
'content_kpis': [
|
||||
{
|
||||
'metric': 'Content Engagement',
|
||||
'target': '5% average engagement rate',
|
||||
'measurement': 'Social media analytics',
|
||||
'frequency': 'Weekly'
|
||||
},
|
||||
{
|
||||
'metric': 'Content Shares',
|
||||
'target': '100 shares per piece',
|
||||
'measurement': 'Social sharing tracking',
|
||||
'frequency': 'Per content piece'
|
||||
},
|
||||
{
|
||||
'metric': 'Time on Page',
|
||||
'target': '3+ minutes average',
|
||||
'measurement': 'Google Analytics',
|
||||
'frequency': 'Monthly'
|
||||
}
|
||||
],
|
||||
'seo_kpis': [
|
||||
{
|
||||
'metric': 'Keyword Rankings',
|
||||
'target': 'Top 10 for 20 target keywords',
|
||||
'measurement': 'SEO tools',
|
||||
'frequency': 'Weekly'
|
||||
},
|
||||
{
|
||||
'metric': 'Backlink Growth',
|
||||
'target': '10 quality backlinks per month',
|
||||
'measurement': 'Backlink analysis tools',
|
||||
'frequency': 'Monthly'
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
def _create_implementation_roadmap(self, business_info: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Create implementation roadmap."""
|
||||
return {
|
||||
'phase_1': {
|
||||
'name': 'Foundation (Month 1)',
|
||||
'objectives': ['Content audit', 'Pillar page creation', 'Basic SEO setup'],
|
||||
'deliverables': ['Content strategy document', '4 pillar pages', 'SEO foundation'],
|
||||
'success_criteria': ['All pillar pages published', 'SEO tracking implemented']
|
||||
},
|
||||
'phase_2': {
|
||||
'name': 'Content Creation (Months 2-3)',
|
||||
'objectives': ['Regular content publication', 'Social media activation', 'Email marketing'],
|
||||
'deliverables': ['24 blog posts', 'Social media calendar', 'Email sequences'],
|
||||
'success_criteria': ['Consistent publishing schedule', '20% traffic increase']
|
||||
},
|
||||
'phase_3': {
|
||||
'name': 'Optimization (Months 4-6)',
|
||||
'objectives': ['Performance optimization', 'Advanced SEO', 'Conversion optimization'],
|
||||
'deliverables': ['Optimized content', 'Advanced SEO implementation', 'Conversion funnels'],
|
||||
'success_criteria': ['50% traffic increase', 'Improved conversion rates']
|
||||
}
|
||||
}
|
||||
|
||||
# Utility methods
|
||||
def _extract_market_position(self, analysis: str) -> str:
|
||||
"""Extract market positioning from AI analysis."""
|
||||
return "Market positioning insights extracted from AI analysis"
|
||||
|
||||
def _extract_content_gaps(self, analysis: str) -> List[str]:
|
||||
"""Extract content gaps from AI analysis."""
|
||||
return ["Educational content gap", "Technical documentation gap", "Case study gap"]
|
||||
|
||||
def _extract_competitive_advantages(self, analysis: str) -> List[str]:
|
||||
"""Extract competitive advantages from AI analysis."""
|
||||
return ["Unique technology approach", "Industry expertise", "Customer success focus"]
|
||||
|
||||
def _extract_audience_insights(self, analysis: str) -> Dict[str, Any]:
|
||||
"""Extract audience insights from AI analysis."""
|
||||
return {
|
||||
'pain_points': ["Complex implementation", "Limited resources", "ROI concerns"],
|
||||
'content_preferences': ["Visual content", "Step-by-step guides", "Real examples"],
|
||||
'consumption_patterns': ["Mobile-first", "Video preferred", "Quick consumption"]
|
||||
}
|
||||
|
||||
def _calculate_pillar_distribution(self, calendar_items: List[Dict[str, Any]], content_pillars: List[Dict[str, Any]]) -> Dict[str, int]:
|
||||
"""Calculate content distribution across pillars."""
|
||||
distribution = {}
|
||||
for pillar in content_pillars:
|
||||
count = len([item for item in calendar_items if item['pillar'] == pillar['name']])
|
||||
distribution[pillar['name']] = count
|
||||
return distribution
|
||||
|
||||
def _generate_strategic_insights(self, business_info: Dict[str, Any], content_pillars: List[Dict[str, Any]]) -> Dict[str, Any]:
|
||||
"""Generate strategic insights and recommendations."""
|
||||
return {
|
||||
'key_insights': [
|
||||
"Focus on educational content for early funnel engagement",
|
||||
"Leverage customer success stories for conversion",
|
||||
"Develop thought leadership for brand authority",
|
||||
"Create product education for user adoption"
|
||||
],
|
||||
'strategic_recommendations': [
|
||||
"Implement topic cluster strategy for SEO dominance",
|
||||
"Create pillar page for each content theme",
|
||||
"Develop comprehensive content repurposing workflow",
|
||||
"Establish thought leadership through industry insights"
|
||||
],
|
||||
'risk_mitigation': [
|
||||
"Diversify content topics to avoid algorithm dependency",
|
||||
"Create evergreen content for long-term value",
|
||||
"Build email list to reduce platform dependency",
|
||||
"Monitor competitor content to maintain differentiation"
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
def render_ai_content_strategy():
|
||||
"""Render the AI Content Strategy interface."""
|
||||
|
||||
st.title("🧠 AI Content Strategy Generator")
|
||||
st.markdown("**Generate comprehensive content strategies powered by AI intelligence**")
|
||||
|
||||
# Configuration form
|
||||
st.header("📋 Business Information")
|
||||
|
||||
with st.form("content_strategy_form"):
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
industry = st.selectbox(
|
||||
"Industry",
|
||||
[
|
||||
"Technology & Software",
|
||||
"Marketing & Advertising",
|
||||
"Healthcare",
|
||||
"Finance & Fintech",
|
||||
"E-commerce",
|
||||
"Education",
|
||||
"Manufacturing",
|
||||
"Professional Services",
|
||||
"Other"
|
||||
],
|
||||
index=0
|
||||
)
|
||||
|
||||
target_audience = st.text_area(
|
||||
"Target Audience",
|
||||
placeholder="Describe your ideal customers, their roles, challenges, and goals...",
|
||||
height=100
|
||||
)
|
||||
|
||||
business_goals = st.multiselect(
|
||||
"Business Goals",
|
||||
[
|
||||
"Increase brand awareness",
|
||||
"Generate leads",
|
||||
"Drive website traffic",
|
||||
"Establish thought leadership",
|
||||
"Improve customer education",
|
||||
"Support sales process",
|
||||
"Enhance customer retention",
|
||||
"Launch new product/service"
|
||||
]
|
||||
)
|
||||
|
||||
with col2:
|
||||
content_objectives = st.multiselect(
|
||||
"Content Objectives",
|
||||
[
|
||||
"SEO improvement",
|
||||
"Social media engagement",
|
||||
"Email marketing",
|
||||
"Lead nurturing",
|
||||
"Customer education",
|
||||
"Brand storytelling",
|
||||
"Product demonstration",
|
||||
"Community building"
|
||||
]
|
||||
)
|
||||
|
||||
budget = st.selectbox(
|
||||
"Monthly Content Budget",
|
||||
[
|
||||
"No budget",
|
||||
"Under $1,000",
|
||||
"$1,000 - $5,000",
|
||||
"$5,000 - $10,000",
|
||||
"$10,000 - $25,000",
|
||||
"$25,000+"
|
||||
]
|
||||
)
|
||||
|
||||
timeline = st.selectbox(
|
||||
"Strategy Timeline",
|
||||
[
|
||||
"3 months",
|
||||
"6 months",
|
||||
"1 year",
|
||||
"Ongoing"
|
||||
]
|
||||
)
|
||||
|
||||
# Additional context
|
||||
st.subheader("Additional Context")
|
||||
|
||||
current_challenges = st.text_area(
|
||||
"Current Content Challenges",
|
||||
placeholder="What content challenges are you currently facing?",
|
||||
height=80
|
||||
)
|
||||
|
||||
competitive_landscape = st.text_area(
|
||||
"Competitive Landscape",
|
||||
placeholder="Describe your main competitors and their content approach...",
|
||||
height=80
|
||||
)
|
||||
|
||||
submit_strategy = st.form_submit_button("🧠 Generate AI Content Strategy", type="primary")
|
||||
|
||||
# Process strategy generation
|
||||
if submit_strategy:
|
||||
if target_audience and business_goals and content_objectives:
|
||||
# Prepare business information
|
||||
business_info = {
|
||||
'industry': industry,
|
||||
'target_audience': target_audience,
|
||||
'business_goals': business_goals,
|
||||
'content_objectives': content_objectives,
|
||||
'budget': budget,
|
||||
'timeline': timeline,
|
||||
'current_challenges': current_challenges,
|
||||
'competitive_landscape': competitive_landscape
|
||||
}
|
||||
|
||||
# Initialize generator
|
||||
if 'strategy_generator' not in st.session_state:
|
||||
st.session_state.strategy_generator = AIContentStrategyGenerator()
|
||||
|
||||
generator = st.session_state.strategy_generator
|
||||
|
||||
with st.spinner("🧠 Generating AI-powered content strategy..."):
|
||||
strategy_results = generator.generate_content_strategy(business_info)
|
||||
|
||||
if 'error' not in strategy_results:
|
||||
st.success("✅ Content strategy generated successfully!")
|
||||
|
||||
# Store results in session state
|
||||
st.session_state.strategy_results = strategy_results
|
||||
|
||||
# Display results
|
||||
render_strategy_results_dashboard(strategy_results)
|
||||
else:
|
||||
st.error(f"❌ Strategy generation failed: {strategy_results['error']}")
|
||||
else:
|
||||
st.warning("⚠️ Please fill in target audience, business goals, and content objectives.")
|
||||
|
||||
# Show previous results if available
|
||||
elif 'strategy_results' in st.session_state:
|
||||
st.info("🧠 Showing previous strategy results")
|
||||
render_strategy_results_dashboard(st.session_state.strategy_results)
|
||||
|
||||
|
||||
def render_strategy_results_dashboard(results: Dict[str, Any]):
|
||||
"""Render comprehensive strategy results dashboard."""
|
||||
|
||||
# Strategy overview
|
||||
st.header("📊 Content Strategy Overview")
|
||||
|
||||
business_analysis = results.get('business_analysis', {})
|
||||
content_pillars = results.get('content_pillars', [])
|
||||
content_calendar = results.get('content_calendar', {})
|
||||
|
||||
# Key metrics overview
|
||||
col1, col2, col3, col4 = st.columns(4)
|
||||
|
||||
with col1:
|
||||
st.metric("Content Pillars", len(content_pillars))
|
||||
|
||||
with col2:
|
||||
calendar_items = content_calendar.get('calendar_items', [])
|
||||
st.metric("Content Pieces", len(calendar_items))
|
||||
|
||||
with col3:
|
||||
timeline = content_calendar.get('timeline', 'Not specified')
|
||||
st.metric("Timeline", timeline)
|
||||
|
||||
with col4:
|
||||
total_hours = sum(item.get('estimated_hours', 0) for item in calendar_items)
|
||||
st.metric("Est. Hours", f"{total_hours}h")
|
||||
|
||||
# Strategy tabs
|
||||
tab1, tab2, tab3, tab4, tab5, tab6 = st.tabs([
|
||||
"🧠 AI Insights",
|
||||
"🏛️ Content Pillars",
|
||||
"📅 Content Calendar",
|
||||
"🎯 Topic Clusters",
|
||||
"📢 Distribution",
|
||||
"📊 Implementation"
|
||||
])
|
||||
|
||||
with tab1:
|
||||
if business_analysis:
|
||||
st.subheader("Business Analysis & Insights")
|
||||
|
||||
# Market positioning
|
||||
market_position = business_analysis.get('market_position', '')
|
||||
if market_position:
|
||||
st.markdown("#### 🎯 Market Positioning")
|
||||
st.info(market_position)
|
||||
|
||||
# Content gaps
|
||||
content_gaps = business_analysis.get('content_gaps', [])
|
||||
if content_gaps:
|
||||
st.markdown("#### 🔍 Content Gaps Identified")
|
||||
for gap in content_gaps:
|
||||
st.warning(f"📌 {gap}")
|
||||
|
||||
# Competitive advantages
|
||||
advantages = business_analysis.get('competitive_advantages', [])
|
||||
if advantages:
|
||||
st.markdown("#### 🏆 Competitive Advantages")
|
||||
for advantage in advantages:
|
||||
st.success(f"✅ {advantage}")
|
||||
|
||||
# AI insights
|
||||
ai_insights = results.get('ai_insights', {})
|
||||
if ai_insights:
|
||||
st.markdown("#### 🧠 Strategic AI Insights")
|
||||
|
||||
insights = ai_insights.get('key_insights', [])
|
||||
for insight in insights:
|
||||
st.info(f"💡 {insight}")
|
||||
|
||||
recommendations = ai_insights.get('strategic_recommendations', [])
|
||||
if recommendations:
|
||||
st.markdown("#### 🎯 Strategic Recommendations")
|
||||
for rec in recommendations:
|
||||
st.success(f"📋 {rec}")
|
||||
|
||||
with tab2:
|
||||
if content_pillars:
|
||||
st.subheader("Content Pillars Strategy")
|
||||
|
||||
# Pillars overview chart
|
||||
pillar_names = [pillar['name'] for pillar in content_pillars]
|
||||
pillar_ideas = [len(pillar['content_ideas']) for pillar in content_pillars]
|
||||
|
||||
fig = px.bar(
|
||||
x=pillar_names,
|
||||
y=pillar_ideas,
|
||||
title="Content Ideas per Pillar",
|
||||
labels={'x': 'Content Pillars', 'y': 'Number of Ideas'}
|
||||
)
|
||||
st.plotly_chart(fig, use_container_width=True)
|
||||
|
||||
# Detailed pillar information
|
||||
for pillar in content_pillars:
|
||||
with st.expander(f"🏛️ {pillar['name']}", expanded=False):
|
||||
st.markdown(f"**Description:** {pillar['description']}")
|
||||
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
st.markdown("**Target Keywords:**")
|
||||
for keyword in pillar['target_keywords']:
|
||||
st.code(keyword)
|
||||
|
||||
st.markdown("**Content Types:**")
|
||||
for content_type in pillar['content_types']:
|
||||
st.write(f"• {content_type}")
|
||||
|
||||
with col2:
|
||||
st.markdown("**Success Metrics:**")
|
||||
for metric in pillar['success_metrics']:
|
||||
st.write(f"📊 {metric}")
|
||||
|
||||
st.markdown("**Content Ideas:**")
|
||||
for idea in pillar['content_ideas']:
|
||||
st.write(f"💡 {idea}")
|
||||
|
||||
with tab3:
|
||||
if content_calendar:
|
||||
st.subheader("Content Calendar & Planning")
|
||||
|
||||
calendar_items = content_calendar.get('calendar_items', [])
|
||||
|
||||
if calendar_items:
|
||||
# Calendar overview
|
||||
df_calendar = pd.DataFrame(calendar_items)
|
||||
|
||||
# Priority distribution
|
||||
priority_counts = df_calendar['priority'].value_counts()
|
||||
fig_priority = px.pie(
|
||||
values=priority_counts.values,
|
||||
names=priority_counts.index,
|
||||
title="Content Priority Distribution"
|
||||
)
|
||||
st.plotly_chart(fig_priority, use_container_width=True)
|
||||
|
||||
# Content calendar table
|
||||
st.markdown("#### 📅 Detailed Content Calendar")
|
||||
|
||||
display_df = df_calendar[[
|
||||
'period', 'pillar', 'content_type', 'topic',
|
||||
'priority', 'estimated_hours'
|
||||
]].copy()
|
||||
|
||||
display_df.columns = [
|
||||
'Period', 'Pillar', 'Content Type', 'Topic',
|
||||
'Priority', 'Est. Hours'
|
||||
]
|
||||
|
||||
st.dataframe(
|
||||
display_df,
|
||||
column_config={
|
||||
"Priority": st.column_config.SelectboxColumn(
|
||||
"Priority",
|
||||
options=["High", "Medium", "Low"]
|
||||
),
|
||||
"Est. Hours": st.column_config.NumberColumn(
|
||||
"Est. Hours",
|
||||
format="%d h"
|
||||
)
|
||||
},
|
||||
hide_index=True,
|
||||
use_container_width=True
|
||||
)
|
||||
|
||||
# Export calendar
|
||||
csv = df_calendar.to_csv(index=False)
|
||||
st.download_button(
|
||||
label="📥 Download Content Calendar",
|
||||
data=csv,
|
||||
file_name=f"content_calendar_{datetime.now().strftime('%Y%m%d')}.csv",
|
||||
mime="text/csv"
|
||||
)
|
||||
|
||||
with tab4:
|
||||
topic_clusters = results.get('topic_clusters', [])
|
||||
if topic_clusters:
|
||||
st.subheader("SEO Topic Clusters")
|
||||
|
||||
for cluster in topic_clusters:
|
||||
with st.expander(f"🎯 {cluster['cluster_name']}", expanded=False):
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
st.markdown(f"**Primary Topic:** {cluster['primary_topic']}")
|
||||
st.markdown(f"**SEO Opportunity:** {cluster['seo_opportunity']}")
|
||||
st.markdown(f"**Linking Strategy:** {cluster['internal_linking_strategy']}")
|
||||
|
||||
with col2:
|
||||
st.markdown("**Supporting Topics:**")
|
||||
for topic in cluster['supporting_topics']:
|
||||
st.code(topic)
|
||||
|
||||
st.markdown("**Content Pieces:**")
|
||||
content_pieces = cluster['content_pieces']
|
||||
df_pieces = pd.DataFrame(content_pieces)
|
||||
st.dataframe(df_pieces, hide_index=True, use_container_width=True)
|
||||
|
||||
with tab5:
|
||||
distribution_strategy = results.get('distribution_strategy', {})
|
||||
if distribution_strategy:
|
||||
st.subheader("Content Distribution Strategy")
|
||||
|
||||
# Primary channels
|
||||
primary_channels = distribution_strategy.get('primary_channels', [])
|
||||
if primary_channels:
|
||||
st.markdown("#### 📢 Primary Distribution Channels")
|
||||
df_primary = pd.DataFrame(primary_channels)
|
||||
st.dataframe(df_primary, hide_index=True, use_container_width=True)
|
||||
|
||||
# Secondary channels
|
||||
secondary_channels = distribution_strategy.get('secondary_channels', [])
|
||||
if secondary_channels:
|
||||
st.markdown("#### 📺 Secondary Distribution Channels")
|
||||
df_secondary = pd.DataFrame(secondary_channels)
|
||||
st.dataframe(df_secondary, hide_index=True, use_container_width=True)
|
||||
|
||||
# Repurposing strategy
|
||||
repurposing = distribution_strategy.get('repurposing_strategy', {})
|
||||
if repurposing:
|
||||
st.markdown("#### ♻️ Content Repurposing Strategy")
|
||||
for strategy, description in repurposing.items():
|
||||
st.write(f"**{strategy.replace('_', ' ').title()}:** {description}")
|
||||
|
||||
with tab6:
|
||||
# Implementation roadmap
|
||||
roadmap = results.get('implementation_roadmap', {})
|
||||
kpi_framework = results.get('kpi_framework', {})
|
||||
|
||||
if roadmap:
|
||||
st.subheader("Implementation Roadmap")
|
||||
|
||||
for phase_key, phase_data in roadmap.items():
|
||||
with st.expander(f"📋 {phase_data['name']}", expanded=False):
|
||||
st.markdown(f"**Objectives:**")
|
||||
for objective in phase_data['objectives']:
|
||||
st.write(f"• {objective}")
|
||||
|
||||
st.markdown(f"**Deliverables:**")
|
||||
for deliverable in phase_data['deliverables']:
|
||||
st.write(f"📦 {deliverable}")
|
||||
|
||||
st.markdown(f"**Success Criteria:**")
|
||||
for criteria in phase_data['success_criteria']:
|
||||
st.write(f"✅ {criteria}")
|
||||
|
||||
if kpi_framework:
|
||||
st.subheader("KPI Framework")
|
||||
|
||||
# Primary KPIs
|
||||
primary_kpis = kpi_framework.get('primary_kpis', [])
|
||||
if primary_kpis:
|
||||
st.markdown("#### 🎯 Primary KPIs")
|
||||
df_primary_kpis = pd.DataFrame(primary_kpis)
|
||||
st.dataframe(df_primary_kpis, hide_index=True, use_container_width=True)
|
||||
|
||||
# Content KPIs
|
||||
content_kpis = kpi_framework.get('content_kpis', [])
|
||||
if content_kpis:
|
||||
st.markdown("#### 📝 Content KPIs")
|
||||
df_content_kpis = pd.DataFrame(content_kpis)
|
||||
st.dataframe(df_content_kpis, hide_index=True, use_container_width=True)
|
||||
|
||||
# Export functionality
|
||||
st.markdown("---")
|
||||
col1, col2, col3 = st.columns(3)
|
||||
|
||||
with col1:
|
||||
if st.button("📥 Export Full Strategy", use_container_width=True):
|
||||
strategy_json = json.dumps(results, indent=2, default=str)
|
||||
st.download_button(
|
||||
label="Download JSON Strategy",
|
||||
data=strategy_json,
|
||||
file_name=f"content_strategy_{datetime.now().strftime('%Y%m%d_%H%M%S')}.json",
|
||||
mime="application/json"
|
||||
)
|
||||
|
||||
with col2:
|
||||
if st.button("📊 Export Calendar", use_container_width=True):
|
||||
calendar_items = content_calendar.get('calendar_items', [])
|
||||
if calendar_items:
|
||||
df_calendar = pd.DataFrame(calendar_items)
|
||||
csv = df_calendar.to_csv(index=False)
|
||||
st.download_button(
|
||||
label="Download CSV Calendar",
|
||||
data=csv,
|
||||
file_name=f"content_calendar_{datetime.now().strftime('%Y%m%d_%H%M%S')}.csv",
|
||||
mime="text/csv"
|
||||
)
|
||||
|
||||
with col3:
|
||||
if st.button("🔄 Generate New Strategy", use_container_width=True):
|
||||
if 'strategy_results' in st.session_state:
|
||||
del st.session_state.strategy_results
|
||||
st.rerun()
|
||||
|
||||
|
||||
# Main execution
|
||||
if __name__ == "__main__":
|
||||
render_ai_content_strategy()
|
||||
919
ToBeMigrated/ai_seo_tools/enterprise_seo_suite.py
Normal file
919
ToBeMigrated/ai_seo_tools/enterprise_seo_suite.py
Normal file
@@ -0,0 +1,919 @@
|
||||
"""
|
||||
Enterprise SEO Command Center
|
||||
|
||||
Unified AI-powered SEO suite that orchestrates all existing tools into
|
||||
intelligent workflows for enterprise-level SEO management.
|
||||
"""
|
||||
|
||||
import streamlit as st
|
||||
import asyncio
|
||||
import pandas as pd
|
||||
from typing import Dict, Any, List, Optional, Tuple
|
||||
from datetime import datetime, timedelta
|
||||
import json
|
||||
from loguru import logger
|
||||
|
||||
# Import existing SEO tools
|
||||
from .on_page_seo_analyzer import fetch_seo_data
|
||||
from .content_gap_analysis.enhanced_analyzer import EnhancedContentGapAnalyzer
|
||||
from .technical_seo_crawler.crawler import TechnicalSEOCrawler
|
||||
from .weburl_seo_checker import url_seo_checker
|
||||
from .google_pagespeed_insights import google_pagespeed_insights
|
||||
from ..gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
|
||||
# Import the new enterprise tools
|
||||
from .google_search_console_integration import GoogleSearchConsoleAnalyzer, render_gsc_integration
|
||||
from .ai_content_strategy import AIContentStrategyGenerator, render_ai_content_strategy
|
||||
|
||||
class EnterpriseSEOSuite:
|
||||
"""
|
||||
Enterprise-level SEO suite orchestrating all tools into intelligent workflows.
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
"""Initialize the enterprise SEO suite."""
|
||||
self.gap_analyzer = EnhancedContentGapAnalyzer()
|
||||
self.technical_crawler = TechnicalSEOCrawler()
|
||||
|
||||
# Initialize new enterprise tools
|
||||
self.gsc_analyzer = GoogleSearchConsoleAnalyzer()
|
||||
self.content_strategy_generator = AIContentStrategyGenerator()
|
||||
|
||||
# SEO workflow templates
|
||||
self.workflow_templates = {
|
||||
'complete_audit': 'Complete SEO Audit',
|
||||
'content_strategy': 'Content Strategy Development',
|
||||
'technical_optimization': 'Technical SEO Optimization',
|
||||
'competitor_intelligence': 'Competitive Intelligence',
|
||||
'keyword_domination': 'Keyword Domination Strategy',
|
||||
'local_seo': 'Local SEO Optimization',
|
||||
'enterprise_monitoring': 'Enterprise SEO Monitoring'
|
||||
}
|
||||
|
||||
logger.info("Enterprise SEO Suite initialized")
|
||||
|
||||
async def execute_complete_seo_audit(self, website_url: str, competitors: List[str],
|
||||
target_keywords: List[str]) -> Dict[str, Any]:
|
||||
"""
|
||||
Execute a comprehensive enterprise SEO audit combining all tools.
|
||||
|
||||
Args:
|
||||
website_url: Primary website to audit
|
||||
competitors: List of competitor URLs (max 5)
|
||||
target_keywords: Primary keywords to optimize for
|
||||
|
||||
Returns:
|
||||
Comprehensive audit results with prioritized action plan
|
||||
"""
|
||||
try:
|
||||
st.info("🚀 Initiating Complete Enterprise SEO Audit...")
|
||||
|
||||
audit_results = {
|
||||
'audit_timestamp': datetime.utcnow().isoformat(),
|
||||
'website_url': website_url,
|
||||
'competitors': competitors[:5],
|
||||
'target_keywords': target_keywords,
|
||||
'technical_audit': {},
|
||||
'content_analysis': {},
|
||||
'competitive_intelligence': {},
|
||||
'on_page_analysis': {},
|
||||
'performance_metrics': {},
|
||||
'strategic_recommendations': {},
|
||||
'priority_action_plan': []
|
||||
}
|
||||
|
||||
# Phase 1: Technical SEO Audit
|
||||
with st.expander("🔧 Technical SEO Analysis", expanded=True):
|
||||
st.info("Analyzing technical SEO factors...")
|
||||
technical_results = await self._run_technical_audit(website_url)
|
||||
audit_results['technical_audit'] = technical_results
|
||||
st.success("✅ Technical audit completed")
|
||||
|
||||
# Phase 2: Content Gap Analysis
|
||||
with st.expander("📊 Content Intelligence Analysis", expanded=True):
|
||||
st.info("Analyzing content gaps and opportunities...")
|
||||
content_results = await self._run_content_analysis(
|
||||
website_url, competitors, target_keywords
|
||||
)
|
||||
audit_results['content_analysis'] = content_results
|
||||
st.success("✅ Content analysis completed")
|
||||
|
||||
# Phase 3: On-Page SEO Analysis
|
||||
with st.expander("🔍 On-Page SEO Analysis", expanded=True):
|
||||
st.info("Analyzing on-page SEO factors...")
|
||||
onpage_results = await self._run_onpage_analysis(website_url)
|
||||
audit_results['on_page_analysis'] = onpage_results
|
||||
st.success("✅ On-page analysis completed")
|
||||
|
||||
# Phase 4: Performance Analysis
|
||||
with st.expander("⚡ Performance Analysis", expanded=True):
|
||||
st.info("Analyzing website performance...")
|
||||
performance_results = await self._run_performance_analysis(website_url)
|
||||
audit_results['performance_metrics'] = performance_results
|
||||
st.success("✅ Performance analysis completed")
|
||||
|
||||
# Phase 5: AI-Powered Strategic Recommendations
|
||||
with st.expander("🤖 AI Strategic Analysis", expanded=True):
|
||||
st.info("Generating AI-powered strategic recommendations...")
|
||||
strategic_analysis = await self._generate_strategic_recommendations(audit_results)
|
||||
audit_results['strategic_recommendations'] = strategic_analysis
|
||||
|
||||
# Generate prioritized action plan
|
||||
action_plan = await self._create_priority_action_plan(audit_results)
|
||||
audit_results['priority_action_plan'] = action_plan
|
||||
st.success("✅ Strategic analysis completed")
|
||||
|
||||
return audit_results
|
||||
|
||||
except Exception as e:
|
||||
error_msg = f"Error in complete SEO audit: {str(e)}"
|
||||
logger.error(error_msg, exc_info=True)
|
||||
st.error(error_msg)
|
||||
return {'error': error_msg}
|
||||
|
||||
async def _run_technical_audit(self, website_url: str) -> Dict[str, Any]:
|
||||
"""Run comprehensive technical SEO audit."""
|
||||
try:
|
||||
# Use existing technical crawler
|
||||
technical_results = self.technical_crawler.analyze_website_technical_seo(
|
||||
website_url, crawl_depth=3, max_pages=100
|
||||
)
|
||||
|
||||
# Enhance with additional technical checks
|
||||
enhanced_results = {
|
||||
'crawler_results': technical_results,
|
||||
'critical_issues': self._identify_critical_technical_issues(technical_results),
|
||||
'performance_score': self._calculate_technical_score(technical_results),
|
||||
'priority_fixes': self._prioritize_technical_fixes(technical_results)
|
||||
}
|
||||
|
||||
return enhanced_results
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Technical audit error: {str(e)}")
|
||||
return {'error': str(e)}
|
||||
|
||||
async def _run_content_analysis(self, website_url: str, competitors: List[str],
|
||||
keywords: List[str]) -> Dict[str, Any]:
|
||||
"""Run comprehensive content gap analysis."""
|
||||
try:
|
||||
# Use existing content gap analyzer
|
||||
content_results = self.gap_analyzer.analyze_comprehensive_gap(
|
||||
website_url, competitors, keywords, industry="general"
|
||||
)
|
||||
|
||||
# Enhance with content strategy insights
|
||||
enhanced_results = {
|
||||
'gap_analysis': content_results,
|
||||
'content_opportunities': self._identify_content_opportunities(content_results),
|
||||
'keyword_strategy': self._develop_keyword_strategy(content_results),
|
||||
'competitive_advantages': self._find_competitive_advantages(content_results)
|
||||
}
|
||||
|
||||
return enhanced_results
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Content analysis error: {str(e)}")
|
||||
return {'error': str(e)}
|
||||
|
||||
async def _run_onpage_analysis(self, website_url: str) -> Dict[str, Any]:
|
||||
"""Run on-page SEO analysis."""
|
||||
try:
|
||||
# Use existing on-page analyzer
|
||||
onpage_data = fetch_seo_data(website_url)
|
||||
|
||||
# Enhanced analysis
|
||||
enhanced_results = {
|
||||
'seo_data': onpage_data,
|
||||
'optimization_score': self._calculate_onpage_score(onpage_data),
|
||||
'meta_optimization': self._analyze_meta_optimization(onpage_data),
|
||||
'content_optimization': self._analyze_content_optimization(onpage_data)
|
||||
}
|
||||
|
||||
return enhanced_results
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"On-page analysis error: {str(e)}")
|
||||
return {'error': str(e)}
|
||||
|
||||
async def _run_performance_analysis(self, website_url: str) -> Dict[str, Any]:
|
||||
"""Run website performance analysis."""
|
||||
try:
|
||||
# Comprehensive performance metrics
|
||||
performance_results = {
|
||||
'core_web_vitals': await self._analyze_core_web_vitals(website_url),
|
||||
'loading_performance': await self._analyze_loading_performance(website_url),
|
||||
'mobile_optimization': await self._analyze_mobile_optimization(website_url),
|
||||
'performance_score': 0 # Will be calculated
|
||||
}
|
||||
|
||||
# Calculate overall performance score
|
||||
performance_results['performance_score'] = self._calculate_performance_score(
|
||||
performance_results
|
||||
)
|
||||
|
||||
return performance_results
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Performance analysis error: {str(e)}")
|
||||
return {'error': str(e)}
|
||||
|
||||
async def _generate_strategic_recommendations(self, audit_results: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Generate AI-powered strategic recommendations."""
|
||||
try:
|
||||
# Compile audit summary for AI analysis
|
||||
audit_summary = {
|
||||
'technical_score': audit_results.get('technical_audit', {}).get('performance_score', 0),
|
||||
'content_gaps': len(audit_results.get('content_analysis', {}).get('content_opportunities', [])),
|
||||
'onpage_score': audit_results.get('on_page_analysis', {}).get('optimization_score', 0),
|
||||
'performance_score': audit_results.get('performance_metrics', {}).get('performance_score', 0)
|
||||
}
|
||||
|
||||
strategic_prompt = f"""
|
||||
Analyze this comprehensive SEO audit and provide strategic recommendations:
|
||||
|
||||
AUDIT SUMMARY:
|
||||
- Technical SEO Score: {audit_summary['technical_score']}/100
|
||||
- Content Gaps Identified: {audit_summary['content_gaps']}
|
||||
- On-Page SEO Score: {audit_summary['onpage_score']}/100
|
||||
- Performance Score: {audit_summary['performance_score']}/100
|
||||
|
||||
DETAILED FINDINGS:
|
||||
Technical Issues: {json.dumps(audit_results.get('technical_audit', {}), indent=2)[:1000]}
|
||||
Content Opportunities: {json.dumps(audit_results.get('content_analysis', {}), indent=2)[:1000]}
|
||||
|
||||
Provide strategic recommendations in these categories:
|
||||
|
||||
1. IMMEDIATE WINS (0-30 days):
|
||||
- Quick technical fixes with high impact
|
||||
- Content optimizations for existing pages
|
||||
- Critical performance improvements
|
||||
|
||||
2. STRATEGIC INITIATIVES (1-3 months):
|
||||
- Content strategy development
|
||||
- Technical architecture improvements
|
||||
- Competitive positioning strategies
|
||||
|
||||
3. LONG-TERM GROWTH (3-12 months):
|
||||
- Authority building strategies
|
||||
- Market expansion opportunities
|
||||
- Advanced SEO techniques
|
||||
|
||||
4. RISK MITIGATION:
|
||||
- Technical vulnerabilities to address
|
||||
- Content gaps that competitors could exploit
|
||||
- Performance issues affecting user experience
|
||||
|
||||
Provide specific, actionable recommendations with expected impact and effort estimates.
|
||||
"""
|
||||
|
||||
strategic_analysis = llm_text_gen(
|
||||
strategic_prompt,
|
||||
system_prompt="You are an enterprise SEO strategist with 10+ years of experience. Provide detailed, actionable recommendations based on comprehensive audit data."
|
||||
)
|
||||
|
||||
return {
|
||||
'full_analysis': strategic_analysis,
|
||||
'immediate_wins': self._extract_immediate_wins(strategic_analysis),
|
||||
'strategic_initiatives': self._extract_strategic_initiatives(strategic_analysis),
|
||||
'long_term_growth': self._extract_long_term_growth(strategic_analysis),
|
||||
'risk_mitigation': self._extract_risk_mitigation(strategic_analysis)
|
||||
}
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Strategic analysis error: {str(e)}")
|
||||
return {'error': str(e)}
|
||||
|
||||
async def _create_priority_action_plan(self, audit_results: Dict[str, Any]) -> List[Dict[str, Any]]:
|
||||
"""Create prioritized action plan from audit results."""
|
||||
try:
|
||||
action_plan = []
|
||||
|
||||
# Extract recommendations from all analysis phases
|
||||
strategic_recs = audit_results.get('strategic_recommendations', {})
|
||||
|
||||
# Immediate wins (High priority, low effort)
|
||||
immediate_wins = strategic_recs.get('immediate_wins', [])
|
||||
for win in immediate_wins[:5]:
|
||||
action_plan.append({
|
||||
'category': 'Immediate Win',
|
||||
'priority': 'Critical',
|
||||
'effort': 'Low',
|
||||
'timeframe': '0-30 days',
|
||||
'action': win,
|
||||
'expected_impact': 'High',
|
||||
'source': 'Strategic Analysis'
|
||||
})
|
||||
|
||||
# Technical fixes
|
||||
technical_issues = audit_results.get('technical_audit', {}).get('critical_issues', [])
|
||||
for issue in technical_issues[:3]:
|
||||
action_plan.append({
|
||||
'category': 'Technical SEO',
|
||||
'priority': 'High',
|
||||
'effort': 'Medium',
|
||||
'timeframe': '1-4 weeks',
|
||||
'action': issue,
|
||||
'expected_impact': 'High',
|
||||
'source': 'Technical Audit'
|
||||
})
|
||||
|
||||
# Content opportunities
|
||||
content_ops = audit_results.get('content_analysis', {}).get('content_opportunities', [])
|
||||
for opportunity in content_ops[:3]:
|
||||
action_plan.append({
|
||||
'category': 'Content Strategy',
|
||||
'priority': 'Medium',
|
||||
'effort': 'High',
|
||||
'timeframe': '2-8 weeks',
|
||||
'action': opportunity,
|
||||
'expected_impact': 'Medium',
|
||||
'source': 'Content Analysis'
|
||||
})
|
||||
|
||||
# Sort by priority and expected impact
|
||||
priority_order = {'Critical': 0, 'High': 1, 'Medium': 2, 'Low': 3}
|
||||
action_plan.sort(key=lambda x: priority_order.get(x['priority'], 4))
|
||||
|
||||
return action_plan[:15] # Top 15 actions
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Action plan creation error: {str(e)}")
|
||||
return []
|
||||
|
||||
# Utility methods for analysis
|
||||
def _identify_critical_technical_issues(self, technical_results: Dict[str, Any]) -> List[str]:
|
||||
"""Identify critical technical SEO issues."""
|
||||
critical_issues = []
|
||||
|
||||
# Add logic to identify critical technical issues
|
||||
# This would analyze the technical_results and extract critical problems
|
||||
|
||||
return critical_issues
|
||||
|
||||
def _calculate_technical_score(self, technical_results: Dict[str, Any]) -> int:
|
||||
"""Calculate technical SEO score."""
|
||||
# Implement scoring algorithm based on technical audit results
|
||||
return 75 # Placeholder
|
||||
|
||||
def _prioritize_technical_fixes(self, technical_results: Dict[str, Any]) -> List[str]:
|
||||
"""Prioritize technical fixes by impact and effort."""
|
||||
# Implement prioritization logic
|
||||
return ["Fix broken links", "Optimize images", "Improve page speed"]
|
||||
|
||||
def _identify_content_opportunities(self, content_results: Dict[str, Any]) -> List[str]:
|
||||
"""Identify top content opportunities."""
|
||||
# Extract content opportunities from gap analysis
|
||||
return ["Create FAQ content", "Develop comparison guides", "Write how-to articles"]
|
||||
|
||||
def _develop_keyword_strategy(self, content_results: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Develop keyword strategy from content analysis."""
|
||||
return {
|
||||
'primary_keywords': [],
|
||||
'secondary_keywords': [],
|
||||
'long_tail_opportunities': [],
|
||||
'competitor_gaps': []
|
||||
}
|
||||
|
||||
def _find_competitive_advantages(self, content_results: Dict[str, Any]) -> List[str]:
|
||||
"""Find competitive advantages from analysis."""
|
||||
return ["Unique content angles", "Underserved niches", "Technical superiority"]
|
||||
|
||||
def _calculate_onpage_score(self, onpage_data: Dict[str, Any]) -> int:
|
||||
"""Calculate on-page SEO score."""
|
||||
return 80 # Placeholder
|
||||
|
||||
def _analyze_meta_optimization(self, onpage_data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Analyze meta tag optimization."""
|
||||
return {'title_optimization': 'good', 'description_optimization': 'needs_work'}
|
||||
|
||||
def _analyze_content_optimization(self, onpage_data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Analyze content optimization."""
|
||||
return {'keyword_density': 'optimal', 'content_length': 'adequate'}
|
||||
|
||||
async def _analyze_core_web_vitals(self, website_url: str) -> Dict[str, Any]:
|
||||
"""Analyze Core Web Vitals."""
|
||||
return {'lcp': 2.5, 'fid': 100, 'cls': 0.1}
|
||||
|
||||
async def _analyze_loading_performance(self, website_url: str) -> Dict[str, Any]:
|
||||
"""Analyze loading performance."""
|
||||
return {'ttfb': 200, 'fcp': 1.5, 'speed_index': 3.0}
|
||||
|
||||
async def _analyze_mobile_optimization(self, website_url: str) -> Dict[str, Any]:
|
||||
"""Analyze mobile optimization."""
|
||||
return {'mobile_friendly': True, 'responsive_design': True}
|
||||
|
||||
def _calculate_performance_score(self, performance_results: Dict[str, Any]) -> int:
|
||||
"""Calculate overall performance score."""
|
||||
return 85 # Placeholder
|
||||
|
||||
def _extract_immediate_wins(self, analysis: str) -> List[str]:
|
||||
"""Extract immediate wins from strategic analysis."""
|
||||
# Parse the AI analysis and extract immediate wins
|
||||
lines = analysis.split('\n')
|
||||
wins = []
|
||||
in_immediate_section = False
|
||||
|
||||
for line in lines:
|
||||
if 'IMMEDIATE WINS' in line.upper():
|
||||
in_immediate_section = True
|
||||
continue
|
||||
elif 'STRATEGIC INITIATIVES' in line.upper():
|
||||
in_immediate_section = False
|
||||
continue
|
||||
|
||||
if in_immediate_section and line.strip().startswith('-'):
|
||||
wins.append(line.strip().lstrip('- '))
|
||||
|
||||
return wins[:5]
|
||||
|
||||
def _extract_strategic_initiatives(self, analysis: str) -> List[str]:
|
||||
"""Extract strategic initiatives from analysis."""
|
||||
# Similar extraction logic for strategic initiatives
|
||||
return ["Develop content hub", "Implement schema markup", "Build authority pages"]
|
||||
|
||||
def _extract_long_term_growth(self, analysis: str) -> List[str]:
|
||||
"""Extract long-term growth strategies."""
|
||||
return ["Market expansion", "Authority building", "Advanced technical SEO"]
|
||||
|
||||
def _extract_risk_mitigation(self, analysis: str) -> List[str]:
|
||||
"""Extract risk mitigation strategies."""
|
||||
return ["Fix technical vulnerabilities", "Address content gaps", "Improve performance"]
|
||||
|
||||
def execute_content_strategy_workflow(self, business_info: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""
|
||||
Execute comprehensive content strategy workflow using AI insights.
|
||||
|
||||
Args:
|
||||
business_info: Business context and objectives
|
||||
|
||||
Returns:
|
||||
Complete content strategy with implementation plan
|
||||
"""
|
||||
try:
|
||||
st.info("🧠 Executing AI-powered content strategy workflow...")
|
||||
|
||||
# Generate AI content strategy
|
||||
content_strategy = self.content_strategy_generator.generate_content_strategy(business_info)
|
||||
|
||||
# If GSC data is available, enhance with search insights
|
||||
if business_info.get('gsc_site_url'):
|
||||
gsc_insights = self.gsc_analyzer.analyze_search_performance(
|
||||
business_info['gsc_site_url'],
|
||||
business_info.get('gsc_date_range', 90)
|
||||
)
|
||||
content_strategy['gsc_insights'] = gsc_insights
|
||||
|
||||
# Generate SEO-optimized content recommendations
|
||||
seo_content_recs = self._generate_seo_content_recommendations(content_strategy)
|
||||
content_strategy['seo_recommendations'] = seo_content_recs
|
||||
|
||||
return content_strategy
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Content strategy workflow error: {str(e)}")
|
||||
return {'error': str(e)}
|
||||
|
||||
def execute_search_intelligence_workflow(self, site_url: str, date_range: int = 90) -> Dict[str, Any]:
|
||||
"""
|
||||
Execute comprehensive search intelligence workflow using GSC data.
|
||||
|
||||
Args:
|
||||
site_url: Website URL registered in GSC
|
||||
date_range: Analysis period in days
|
||||
|
||||
Returns:
|
||||
Complete search intelligence analysis with actionable insights
|
||||
"""
|
||||
try:
|
||||
st.info("📊 Executing search intelligence workflow...")
|
||||
|
||||
# Analyze GSC performance
|
||||
gsc_analysis = self.gsc_analyzer.analyze_search_performance(site_url, date_range)
|
||||
|
||||
# Enhance with technical SEO analysis
|
||||
technical_analysis = self.technical_crawler.crawl_and_analyze(site_url)
|
||||
gsc_analysis['technical_insights'] = technical_analysis
|
||||
|
||||
# Generate content gap analysis based on GSC keywords
|
||||
if gsc_analysis.get('keyword_analysis'):
|
||||
keywords = [kw['keyword'] for kw in gsc_analysis['keyword_analysis'].get('high_volume_keywords', [])]
|
||||
content_gaps = self.gap_analyzer.analyze_content_gaps(
|
||||
keywords[:10], # Top 10 keywords
|
||||
site_url
|
||||
)
|
||||
gsc_analysis['content_gap_analysis'] = content_gaps
|
||||
|
||||
# Generate comprehensive recommendations
|
||||
search_recommendations = self._generate_search_intelligence_recommendations(gsc_analysis)
|
||||
gsc_analysis['comprehensive_recommendations'] = search_recommendations
|
||||
|
||||
return gsc_analysis
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Search intelligence workflow error: {str(e)}")
|
||||
return {'error': str(e)}
|
||||
|
||||
def _generate_seo_content_recommendations(self, content_strategy: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Generate SEO-optimized content recommendations based on strategy."""
|
||||
try:
|
||||
content_pillars = content_strategy.get('content_pillars', [])
|
||||
|
||||
seo_recommendations = {
|
||||
'keyword_optimization': [],
|
||||
'content_structure': [],
|
||||
'internal_linking': [],
|
||||
'technical_seo': []
|
||||
}
|
||||
|
||||
for pillar in content_pillars:
|
||||
# Keyword optimization recommendations
|
||||
for keyword in pillar.get('target_keywords', []):
|
||||
seo_recommendations['keyword_optimization'].append({
|
||||
'pillar': pillar['name'],
|
||||
'keyword': keyword,
|
||||
'recommendation': f"Create comprehensive content targeting '{keyword}' with semantic variations",
|
||||
'priority': 'High' if keyword in pillar['target_keywords'][:2] else 'Medium'
|
||||
})
|
||||
|
||||
# Content structure recommendations
|
||||
seo_recommendations['content_structure'].append({
|
||||
'pillar': pillar['name'],
|
||||
'recommendation': f"Create pillar page for {pillar['name']} with supporting cluster content",
|
||||
'structure': 'Pillar + Cluster model'
|
||||
})
|
||||
|
||||
# Internal linking strategy
|
||||
seo_recommendations['internal_linking'] = [
|
||||
"Link all cluster content to relevant pillar pages",
|
||||
"Create topic-based internal linking structure",
|
||||
"Use contextual anchor text with target keywords",
|
||||
"Implement breadcrumb navigation for topic clusters"
|
||||
]
|
||||
|
||||
# Technical SEO recommendations
|
||||
seo_recommendations['technical_seo'] = [
|
||||
"Optimize page speed for all content pages",
|
||||
"Implement structured data for articles",
|
||||
"Create XML sitemap sections for content categories",
|
||||
"Optimize images with descriptive alt text"
|
||||
]
|
||||
|
||||
return seo_recommendations
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"SEO content recommendations error: {str(e)}")
|
||||
return {'error': str(e)}
|
||||
|
||||
def _generate_search_intelligence_recommendations(self, gsc_analysis: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Generate comprehensive recommendations from search intelligence analysis."""
|
||||
try:
|
||||
recommendations = {
|
||||
'immediate_actions': [],
|
||||
'content_opportunities': [],
|
||||
'technical_improvements': [],
|
||||
'strategic_initiatives': []
|
||||
}
|
||||
|
||||
# Extract content opportunities from GSC analysis
|
||||
content_opps = gsc_analysis.get('content_opportunities', [])
|
||||
for opp in content_opps[:5]: # Top 5 opportunities
|
||||
recommendations['content_opportunities'].append({
|
||||
'type': opp['type'],
|
||||
'keyword': opp['keyword'],
|
||||
'action': opp['opportunity'],
|
||||
'priority': opp['priority'],
|
||||
'estimated_impact': opp['potential_impact']
|
||||
})
|
||||
|
||||
# Technical improvements from analysis
|
||||
technical_insights = gsc_analysis.get('technical_insights', {})
|
||||
if technical_insights.get('crawl_issues_indicators'):
|
||||
for issue in technical_insights['crawl_issues_indicators']:
|
||||
recommendations['technical_improvements'].append({
|
||||
'issue': issue,
|
||||
'priority': 'High',
|
||||
'category': 'Crawl & Indexing'
|
||||
})
|
||||
|
||||
# Immediate actions based on performance
|
||||
performance = gsc_analysis.get('performance_overview', {})
|
||||
if performance.get('avg_ctr', 0) < 2:
|
||||
recommendations['immediate_actions'].append({
|
||||
'action': 'Improve meta descriptions and titles for better CTR',
|
||||
'expected_impact': 'Increase CTR by 1-2%',
|
||||
'timeline': '2-4 weeks'
|
||||
})
|
||||
|
||||
if performance.get('avg_position', 0) > 10:
|
||||
recommendations['immediate_actions'].append({
|
||||
'action': 'Focus on improving content quality for top keywords',
|
||||
'expected_impact': 'Improve average position by 2-5 ranks',
|
||||
'timeline': '4-8 weeks'
|
||||
})
|
||||
|
||||
# Strategic initiatives
|
||||
competitive_analysis = gsc_analysis.get('competitive_analysis', {})
|
||||
if competitive_analysis.get('market_position') in ['Challenger', 'Emerging Player']:
|
||||
recommendations['strategic_initiatives'].append({
|
||||
'initiative': 'Develop thought leadership content strategy',
|
||||
'goal': 'Improve market position and brand authority',
|
||||
'timeline': '3-6 months'
|
||||
})
|
||||
|
||||
return recommendations
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Search intelligence recommendations error: {str(e)}")
|
||||
return {'error': str(e)}
|
||||
|
||||
def render_enterprise_seo_suite():
|
||||
"""Render the Enterprise SEO Command Center interface."""
|
||||
|
||||
st.set_page_config(
|
||||
page_title="Enterprise SEO Command Center",
|
||||
page_icon="🚀",
|
||||
layout="wide"
|
||||
)
|
||||
|
||||
st.title("🚀 Enterprise SEO Command Center")
|
||||
st.markdown("**Unified AI-powered SEO suite orchestrating all tools into intelligent workflows**")
|
||||
|
||||
# Initialize suite
|
||||
if 'enterprise_seo_suite' not in st.session_state:
|
||||
st.session_state.enterprise_seo_suite = EnterpriseSEOSuite()
|
||||
|
||||
suite = st.session_state.enterprise_seo_suite
|
||||
|
||||
# Workflow selection
|
||||
st.sidebar.header("🎯 SEO Workflow Selection")
|
||||
selected_workflow = st.sidebar.selectbox(
|
||||
"Choose Workflow",
|
||||
list(suite.workflow_templates.keys()),
|
||||
format_func=lambda x: suite.workflow_templates[x]
|
||||
)
|
||||
|
||||
# Main workflow interface
|
||||
if selected_workflow == 'complete_audit':
|
||||
st.header("🔍 Complete Enterprise SEO Audit")
|
||||
render_complete_audit_interface(suite)
|
||||
elif selected_workflow == 'content_strategy':
|
||||
st.header("📊 Content Strategy Development")
|
||||
render_content_strategy_interface(suite)
|
||||
elif selected_workflow == 'technical_optimization':
|
||||
st.header("🔧 Technical SEO Optimization")
|
||||
render_technical_optimization_interface(suite)
|
||||
else:
|
||||
st.info(f"Workflow '{suite.workflow_templates[selected_workflow]}' is being developed.")
|
||||
|
||||
def render_complete_audit_interface(suite: EnterpriseSEOSuite):
|
||||
"""Render the complete audit workflow interface."""
|
||||
|
||||
# Input form
|
||||
with st.form("enterprise_audit_form"):
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
website_url = st.text_input(
|
||||
"Website URL",
|
||||
value="https://example.com",
|
||||
help="Enter your website URL for comprehensive analysis"
|
||||
)
|
||||
|
||||
target_keywords = st.text_area(
|
||||
"Target Keywords (one per line)",
|
||||
value="AI content creation\nSEO tools\ncontent optimization",
|
||||
help="Enter your primary keywords to optimize for"
|
||||
)
|
||||
|
||||
with col2:
|
||||
competitors = st.text_area(
|
||||
"Competitor URLs (one per line)",
|
||||
value="https://jasper.ai\nhttps://copy.ai\nhttps://writesonic.com",
|
||||
help="Enter up to 5 competitor URLs for analysis"
|
||||
)
|
||||
|
||||
submit_audit = st.form_submit_button("🚀 Start Complete SEO Audit", type="primary")
|
||||
|
||||
# Process audit
|
||||
if submit_audit:
|
||||
if website_url and target_keywords:
|
||||
# Parse inputs
|
||||
keywords_list = [k.strip() for k in target_keywords.split('\n') if k.strip()]
|
||||
competitors_list = [c.strip() for c in competitors.split('\n') if c.strip()]
|
||||
|
||||
# Run audit
|
||||
with st.spinner("🔍 Running comprehensive SEO audit..."):
|
||||
audit_results = asyncio.run(
|
||||
suite.execute_complete_seo_audit(
|
||||
website_url, competitors_list, keywords_list
|
||||
)
|
||||
)
|
||||
|
||||
if 'error' not in audit_results:
|
||||
st.success("✅ Enterprise SEO audit completed!")
|
||||
|
||||
# Display results dashboard
|
||||
render_audit_results_dashboard(audit_results)
|
||||
else:
|
||||
st.error(f"❌ Audit failed: {audit_results['error']}")
|
||||
else:
|
||||
st.warning("⚠️ Please enter website URL and target keywords.")
|
||||
|
||||
def render_audit_results_dashboard(results: Dict[str, Any]):
|
||||
"""Render comprehensive audit results dashboard."""
|
||||
|
||||
# Priority Action Plan (Most Important)
|
||||
st.header("📋 Priority Action Plan")
|
||||
action_plan = results.get('priority_action_plan', [])
|
||||
|
||||
if action_plan:
|
||||
# Display as interactive table
|
||||
df_actions = pd.DataFrame(action_plan)
|
||||
|
||||
# Style the dataframe
|
||||
st.dataframe(
|
||||
df_actions,
|
||||
column_config={
|
||||
"category": "Category",
|
||||
"priority": st.column_config.SelectboxColumn(
|
||||
"Priority",
|
||||
options=["Critical", "High", "Medium", "Low"]
|
||||
),
|
||||
"effort": "Effort Level",
|
||||
"timeframe": "Timeline",
|
||||
"action": "Action Required",
|
||||
"expected_impact": "Expected Impact"
|
||||
},
|
||||
hide_index=True,
|
||||
use_container_width=True
|
||||
)
|
||||
|
||||
# Key Metrics Overview
|
||||
st.header("📊 SEO Health Dashboard")
|
||||
|
||||
col1, col2, col3, col4 = st.columns(4)
|
||||
|
||||
with col1:
|
||||
technical_score = results.get('technical_audit', {}).get('performance_score', 0)
|
||||
st.metric("Technical SEO", f"{technical_score}/100", delta=None)
|
||||
|
||||
with col2:
|
||||
onpage_score = results.get('on_page_analysis', {}).get('optimization_score', 0)
|
||||
st.metric("On-Page SEO", f"{onpage_score}/100", delta=None)
|
||||
|
||||
with col3:
|
||||
performance_score = results.get('performance_metrics', {}).get('performance_score', 0)
|
||||
st.metric("Performance", f"{performance_score}/100", delta=None)
|
||||
|
||||
with col4:
|
||||
content_gaps = len(results.get('content_analysis', {}).get('content_opportunities', []))
|
||||
st.metric("Content Opportunities", content_gaps, delta=None)
|
||||
|
||||
# Detailed Analysis Sections
|
||||
tab1, tab2, tab3, tab4, tab5 = st.tabs([
|
||||
"🤖 Strategic Insights",
|
||||
"🔧 Technical Analysis",
|
||||
"📊 Content Intelligence",
|
||||
"🔍 On-Page Analysis",
|
||||
"⚡ Performance Metrics"
|
||||
])
|
||||
|
||||
with tab1:
|
||||
strategic_recs = results.get('strategic_recommendations', {})
|
||||
if strategic_recs:
|
||||
st.subheader("AI-Powered Strategic Recommendations")
|
||||
|
||||
# Immediate wins
|
||||
immediate_wins = strategic_recs.get('immediate_wins', [])
|
||||
if immediate_wins:
|
||||
st.markdown("#### 🚀 Immediate Wins (0-30 days)")
|
||||
for win in immediate_wins[:5]:
|
||||
st.success(f"✅ {win}")
|
||||
|
||||
# Strategic initiatives
|
||||
strategic_initiatives = strategic_recs.get('strategic_initiatives', [])
|
||||
if strategic_initiatives:
|
||||
st.markdown("#### 📈 Strategic Initiatives (1-3 months)")
|
||||
for initiative in strategic_initiatives[:3]:
|
||||
st.info(f"📋 {initiative}")
|
||||
|
||||
# Full analysis
|
||||
full_analysis = strategic_recs.get('full_analysis', '')
|
||||
if full_analysis:
|
||||
with st.expander("🧠 Complete Strategic Analysis"):
|
||||
st.write(full_analysis)
|
||||
|
||||
with tab2:
|
||||
technical_audit = results.get('technical_audit', {})
|
||||
if technical_audit:
|
||||
st.subheader("Technical SEO Analysis")
|
||||
|
||||
critical_issues = technical_audit.get('critical_issues', [])
|
||||
if critical_issues:
|
||||
st.markdown("#### ⚠️ Critical Issues")
|
||||
for issue in critical_issues:
|
||||
st.error(f"🚨 {issue}")
|
||||
|
||||
priority_fixes = technical_audit.get('priority_fixes', [])
|
||||
if priority_fixes:
|
||||
st.markdown("#### 🔧 Priority Fixes")
|
||||
for fix in priority_fixes:
|
||||
st.warning(f"🛠️ {fix}")
|
||||
|
||||
with tab3:
|
||||
content_analysis = results.get('content_analysis', {})
|
||||
if content_analysis:
|
||||
st.subheader("Content Intelligence")
|
||||
|
||||
content_opportunities = content_analysis.get('content_opportunities', [])
|
||||
if content_opportunities:
|
||||
st.markdown("#### 📝 Content Opportunities")
|
||||
for opportunity in content_opportunities[:5]:
|
||||
st.info(f"💡 {opportunity}")
|
||||
|
||||
competitive_advantages = content_analysis.get('competitive_advantages', [])
|
||||
if competitive_advantages:
|
||||
st.markdown("#### 🏆 Competitive Advantages")
|
||||
for advantage in competitive_advantages:
|
||||
st.success(f"⭐ {advantage}")
|
||||
|
||||
with tab4:
|
||||
onpage_analysis = results.get('on_page_analysis', {})
|
||||
if onpage_analysis:
|
||||
st.subheader("On-Page SEO Analysis")
|
||||
|
||||
meta_optimization = onpage_analysis.get('meta_optimization', {})
|
||||
content_optimization = onpage_analysis.get('content_optimization', {})
|
||||
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
st.markdown("#### 🏷️ Meta Tag Optimization")
|
||||
st.json(meta_optimization)
|
||||
|
||||
with col2:
|
||||
st.markdown("#### 📄 Content Optimization")
|
||||
st.json(content_optimization)
|
||||
|
||||
with tab5:
|
||||
performance_metrics = results.get('performance_metrics', {})
|
||||
if performance_metrics:
|
||||
st.subheader("Performance Analysis")
|
||||
|
||||
core_vitals = performance_metrics.get('core_web_vitals', {})
|
||||
loading_performance = performance_metrics.get('loading_performance', {})
|
||||
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
st.markdown("#### ⚡ Core Web Vitals")
|
||||
st.json(core_vitals)
|
||||
|
||||
with col2:
|
||||
st.markdown("#### 🚀 Loading Performance")
|
||||
st.json(loading_performance)
|
||||
|
||||
# Export functionality
|
||||
st.markdown("---")
|
||||
col1, col2, col3 = st.columns(3)
|
||||
|
||||
with col1:
|
||||
if st.button("📥 Export Full Report", use_container_width=True):
|
||||
# Create downloadable report
|
||||
report_json = json.dumps(results, indent=2, default=str)
|
||||
st.download_button(
|
||||
label="Download JSON Report",
|
||||
data=report_json,
|
||||
file_name=f"seo_audit_{datetime.now().strftime('%Y%m%d_%H%M%S')}.json",
|
||||
mime="application/json"
|
||||
)
|
||||
|
||||
with col2:
|
||||
if st.button("📊 Export Action Plan", use_container_width=True):
|
||||
# Create CSV of action plan
|
||||
df_actions = pd.DataFrame(action_plan)
|
||||
csv = df_actions.to_csv(index=False)
|
||||
st.download_button(
|
||||
label="Download CSV Action Plan",
|
||||
data=csv,
|
||||
file_name=f"action_plan_{datetime.now().strftime('%Y%m%d_%H%M%S')}.csv",
|
||||
mime="text/csv"
|
||||
)
|
||||
|
||||
with col3:
|
||||
if st.button("🔄 Schedule Follow-up Audit", use_container_width=True):
|
||||
st.info("Follow-up scheduling feature coming soon!")
|
||||
|
||||
def render_content_strategy_interface(suite: EnterpriseSEOSuite):
|
||||
"""Render content strategy development interface."""
|
||||
st.info("🚧 Content Strategy Development workflow coming soon!")
|
||||
|
||||
def render_technical_optimization_interface(suite: EnterpriseSEOSuite):
|
||||
"""Render technical optimization interface."""
|
||||
st.info("🚧 Technical SEO Optimization workflow coming soon!")
|
||||
|
||||
|
||||
# Main execution
|
||||
if __name__ == "__main__":
|
||||
render_enterprise_seo_suite()
|
||||
135
ToBeMigrated/ai_seo_tools/google_pagespeed_insights.py
Normal file
135
ToBeMigrated/ai_seo_tools/google_pagespeed_insights.py
Normal file
@@ -0,0 +1,135 @@
|
||||
import requests
|
||||
import streamlit as st
|
||||
import json
|
||||
import pandas as pd
|
||||
import plotly.express as px
|
||||
from tenacity import retry, stop_after_attempt, wait_random_exponential
|
||||
from datetime import datetime
|
||||
|
||||
def run_pagespeed(url, api_key=None, strategy='DESKTOP', locale='en'):
|
||||
"""Fetches and processes PageSpeed Insights data."""
|
||||
serviceurl = 'https://www.googleapis.com/pagespeedonline/v5/runPagespeed'
|
||||
base_url = f"{serviceurl}?url={url}&strategy={strategy}&locale={locale}&category=performance&category=accessibility&category=best-practices&category=seo"
|
||||
|
||||
if api_key:
|
||||
base_url += f"&key={api_key}"
|
||||
|
||||
try:
|
||||
response = requests.get(base_url)
|
||||
response.raise_for_status() # Raise an exception for bad status codes
|
||||
data = response.json()
|
||||
return data
|
||||
except requests.exceptions.RequestException as e:
|
||||
st.error(f"Error fetching PageSpeed Insights data: {e}")
|
||||
return None
|
||||
|
||||
def display_results(data):
|
||||
"""Presents PageSpeed Insights data in a user-friendly format."""
|
||||
st.subheader("PageSpeed Insights Report")
|
||||
|
||||
# Extract scores from the PageSpeed Insights data
|
||||
scores = {
|
||||
"Performance": data['lighthouseResult']['categories']['performance']['score'] * 100,
|
||||
"Accessibility": data['lighthouseResult']['categories']['accessibility']['score'] * 100,
|
||||
"SEO": data['lighthouseResult']['categories']['seo']['score'] * 100,
|
||||
"Best Practices": data['lighthouseResult']['categories']['best-practices']['score'] * 100
|
||||
}
|
||||
|
||||
descriptions = {
|
||||
"Performance": data['lighthouseResult']['categories']['performance'].get('description', "This score represents Google's assessment of your page's speed. A higher percentage indicates better performance."),
|
||||
"Accessibility": data['lighthouseResult']['categories']['accessibility'].get('description', "This score evaluates how accessible your page is to users with disabilities. A higher percentage means better accessibility."),
|
||||
"SEO": data['lighthouseResult']['categories']['seo'].get('description', "This score measures how well your page is optimized for search engines. A higher percentage indicates better SEO practices."),
|
||||
"Best Practices": data['lighthouseResult']['categories']['best-practices'].get('description', "This score reflects how well your page follows best practices for web development. A higher percentage signifies adherence to best practices.")
|
||||
}
|
||||
|
||||
for category, score in scores.items():
|
||||
st.metric(label=f"Overall {category} Score", value=f"{score:.0f}%", help=descriptions[category])
|
||||
|
||||
# Display additional metrics
|
||||
st.subheader("Additional Metrics")
|
||||
additional_metrics = {
|
||||
"First Contentful Paint (FCP)": data['lighthouseResult']['audits']['first-contentful-paint']['displayValue'],
|
||||
"Largest Contentful Paint (LCP)": data['lighthouseResult']['audits']['largest-contentful-paint']['displayValue'],
|
||||
"Time to Interactive (TTI)": data['lighthouseResult']['audits']['interactive']['displayValue'],
|
||||
"Total Blocking Time (TBT)": data['lighthouseResult']['audits']['total-blocking-time']['displayValue'],
|
||||
"Cumulative Layout Shift (CLS)": data['lighthouseResult']['audits']['cumulative-layout-shift']['displayValue']
|
||||
}
|
||||
|
||||
st.table(pd.DataFrame(additional_metrics.items(), columns=["Metric", "Value"]))
|
||||
|
||||
# Display Network Requests
|
||||
st.subheader("Network Requests")
|
||||
if 'network-requests' in data['lighthouseResult']['audits']:
|
||||
network_requests = [
|
||||
{
|
||||
"End Time": item.get("endTime", "N/A"),
|
||||
"Start Time": item.get("startTime", "N/A"),
|
||||
"Transfer Size (MB)": round(item.get("transferSize", 0) / 1048576, 2),
|
||||
"Resource Size (MB)": round(item.get("resourceSize", 0) / 1048576, 2),
|
||||
"URL": item.get("url", "N/A")
|
||||
}
|
||||
for item in data["lighthouseResult"]["audits"]["network-requests"]["details"]["items"]
|
||||
if item.get("transferSize", 0) > 100000 or item.get("resourceSize", 0) > 100000
|
||||
]
|
||||
if network_requests:
|
||||
st.dataframe(pd.DataFrame(network_requests), use_container_width=True)
|
||||
else:
|
||||
st.write("No significant network requests found.")
|
||||
|
||||
# Display Mainthread Work Breakdown
|
||||
st.subheader("Mainthread Work Breakdown")
|
||||
if 'mainthread-work-breakdown' in data['lighthouseResult']['audits']:
|
||||
mainthread_data = [
|
||||
{"Process": item.get("groupLabel", "N/A"), "Duration (ms)": item.get("duration", "N/A")}
|
||||
for item in data["lighthouseResult"]["audits"]["mainthread-work-breakdown"]["details"]["items"] if item.get("duration", "N/A") != "N/A"
|
||||
]
|
||||
if mainthread_data:
|
||||
fig = px.bar(pd.DataFrame(mainthread_data), x="Process", y="Duration (ms)", title="Mainthread Work Breakdown", labels={"Process": "Process", "Duration (ms)": "Duration (ms)"})
|
||||
st.plotly_chart(fig, use_container_width=True)
|
||||
else:
|
||||
st.write("No significant main thread work breakdown data found.")
|
||||
|
||||
# Display other metrics
|
||||
metrics = [
|
||||
("Use of Passive Event Listeners", 'uses-passive-event-listeners', ["URL", "Code Line"]),
|
||||
("DOM Size", 'dom-size', ["Score", "DOM Size"]),
|
||||
("Offscreen Images", 'offscreen-images', ["URL", "Total Bytes", "Wasted Bytes", "Wasted Percentage"]),
|
||||
("Critical Request Chains", 'critical-request-chains', ["URL", "Start Time", "End Time", "Transfer Size", "Chain"]),
|
||||
("Total Bytes Weight", 'total-byte-weight', ["URL", "Total Bytes"]),
|
||||
("Render Blocking Resources", 'render-blocking-resources', ["URL", "Total Bytes", "Wasted Milliseconds"]),
|
||||
("Use of Rel Preload", 'uses-rel-preload', ["URL", "Wasted Milliseconds"])
|
||||
]
|
||||
|
||||
for metric_title, audit_key, columns in metrics:
|
||||
st.subheader(metric_title)
|
||||
if audit_key in data['lighthouseResult']['audits']:
|
||||
details = data['lighthouseResult']['audits'][audit_key].get("details", {}).get("items", [])
|
||||
if details:
|
||||
st.table(pd.DataFrame(details, columns=columns))
|
||||
else:
|
||||
st.write(f"No significant {metric_title.lower()} data found.")
|
||||
|
||||
def google_pagespeed_insights():
|
||||
st.markdown("<h1 style='text-align: center; color: #1565C0;'>PageSpeed Insights Analyzer</h1>", unsafe_allow_html=True)
|
||||
st.markdown("<h3 style='text-align: center;'>Get detailed insights into your website's performance! Powered by Google PageSpeed Insights <a href='https://developer.chrome.com/docs/lighthouse/overview/'>[Learn More]</a></h3>", unsafe_allow_html=True)
|
||||
|
||||
# User Input
|
||||
with st.form("pagespeed_form"):
|
||||
url = st.text_input("Enter Website URL", placeholder="https://www.example.com")
|
||||
api_key = st.text_input("Enter Google API Key (Optional)", placeholder="Your API Key", help="Get your API key here: [https://developers.google.com/speed/docs/insights/v5/get-started#key]")
|
||||
device = st.selectbox("Choose Device", ["Mobile", "Desktop"])
|
||||
locale = st.selectbox("Choose Locale", ["en", "fr", "es", "de", "ja"])
|
||||
categories = st.multiselect("Select Categories to Analyze", ['PERFORMANCE', 'ACCESSIBILITY', 'BEST_PRACTICES', 'SEO'], default=['PERFORMANCE', 'ACCESSIBILITY', 'BEST_PRACTICES', 'SEO'])
|
||||
|
||||
submitted = st.form_submit_button("Analyze")
|
||||
|
||||
if submitted:
|
||||
if not url:
|
||||
st.error("Please provide the website URL.")
|
||||
else:
|
||||
strategy = 'mobile' if device == "Mobile" else 'desktop'
|
||||
data = run_pagespeed(url, api_key, strategy=strategy, locale=locale)
|
||||
if data:
|
||||
display_results(data)
|
||||
else:
|
||||
st.error("Failed to retrieve PageSpeed Insights data.")
|
||||
864
ToBeMigrated/ai_seo_tools/google_search_console_integration.py
Normal file
864
ToBeMigrated/ai_seo_tools/google_search_console_integration.py
Normal file
@@ -0,0 +1,864 @@
|
||||
"""
|
||||
Google Search Console Integration for Enterprise SEO
|
||||
|
||||
Connects GSC data with AI-powered content strategy and keyword intelligence.
|
||||
Provides enterprise-level search performance insights and content recommendations.
|
||||
"""
|
||||
|
||||
import streamlit as st
|
||||
import pandas as pd
|
||||
import numpy as np
|
||||
from typing import Dict, Any, List, Optional, Tuple
|
||||
from datetime import datetime, timedelta
|
||||
import json
|
||||
from loguru import logger
|
||||
import plotly.express as px
|
||||
import plotly.graph_objects as go
|
||||
from plotly.subplots import make_subplots
|
||||
|
||||
# Import AI modules
|
||||
from ..gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
|
||||
|
||||
class GoogleSearchConsoleAnalyzer:
|
||||
"""
|
||||
Enterprise Google Search Console analyzer with AI-powered insights.
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
"""Initialize the GSC analyzer."""
|
||||
self.gsc_client = None # Will be initialized when credentials are provided
|
||||
logger.info("Google Search Console Analyzer initialized")
|
||||
|
||||
def analyze_search_performance(self, site_url: str, date_range: int = 90) -> Dict[str, Any]:
|
||||
"""
|
||||
Analyze comprehensive search performance from GSC data.
|
||||
|
||||
Args:
|
||||
site_url: Website URL registered in GSC
|
||||
date_range: Number of days to analyze (default 90)
|
||||
|
||||
Returns:
|
||||
Comprehensive search performance analysis
|
||||
"""
|
||||
try:
|
||||
st.info("📊 Analyzing Google Search Console data...")
|
||||
|
||||
# Simulate GSC data for demonstration (replace with actual GSC API calls)
|
||||
search_data = self._get_mock_gsc_data(site_url, date_range)
|
||||
|
||||
# Perform comprehensive analysis
|
||||
analysis_results = {
|
||||
'site_url': site_url,
|
||||
'analysis_period': f"Last {date_range} days",
|
||||
'analysis_timestamp': datetime.utcnow().isoformat(),
|
||||
'performance_overview': self._analyze_performance_overview(search_data),
|
||||
'keyword_analysis': self._analyze_keyword_performance(search_data),
|
||||
'page_analysis': self._analyze_page_performance(search_data),
|
||||
'content_opportunities': self._identify_content_opportunities(search_data),
|
||||
'technical_insights': self._analyze_technical_seo_signals(search_data),
|
||||
'competitive_analysis': self._analyze_competitive_position(search_data),
|
||||
'ai_recommendations': self._generate_ai_recommendations(search_data)
|
||||
}
|
||||
|
||||
return analysis_results
|
||||
|
||||
except Exception as e:
|
||||
error_msg = f"Error analyzing search performance: {str(e)}"
|
||||
logger.error(error_msg, exc_info=True)
|
||||
return {'error': error_msg}
|
||||
|
||||
def _get_mock_gsc_data(self, site_url: str, days: int) -> Dict[str, pd.DataFrame]:
|
||||
"""
|
||||
Generate mock GSC data for demonstration.
|
||||
In production, this would fetch real data from GSC API.
|
||||
"""
|
||||
# Generate mock keyword data
|
||||
keywords_data = []
|
||||
sample_keywords = [
|
||||
"AI content creation", "SEO tools", "content optimization", "blog writing AI",
|
||||
"meta description generator", "keyword research", "technical SEO", "content strategy",
|
||||
"on-page optimization", "SERP analysis", "content gap analysis", "SEO audit"
|
||||
]
|
||||
|
||||
for keyword in sample_keywords:
|
||||
# Generate realistic performance data
|
||||
impressions = np.random.randint(100, 10000)
|
||||
clicks = int(impressions * np.random.uniform(0.02, 0.15)) # CTR between 2-15%
|
||||
position = np.random.uniform(3, 25)
|
||||
|
||||
keywords_data.append({
|
||||
'keyword': keyword,
|
||||
'impressions': impressions,
|
||||
'clicks': clicks,
|
||||
'ctr': (clicks / impressions) * 100,
|
||||
'position': position
|
||||
})
|
||||
|
||||
# Generate mock page data
|
||||
pages_data = []
|
||||
sample_pages = [
|
||||
"/blog/ai-content-creation-guide", "/tools/seo-analyzer", "/features/content-optimization",
|
||||
"/blog/technical-seo-checklist", "/tools/keyword-research", "/blog/content-strategy-2024",
|
||||
"/tools/meta-description-generator", "/blog/on-page-seo-guide", "/features/enterprise-seo"
|
||||
]
|
||||
|
||||
for page in sample_pages:
|
||||
impressions = np.random.randint(500, 5000)
|
||||
clicks = int(impressions * np.random.uniform(0.03, 0.12))
|
||||
position = np.random.uniform(5, 20)
|
||||
|
||||
pages_data.append({
|
||||
'page': page,
|
||||
'impressions': impressions,
|
||||
'clicks': clicks,
|
||||
'ctr': (clicks / impressions) * 100,
|
||||
'position': position
|
||||
})
|
||||
|
||||
# Generate time series data
|
||||
time_series_data = []
|
||||
for i in range(days):
|
||||
date = datetime.now() - timedelta(days=i)
|
||||
daily_clicks = np.random.randint(50, 500)
|
||||
daily_impressions = np.random.randint(1000, 8000)
|
||||
|
||||
time_series_data.append({
|
||||
'date': date.strftime('%Y-%m-%d'),
|
||||
'clicks': daily_clicks,
|
||||
'impressions': daily_impressions,
|
||||
'ctr': (daily_clicks / daily_impressions) * 100,
|
||||
'position': np.random.uniform(8, 15)
|
||||
})
|
||||
|
||||
return {
|
||||
'keywords': pd.DataFrame(keywords_data),
|
||||
'pages': pd.DataFrame(pages_data),
|
||||
'time_series': pd.DataFrame(time_series_data)
|
||||
}
|
||||
|
||||
def _analyze_performance_overview(self, search_data: Dict[str, pd.DataFrame]) -> Dict[str, Any]:
|
||||
"""Analyze overall search performance metrics."""
|
||||
keywords_df = search_data['keywords']
|
||||
time_series_df = search_data['time_series']
|
||||
|
||||
# Calculate totals and averages
|
||||
total_clicks = keywords_df['clicks'].sum()
|
||||
total_impressions = keywords_df['impressions'].sum()
|
||||
avg_ctr = (total_clicks / total_impressions) * 100 if total_impressions > 0 else 0
|
||||
avg_position = keywords_df['position'].mean()
|
||||
|
||||
# Calculate trends
|
||||
recent_clicks = time_series_df.head(7)['clicks'].mean()
|
||||
previous_clicks = time_series_df.tail(7)['clicks'].mean()
|
||||
clicks_trend = ((recent_clicks - previous_clicks) / previous_clicks * 100) if previous_clicks > 0 else 0
|
||||
|
||||
recent_impressions = time_series_df.head(7)['impressions'].mean()
|
||||
previous_impressions = time_series_df.tail(7)['impressions'].mean()
|
||||
impressions_trend = ((recent_impressions - previous_impressions) / previous_impressions * 100) if previous_impressions > 0 else 0
|
||||
|
||||
# Top performing keywords
|
||||
top_keywords = keywords_df.nlargest(5, 'clicks')[['keyword', 'clicks', 'impressions', 'position']].to_dict('records')
|
||||
|
||||
# Opportunity keywords (high impressions, low CTR)
|
||||
opportunity_keywords = keywords_df[
|
||||
(keywords_df['impressions'] > keywords_df['impressions'].median()) &
|
||||
(keywords_df['ctr'] < 3)
|
||||
].nlargest(5, 'impressions')[['keyword', 'impressions', 'ctr', 'position']].to_dict('records')
|
||||
|
||||
return {
|
||||
'total_clicks': int(total_clicks),
|
||||
'total_impressions': int(total_impressions),
|
||||
'avg_ctr': round(avg_ctr, 2),
|
||||
'avg_position': round(avg_position, 1),
|
||||
'clicks_trend': round(clicks_trend, 1),
|
||||
'impressions_trend': round(impressions_trend, 1),
|
||||
'top_keywords': top_keywords,
|
||||
'opportunity_keywords': opportunity_keywords
|
||||
}
|
||||
|
||||
def _analyze_keyword_performance(self, search_data: Dict[str, pd.DataFrame]) -> Dict[str, Any]:
|
||||
"""Analyze keyword performance and opportunities."""
|
||||
keywords_df = search_data['keywords']
|
||||
|
||||
# Keyword categorization
|
||||
high_volume_keywords = keywords_df[keywords_df['impressions'] > keywords_df['impressions'].quantile(0.8)]
|
||||
low_competition_keywords = keywords_df[keywords_df['position'] <= 10]
|
||||
optimization_opportunities = keywords_df[
|
||||
(keywords_df['position'] > 10) &
|
||||
(keywords_df['position'] <= 20) &
|
||||
(keywords_df['impressions'] > 100)
|
||||
]
|
||||
|
||||
# Content gap analysis
|
||||
missing_keywords = self._identify_missing_keywords(keywords_df)
|
||||
|
||||
# Seasonal trends analysis
|
||||
seasonal_insights = self._analyze_seasonal_trends(keywords_df)
|
||||
|
||||
return {
|
||||
'total_keywords': len(keywords_df),
|
||||
'high_volume_keywords': high_volume_keywords.to_dict('records'),
|
||||
'ranking_keywords': low_competition_keywords.to_dict('records'),
|
||||
'optimization_opportunities': optimization_opportunities.to_dict('records'),
|
||||
'missing_keywords': missing_keywords,
|
||||
'seasonal_insights': seasonal_insights,
|
||||
'keyword_distribution': {
|
||||
'positions_1_3': len(keywords_df[keywords_df['position'] <= 3]),
|
||||
'positions_4_10': len(keywords_df[(keywords_df['position'] > 3) & (keywords_df['position'] <= 10)]),
|
||||
'positions_11_20': len(keywords_df[(keywords_df['position'] > 10) & (keywords_df['position'] <= 20)]),
|
||||
'positions_21_plus': len(keywords_df[keywords_df['position'] > 20])
|
||||
}
|
||||
}
|
||||
|
||||
def _analyze_page_performance(self, search_data: Dict[str, pd.DataFrame]) -> Dict[str, Any]:
|
||||
"""Analyze page-level performance."""
|
||||
pages_df = search_data['pages']
|
||||
|
||||
# Top performing pages
|
||||
top_pages = pages_df.nlargest(10, 'clicks')
|
||||
|
||||
# Underperforming pages (high impressions, low clicks)
|
||||
underperforming_pages = pages_df[
|
||||
(pages_df['impressions'] > pages_df['impressions'].median()) &
|
||||
(pages_df['ctr'] < 2)
|
||||
].nlargest(5, 'impressions')
|
||||
|
||||
# Page type analysis
|
||||
page_types = self._categorize_pages(pages_df)
|
||||
|
||||
return {
|
||||
'top_pages': top_pages.to_dict('records'),
|
||||
'underperforming_pages': underperforming_pages.to_dict('records'),
|
||||
'page_types_performance': page_types,
|
||||
'total_pages': len(pages_df)
|
||||
}
|
||||
|
||||
def _identify_content_opportunities(self, search_data: Dict[str, pd.DataFrame]) -> List[Dict[str, Any]]:
|
||||
"""Identify content creation and optimization opportunities."""
|
||||
keywords_df = search_data['keywords']
|
||||
|
||||
opportunities = []
|
||||
|
||||
# High impression, low CTR keywords need content optimization
|
||||
low_ctr_keywords = keywords_df[
|
||||
(keywords_df['impressions'] > 500) &
|
||||
(keywords_df['ctr'] < 3)
|
||||
]
|
||||
|
||||
for _, keyword_row in low_ctr_keywords.iterrows():
|
||||
opportunities.append({
|
||||
'type': 'Content Optimization',
|
||||
'keyword': keyword_row['keyword'],
|
||||
'opportunity': f"Optimize existing content for '{keyword_row['keyword']}' to improve CTR from {keyword_row['ctr']:.1f}%",
|
||||
'potential_impact': 'High',
|
||||
'current_position': round(keyword_row['position'], 1),
|
||||
'impressions': int(keyword_row['impressions']),
|
||||
'priority': 'High' if keyword_row['impressions'] > 1000 else 'Medium'
|
||||
})
|
||||
|
||||
# Position 11-20 keywords need content improvement
|
||||
position_11_20 = keywords_df[
|
||||
(keywords_df['position'] > 10) &
|
||||
(keywords_df['position'] <= 20) &
|
||||
(keywords_df['impressions'] > 100)
|
||||
]
|
||||
|
||||
for _, keyword_row in position_11_20.iterrows():
|
||||
opportunities.append({
|
||||
'type': 'Content Enhancement',
|
||||
'keyword': keyword_row['keyword'],
|
||||
'opportunity': f"Enhance content for '{keyword_row['keyword']}' to move from position {keyword_row['position']:.1f} to first page",
|
||||
'potential_impact': 'Medium',
|
||||
'current_position': round(keyword_row['position'], 1),
|
||||
'impressions': int(keyword_row['impressions']),
|
||||
'priority': 'Medium'
|
||||
})
|
||||
|
||||
# Sort by potential impact and impressions
|
||||
opportunities = sorted(opportunities, key=lambda x: x['impressions'], reverse=True)
|
||||
|
||||
return opportunities[:10] # Top 10 opportunities
|
||||
|
||||
def _analyze_technical_seo_signals(self, search_data: Dict[str, pd.DataFrame]) -> Dict[str, Any]:
|
||||
"""Analyze technical SEO signals from search data."""
|
||||
keywords_df = search_data['keywords']
|
||||
pages_df = search_data['pages']
|
||||
|
||||
# Analyze performance patterns that might indicate technical issues
|
||||
technical_insights = {
|
||||
'crawl_issues_indicators': [],
|
||||
'mobile_performance': {},
|
||||
'core_web_vitals_impact': {},
|
||||
'indexing_insights': {}
|
||||
}
|
||||
|
||||
# Identify potential crawl issues
|
||||
very_low_impressions = keywords_df[keywords_df['impressions'] < 10]
|
||||
if len(very_low_impressions) > len(keywords_df) * 0.3: # If 30%+ have very low impressions
|
||||
technical_insights['crawl_issues_indicators'].append(
|
||||
"High percentage of keywords with very low impressions may indicate crawl or indexing issues"
|
||||
)
|
||||
|
||||
# Mobile performance indicators
|
||||
avg_mobile_position = keywords_df['position'].mean() # In real implementation, this would be mobile-specific
|
||||
technical_insights['mobile_performance'] = {
|
||||
'avg_mobile_position': round(avg_mobile_position, 1),
|
||||
'mobile_optimization_needed': avg_mobile_position > 15
|
||||
}
|
||||
|
||||
return technical_insights
|
||||
|
||||
def _analyze_competitive_position(self, search_data: Dict[str, pd.DataFrame]) -> Dict[str, Any]:
|
||||
"""Analyze competitive positioning based on search data."""
|
||||
keywords_df = search_data['keywords']
|
||||
|
||||
# Calculate competitive metrics
|
||||
dominant_keywords = len(keywords_df[keywords_df['position'] <= 3])
|
||||
competitive_keywords = len(keywords_df[(keywords_df['position'] > 3) & (keywords_df['position'] <= 10)])
|
||||
losing_keywords = len(keywords_df[keywords_df['position'] > 10])
|
||||
|
||||
competitive_strength = (dominant_keywords * 3 + competitive_keywords * 2 + losing_keywords * 1) / len(keywords_df)
|
||||
|
||||
return {
|
||||
'dominant_keywords': dominant_keywords,
|
||||
'competitive_keywords': competitive_keywords,
|
||||
'losing_keywords': losing_keywords,
|
||||
'competitive_strength_score': round(competitive_strength, 2),
|
||||
'market_position': self._determine_market_position(competitive_strength)
|
||||
}
|
||||
|
||||
def _generate_ai_recommendations(self, search_data: Dict[str, pd.DataFrame]) -> Dict[str, Any]:
|
||||
"""Generate AI-powered recommendations based on search data."""
|
||||
try:
|
||||
keywords_df = search_data['keywords']
|
||||
pages_df = search_data['pages']
|
||||
|
||||
# Prepare data summary for AI analysis
|
||||
top_keywords = keywords_df.nlargest(5, 'impressions')['keyword'].tolist()
|
||||
avg_position = keywords_df['position'].mean()
|
||||
total_impressions = keywords_df['impressions'].sum()
|
||||
total_clicks = keywords_df['clicks'].sum()
|
||||
avg_ctr = (total_clicks / total_impressions * 100) if total_impressions > 0 else 0
|
||||
|
||||
# Create comprehensive prompt for AI analysis
|
||||
ai_prompt = f"""
|
||||
Analyze this Google Search Console data and provide strategic SEO recommendations:
|
||||
|
||||
SEARCH PERFORMANCE SUMMARY:
|
||||
- Total Keywords Tracked: {len(keywords_df)}
|
||||
- Total Impressions: {total_impressions:,}
|
||||
- Total Clicks: {total_clicks:,}
|
||||
- Average CTR: {avg_ctr:.2f}%
|
||||
- Average Position: {avg_position:.1f}
|
||||
|
||||
TOP PERFORMING KEYWORDS:
|
||||
{', '.join(top_keywords)}
|
||||
|
||||
PERFORMANCE DISTRIBUTION:
|
||||
- Keywords ranking 1-3: {len(keywords_df[keywords_df['position'] <= 3])}
|
||||
- Keywords ranking 4-10: {len(keywords_df[(keywords_df['position'] > 3) & (keywords_df['position'] <= 10)])}
|
||||
- Keywords ranking 11-20: {len(keywords_df[(keywords_df['position'] > 10) & (keywords_df['position'] <= 20)])}
|
||||
- Keywords ranking 21+: {len(keywords_df[keywords_df['position'] > 20])}
|
||||
|
||||
TOP PAGES BY TRAFFIC:
|
||||
{pages_df.nlargest(3, 'clicks')['page'].tolist()}
|
||||
|
||||
Based on this data, provide:
|
||||
|
||||
1. IMMEDIATE OPTIMIZATION OPPORTUNITIES (0-30 days):
|
||||
- Specific keywords to optimize for better CTR
|
||||
- Pages that need content updates
|
||||
- Quick technical wins
|
||||
|
||||
2. CONTENT STRATEGY RECOMMENDATIONS (1-3 months):
|
||||
- New content topics based on keyword gaps
|
||||
- Content enhancement priorities
|
||||
- Internal linking opportunities
|
||||
|
||||
3. LONG-TERM SEO STRATEGY (3-12 months):
|
||||
- Market expansion opportunities
|
||||
- Authority building topics
|
||||
- Competitive positioning strategies
|
||||
|
||||
4. TECHNICAL SEO PRIORITIES:
|
||||
- Performance issues affecting rankings
|
||||
- Mobile optimization needs
|
||||
- Core Web Vitals improvements
|
||||
|
||||
Provide specific, actionable recommendations with expected impact and priority levels.
|
||||
"""
|
||||
|
||||
ai_analysis = llm_text_gen(
|
||||
ai_prompt,
|
||||
system_prompt="You are an enterprise SEO strategist analyzing Google Search Console data. Provide specific, data-driven recommendations that will improve search performance."
|
||||
)
|
||||
|
||||
return {
|
||||
'full_analysis': ai_analysis,
|
||||
'immediate_opportunities': self._extract_immediate_opportunities(ai_analysis),
|
||||
'content_strategy': self._extract_content_strategy(ai_analysis),
|
||||
'long_term_strategy': self._extract_long_term_strategy(ai_analysis),
|
||||
'technical_priorities': self._extract_technical_priorities(ai_analysis)
|
||||
}
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"AI recommendations error: {str(e)}")
|
||||
return {'error': str(e)}
|
||||
|
||||
# Utility methods
|
||||
def _identify_missing_keywords(self, keywords_df: pd.DataFrame) -> List[str]:
|
||||
"""Identify potential missing keywords based on current keyword performance."""
|
||||
# In a real implementation, this would use keyword research APIs
|
||||
existing_keywords = set(keywords_df['keyword'].str.lower())
|
||||
|
||||
potential_keywords = [
|
||||
"AI writing tools", "content automation", "SEO content generator",
|
||||
"blog post optimizer", "meta tag generator", "keyword analyzer"
|
||||
]
|
||||
|
||||
missing = [kw for kw in potential_keywords if kw.lower() not in existing_keywords]
|
||||
return missing[:5]
|
||||
|
||||
def _analyze_seasonal_trends(self, keywords_df: pd.DataFrame) -> Dict[str, Any]:
|
||||
"""Analyze seasonal trends in keyword performance."""
|
||||
# Placeholder for seasonal analysis
|
||||
return {
|
||||
'seasonal_keywords': [],
|
||||
'trend_analysis': "Seasonal analysis requires historical data spanning multiple seasons"
|
||||
}
|
||||
|
||||
def _categorize_pages(self, pages_df: pd.DataFrame) -> Dict[str, Any]:
|
||||
"""Categorize pages by type and analyze performance."""
|
||||
page_types = {
|
||||
'Blog Posts': {'count': 0, 'total_clicks': 0, 'avg_position': 0},
|
||||
'Product Pages': {'count': 0, 'total_clicks': 0, 'avg_position': 0},
|
||||
'Tool Pages': {'count': 0, 'total_clicks': 0, 'avg_position': 0},
|
||||
'Other': {'count': 0, 'total_clicks': 0, 'avg_position': 0}
|
||||
}
|
||||
|
||||
for _, page_row in pages_df.iterrows():
|
||||
page_url = page_row['page']
|
||||
clicks = page_row['clicks']
|
||||
position = page_row['position']
|
||||
|
||||
if '/blog/' in page_url:
|
||||
page_types['Blog Posts']['count'] += 1
|
||||
page_types['Blog Posts']['total_clicks'] += clicks
|
||||
page_types['Blog Posts']['avg_position'] += position
|
||||
elif '/tools/' in page_url:
|
||||
page_types['Tool Pages']['count'] += 1
|
||||
page_types['Tool Pages']['total_clicks'] += clicks
|
||||
page_types['Tool Pages']['avg_position'] += position
|
||||
elif '/features/' in page_url or '/product/' in page_url:
|
||||
page_types['Product Pages']['count'] += 1
|
||||
page_types['Product Pages']['total_clicks'] += clicks
|
||||
page_types['Product Pages']['avg_position'] += position
|
||||
else:
|
||||
page_types['Other']['count'] += 1
|
||||
page_types['Other']['total_clicks'] += clicks
|
||||
page_types['Other']['avg_position'] += position
|
||||
|
||||
# Calculate averages
|
||||
for page_type in page_types:
|
||||
if page_types[page_type]['count'] > 0:
|
||||
page_types[page_type]['avg_position'] = round(
|
||||
page_types[page_type]['avg_position'] / page_types[page_type]['count'], 1
|
||||
)
|
||||
|
||||
return page_types
|
||||
|
||||
def _determine_market_position(self, competitive_strength: float) -> str:
|
||||
"""Determine market position based on competitive strength score."""
|
||||
if competitive_strength >= 2.5:
|
||||
return "Market Leader"
|
||||
elif competitive_strength >= 2.0:
|
||||
return "Strong Competitor"
|
||||
elif competitive_strength >= 1.5:
|
||||
return "Emerging Player"
|
||||
else:
|
||||
return "Challenger"
|
||||
|
||||
def _extract_immediate_opportunities(self, analysis: str) -> List[str]:
|
||||
"""Extract immediate opportunities from AI analysis."""
|
||||
lines = analysis.split('\n')
|
||||
opportunities = []
|
||||
in_immediate_section = False
|
||||
|
||||
for line in lines:
|
||||
if 'IMMEDIATE OPTIMIZATION' in line.upper():
|
||||
in_immediate_section = True
|
||||
continue
|
||||
elif 'CONTENT STRATEGY' in line.upper():
|
||||
in_immediate_section = False
|
||||
continue
|
||||
|
||||
if in_immediate_section and line.strip().startswith('-'):
|
||||
opportunities.append(line.strip().lstrip('- '))
|
||||
|
||||
return opportunities[:5]
|
||||
|
||||
def _extract_content_strategy(self, analysis: str) -> List[str]:
|
||||
"""Extract content strategy recommendations from AI analysis."""
|
||||
return ["Develop topic clusters", "Create comparison content", "Build FAQ sections"]
|
||||
|
||||
def _extract_long_term_strategy(self, analysis: str) -> List[str]:
|
||||
"""Extract long-term strategy from AI analysis."""
|
||||
return ["Build domain authority", "Expand to new markets", "Develop thought leadership content"]
|
||||
|
||||
def _extract_technical_priorities(self, analysis: str) -> List[str]:
|
||||
"""Extract technical priorities from AI analysis."""
|
||||
return ["Improve page speed", "Optimize mobile experience", "Fix crawl errors"]
|
||||
|
||||
|
||||
def render_gsc_integration():
|
||||
"""Render the Google Search Console integration interface."""
|
||||
|
||||
st.title("📊 Google Search Console Intelligence")
|
||||
st.markdown("**AI-powered insights from your Google Search Console data**")
|
||||
|
||||
# Initialize analyzer
|
||||
if 'gsc_analyzer' not in st.session_state:
|
||||
st.session_state.gsc_analyzer = GoogleSearchConsoleAnalyzer()
|
||||
|
||||
analyzer = st.session_state.gsc_analyzer
|
||||
|
||||
# Configuration section
|
||||
st.header("🔧 Configuration")
|
||||
|
||||
with st.expander("📋 Setup Instructions", expanded=False):
|
||||
st.markdown("""
|
||||
### Setting up Google Search Console Integration
|
||||
|
||||
1. **Verify your website** in Google Search Console
|
||||
2. **Enable the Search Console API** in Google Cloud Console
|
||||
3. **Create service account credentials** and download the JSON file
|
||||
4. **Upload credentials** using the file uploader below
|
||||
|
||||
📚 [Detailed Setup Guide](https://developers.google.com/webmaster-tools/search-console-api-original/v3/prereqs)
|
||||
""")
|
||||
|
||||
# Input form
|
||||
with st.form("gsc_analysis_form"):
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
site_url = st.text_input(
|
||||
"Site URL",
|
||||
value="https://example.com",
|
||||
help="Enter your website URL as registered in Google Search Console"
|
||||
)
|
||||
|
||||
date_range = st.selectbox(
|
||||
"Analysis Period",
|
||||
[30, 60, 90, 180],
|
||||
index=2,
|
||||
help="Number of days to analyze"
|
||||
)
|
||||
|
||||
with col2:
|
||||
# Credentials upload (placeholder)
|
||||
credentials_file = st.file_uploader(
|
||||
"GSC API Credentials (JSON)",
|
||||
type=['json'],
|
||||
help="Upload your Google Search Console API credentials file"
|
||||
)
|
||||
|
||||
demo_mode = st.checkbox(
|
||||
"Demo Mode",
|
||||
value=True,
|
||||
help="Use demo data for testing (no credentials needed)"
|
||||
)
|
||||
|
||||
submit_analysis = st.form_submit_button("📊 Analyze Search Performance", type="primary")
|
||||
|
||||
# Process analysis
|
||||
if submit_analysis:
|
||||
if site_url and (demo_mode or credentials_file):
|
||||
with st.spinner("📊 Analyzing Google Search Console data..."):
|
||||
analysis_results = analyzer.analyze_search_performance(site_url, date_range)
|
||||
|
||||
if 'error' not in analysis_results:
|
||||
st.success("✅ Search Console analysis completed!")
|
||||
|
||||
# Store results in session state
|
||||
st.session_state.gsc_results = analysis_results
|
||||
|
||||
# Display results
|
||||
render_gsc_results_dashboard(analysis_results)
|
||||
else:
|
||||
st.error(f"❌ Analysis failed: {analysis_results['error']}")
|
||||
else:
|
||||
st.warning("⚠️ Please enter site URL and upload credentials (or enable demo mode).")
|
||||
|
||||
# Show previous results if available
|
||||
elif 'gsc_results' in st.session_state:
|
||||
st.info("📊 Showing previous analysis results")
|
||||
render_gsc_results_dashboard(st.session_state.gsc_results)
|
||||
|
||||
|
||||
def render_gsc_results_dashboard(results: Dict[str, Any]):
|
||||
"""Render comprehensive GSC analysis results."""
|
||||
|
||||
# Performance overview
|
||||
st.header("📊 Search Performance Overview")
|
||||
|
||||
overview = results['performance_overview']
|
||||
|
||||
col1, col2, col3, col4 = st.columns(4)
|
||||
|
||||
with col1:
|
||||
st.metric(
|
||||
"Total Clicks",
|
||||
f"{overview['total_clicks']:,}",
|
||||
delta=f"{overview['clicks_trend']:+.1f}%" if overview['clicks_trend'] != 0 else None
|
||||
)
|
||||
|
||||
with col2:
|
||||
st.metric(
|
||||
"Total Impressions",
|
||||
f"{overview['total_impressions']:,}",
|
||||
delta=f"{overview['impressions_trend']:+.1f}%" if overview['impressions_trend'] != 0 else None
|
||||
)
|
||||
|
||||
with col3:
|
||||
st.metric(
|
||||
"Average CTR",
|
||||
f"{overview['avg_ctr']:.2f}%"
|
||||
)
|
||||
|
||||
with col4:
|
||||
st.metric(
|
||||
"Average Position",
|
||||
f"{overview['avg_position']:.1f}"
|
||||
)
|
||||
|
||||
# Content opportunities (Most important section)
|
||||
st.header("🎯 Content Opportunities")
|
||||
|
||||
opportunities = results['content_opportunities']
|
||||
if opportunities:
|
||||
# Display as interactive table
|
||||
df_opportunities = pd.DataFrame(opportunities)
|
||||
|
||||
st.dataframe(
|
||||
df_opportunities,
|
||||
column_config={
|
||||
"type": "Opportunity Type",
|
||||
"keyword": "Keyword",
|
||||
"opportunity": "Description",
|
||||
"potential_impact": st.column_config.SelectboxColumn(
|
||||
"Impact",
|
||||
options=["High", "Medium", "Low"]
|
||||
),
|
||||
"current_position": st.column_config.NumberColumn(
|
||||
"Current Position",
|
||||
format="%.1f"
|
||||
),
|
||||
"impressions": st.column_config.NumberColumn(
|
||||
"Impressions",
|
||||
format="%d"
|
||||
),
|
||||
"priority": st.column_config.SelectboxColumn(
|
||||
"Priority",
|
||||
options=["High", "Medium", "Low"]
|
||||
)
|
||||
},
|
||||
hide_index=True,
|
||||
use_container_width=True
|
||||
)
|
||||
|
||||
# Detailed analysis tabs
|
||||
tab1, tab2, tab3, tab4, tab5 = st.tabs([
|
||||
"🤖 AI Insights",
|
||||
"🎯 Keyword Analysis",
|
||||
"📄 Page Performance",
|
||||
"🏆 Competitive Position",
|
||||
"🔧 Technical Signals"
|
||||
])
|
||||
|
||||
with tab1:
|
||||
ai_recs = results.get('ai_recommendations', {})
|
||||
if ai_recs and 'error' not in ai_recs:
|
||||
st.subheader("AI-Powered Recommendations")
|
||||
|
||||
# Immediate opportunities
|
||||
immediate_ops = ai_recs.get('immediate_opportunities', [])
|
||||
if immediate_ops:
|
||||
st.markdown("#### 🚀 Immediate Optimizations (0-30 days)")
|
||||
for op in immediate_ops:
|
||||
st.success(f"✅ {op}")
|
||||
|
||||
# Content strategy
|
||||
content_strategy = ai_recs.get('content_strategy', [])
|
||||
if content_strategy:
|
||||
st.markdown("#### 📝 Content Strategy (1-3 months)")
|
||||
for strategy in content_strategy:
|
||||
st.info(f"📋 {strategy}")
|
||||
|
||||
# Full analysis
|
||||
full_analysis = ai_recs.get('full_analysis', '')
|
||||
if full_analysis:
|
||||
with st.expander("🧠 Complete AI Analysis"):
|
||||
st.write(full_analysis)
|
||||
|
||||
with tab2:
|
||||
keyword_analysis = results.get('keyword_analysis', {})
|
||||
if keyword_analysis:
|
||||
st.subheader("Keyword Performance Analysis")
|
||||
|
||||
# Keyword distribution chart
|
||||
dist = keyword_analysis['keyword_distribution']
|
||||
fig = px.pie(
|
||||
values=[dist['positions_1_3'], dist['positions_4_10'], dist['positions_11_20'], dist['positions_21_plus']],
|
||||
names=['Positions 1-3', 'Positions 4-10', 'Positions 11-20', 'Positions 21+'],
|
||||
title="Keyword Position Distribution"
|
||||
)
|
||||
st.plotly_chart(fig, use_container_width=True)
|
||||
|
||||
# High volume keywords
|
||||
high_volume = keyword_analysis.get('high_volume_keywords', [])
|
||||
if high_volume:
|
||||
st.markdown("#### 📈 High Volume Keywords")
|
||||
st.dataframe(pd.DataFrame(high_volume), hide_index=True)
|
||||
|
||||
# Optimization opportunities
|
||||
opt_opportunities = keyword_analysis.get('optimization_opportunities', [])
|
||||
if opt_opportunities:
|
||||
st.markdown("#### 🎯 Optimization Opportunities (Positions 11-20)")
|
||||
st.dataframe(pd.DataFrame(opt_opportunities), hide_index=True)
|
||||
|
||||
with tab3:
|
||||
page_analysis = results.get('page_analysis', {})
|
||||
if page_analysis:
|
||||
st.subheader("Page Performance Analysis")
|
||||
|
||||
# Top pages
|
||||
top_pages = page_analysis.get('top_pages', [])
|
||||
if top_pages:
|
||||
st.markdown("#### 🏆 Top Performing Pages")
|
||||
st.dataframe(pd.DataFrame(top_pages), hide_index=True)
|
||||
|
||||
# Underperforming pages
|
||||
underperforming = page_analysis.get('underperforming_pages', [])
|
||||
if underperforming:
|
||||
st.markdown("#### ⚠️ Underperforming Pages (High Impressions, Low CTR)")
|
||||
st.dataframe(pd.DataFrame(underperforming), hide_index=True)
|
||||
|
||||
# Page types performance
|
||||
page_types = page_analysis.get('page_types_performance', {})
|
||||
if page_types:
|
||||
st.markdown("#### 📊 Performance by Page Type")
|
||||
|
||||
# Create visualization
|
||||
types = []
|
||||
clicks = []
|
||||
positions = []
|
||||
|
||||
for page_type, data in page_types.items():
|
||||
if data['count'] > 0:
|
||||
types.append(page_type)
|
||||
clicks.append(data['total_clicks'])
|
||||
positions.append(data['avg_position'])
|
||||
|
||||
if types:
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
fig_clicks = px.bar(x=types, y=clicks, title="Total Clicks by Page Type")
|
||||
st.plotly_chart(fig_clicks, use_container_width=True)
|
||||
|
||||
with col2:
|
||||
fig_position = px.bar(x=types, y=positions, title="Average Position by Page Type")
|
||||
st.plotly_chart(fig_position, use_container_width=True)
|
||||
|
||||
with tab4:
|
||||
competitive_analysis = results.get('competitive_analysis', {})
|
||||
if competitive_analysis:
|
||||
st.subheader("Competitive Position Analysis")
|
||||
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
st.metric("Market Position", competitive_analysis['market_position'])
|
||||
st.metric("Competitive Strength", f"{competitive_analysis['competitive_strength_score']}/3.0")
|
||||
|
||||
with col2:
|
||||
# Competitive distribution
|
||||
comp_data = {
|
||||
'Dominant (1-3)': competitive_analysis['dominant_keywords'],
|
||||
'Competitive (4-10)': competitive_analysis['competitive_keywords'],
|
||||
'Losing (11+)': competitive_analysis['losing_keywords']
|
||||
}
|
||||
|
||||
fig = px.bar(
|
||||
x=list(comp_data.keys()),
|
||||
y=list(comp_data.values()),
|
||||
title="Keyword Competitive Position"
|
||||
)
|
||||
st.plotly_chart(fig, use_container_width=True)
|
||||
|
||||
with tab5:
|
||||
technical_insights = results.get('technical_insights', {})
|
||||
if technical_insights:
|
||||
st.subheader("Technical SEO Signals")
|
||||
|
||||
# Crawl issues indicators
|
||||
crawl_issues = technical_insights.get('crawl_issues_indicators', [])
|
||||
if crawl_issues:
|
||||
st.markdown("#### ⚠️ Potential Issues")
|
||||
for issue in crawl_issues:
|
||||
st.warning(f"🚨 {issue}")
|
||||
|
||||
# Mobile performance
|
||||
mobile_perf = technical_insights.get('mobile_performance', {})
|
||||
if mobile_perf:
|
||||
st.markdown("#### 📱 Mobile Performance")
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
st.metric("Avg Mobile Position", f"{mobile_perf.get('avg_mobile_position', 0):.1f}")
|
||||
|
||||
with col2:
|
||||
if mobile_perf.get('mobile_optimization_needed', False):
|
||||
st.warning("📱 Mobile optimization needed")
|
||||
else:
|
||||
st.success("📱 Mobile performance good")
|
||||
|
||||
# Export functionality
|
||||
st.markdown("---")
|
||||
col1, col2, col3 = st.columns(3)
|
||||
|
||||
with col1:
|
||||
if st.button("📥 Export Full Report", use_container_width=True):
|
||||
report_json = json.dumps(results, indent=2, default=str)
|
||||
st.download_button(
|
||||
label="Download JSON Report",
|
||||
data=report_json,
|
||||
file_name=f"gsc_analysis_{datetime.now().strftime('%Y%m%d_%H%M%S')}.json",
|
||||
mime="application/json"
|
||||
)
|
||||
|
||||
with col2:
|
||||
if st.button("📊 Export Opportunities", use_container_width=True):
|
||||
if opportunities:
|
||||
df_opportunities = pd.DataFrame(opportunities)
|
||||
csv = df_opportunities.to_csv(index=False)
|
||||
st.download_button(
|
||||
label="Download CSV Opportunities",
|
||||
data=csv,
|
||||
file_name=f"content_opportunities_{datetime.now().strftime('%Y%m%d_%H%M%S')}.csv",
|
||||
mime="text/csv"
|
||||
)
|
||||
|
||||
with col3:
|
||||
if st.button("🔄 Refresh Analysis", use_container_width=True):
|
||||
# Clear cached results to force refresh
|
||||
if 'gsc_results' in st.session_state:
|
||||
del st.session_state.gsc_results
|
||||
st.rerun()
|
||||
|
||||
|
||||
# Main execution
|
||||
if __name__ == "__main__":
|
||||
render_gsc_integration()
|
||||
112
ToBeMigrated/ai_seo_tools/image_alt_text_generator.py
Normal file
112
ToBeMigrated/ai_seo_tools/image_alt_text_generator.py
Normal file
@@ -0,0 +1,112 @@
|
||||
import streamlit as st
|
||||
import base64
|
||||
import requests
|
||||
from PIL import Image
|
||||
import os
|
||||
|
||||
|
||||
def encode_image(image_path):
|
||||
"""
|
||||
Encodes an image to base64 format.
|
||||
|
||||
Args:
|
||||
image_path (str): Path to the image file.
|
||||
|
||||
Returns:
|
||||
str: Base64 encoded string of the image.
|
||||
|
||||
Raises:
|
||||
ValueError: If the image path is invalid.
|
||||
"""
|
||||
safe_root = os.getenv('SAFE_ROOT_DIRECTORY', '/safe/root/directory') # Use an environment variable for the safe root directory
|
||||
normalized_path = os.path.normpath(image_path)
|
||||
if not normalized_path.startswith(safe_root):
|
||||
raise ValueError("Invalid image path")
|
||||
with open(normalized_path, "rb") as image_file:
|
||||
return base64.b64encode(image_file.read()).decode('utf-8')
|
||||
|
||||
|
||||
def get_image_description(image_path):
|
||||
"""
|
||||
Generates a description for the given image using an external API.
|
||||
|
||||
Args:
|
||||
image_path (str): Path to the image file.
|
||||
|
||||
Returns:
|
||||
str: Description of the image.
|
||||
|
||||
Raises:
|
||||
ValueError: If the image path is invalid.
|
||||
"""
|
||||
safe_root = os.getenv('SAFE_ROOT_DIRECTORY', '/safe/root/directory') # Use an environment variable for the safe root directory
|
||||
normalized_path = os.path.normpath(image_path)
|
||||
if not normalized_path.startswith(safe_root):
|
||||
raise ValueError("Invalid image path")
|
||||
base64_image = encode_image(normalized_path)
|
||||
|
||||
headers = {
|
||||
"Content-Type": "application/json",
|
||||
"Authorization": f"Bearer {os.getenv('OPENAI_API_KEY')}"
|
||||
}
|
||||
|
||||
payload = {
|
||||
"model": "gpt-4o-mini",
|
||||
"messages": [
|
||||
{
|
||||
"role": "user",
|
||||
"content": [
|
||||
{
|
||||
"type": "text",
|
||||
"text": """You are an SEO expert specializing in writing optimized Alt text for images.
|
||||
Your goal is to create clear, descriptive, and concise Alt text that accurately represents
|
||||
the content and context of the given image. Make sure your response is optimized for search engines and accessibility."""
|
||||
},
|
||||
{
|
||||
"type": "image_url",
|
||||
"image_url": {
|
||||
"url": f"data:image/jpeg;base64,{base64_image}"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"max_tokens": 300
|
||||
}
|
||||
|
||||
response = requests.post("https://api.openai.com/v1/chat/completions", headers=headers, json=payload)
|
||||
response_data = response.json()
|
||||
|
||||
# Extract the content field from the response
|
||||
content = response_data['choices'][0]['message']['content']
|
||||
return content
|
||||
|
||||
|
||||
def alt_text_gen():
|
||||
"""
|
||||
Streamlit app function to generate Alt text for an uploaded image.
|
||||
"""
|
||||
st.title("Image Description Generator")
|
||||
|
||||
image_path = st.text_input("Enter the full path of the image file", help="Provide the full path to a .jpg, .jpeg, or .png image file")
|
||||
|
||||
if image_path:
|
||||
if os.path.exists(image_path) and image_path.lower().endswith(('jpg', 'jpeg', 'png')):
|
||||
try:
|
||||
image = Image.open(image_path)
|
||||
st.image(image, caption='Uploaded Image', use_column_width=True)
|
||||
|
||||
if st.button("Get Image Alt Text"):
|
||||
with st.spinner("Generating Alt Text..."):
|
||||
try:
|
||||
description = get_image_description(image_path)
|
||||
st.success("Alt Text generated successfully!")
|
||||
st.write("Alt Text:", description)
|
||||
except Exception as e:
|
||||
st.error(f"Error generating description: {e}")
|
||||
except Exception as e:
|
||||
st.error(f"Error processing image: {e}")
|
||||
else:
|
||||
st.error("Please enter a valid image file path ending with .jpg, .jpeg, or .png")
|
||||
else:
|
||||
st.info("Please enter the full path of an image file.")
|
||||
110
ToBeMigrated/ai_seo_tools/meta_desc_generator.py
Normal file
110
ToBeMigrated/ai_seo_tools/meta_desc_generator.py
Normal file
@@ -0,0 +1,110 @@
|
||||
import os
|
||||
import json
|
||||
import streamlit as st
|
||||
from tenacity import retry, stop_after_attempt, wait_random_exponential
|
||||
from loguru import logger
|
||||
import sys
|
||||
|
||||
from ..gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
|
||||
|
||||
def metadesc_generator_main():
|
||||
"""
|
||||
Streamlit app for generating SEO-optimized blog meta descriptions.
|
||||
"""
|
||||
st.title("✍️ Alwrity - AI Blog Meta Description Generator")
|
||||
st.markdown(
|
||||
"Create compelling, SEO-optimized meta descriptions in just a few clicks. Perfect for enhancing your blog's click-through rates!"
|
||||
)
|
||||
|
||||
# Input section
|
||||
with st.expander("**PRO-TIP** - Read the instructions below. 🚀", expanded=True):
|
||||
col1, col2, _ = st.columns([5, 5, 0.5])
|
||||
|
||||
# Column 1: Keywords and Tone
|
||||
with col1:
|
||||
keywords = st.text_input(
|
||||
"🔑 Target Keywords (comma-separated):",
|
||||
placeholder="e.g., content marketing, SEO, social media, online business",
|
||||
help="Enter your target keywords, separated by commas. 📝",
|
||||
)
|
||||
|
||||
tone_options = ["General", "Informative", "Engaging", "Humorous", "Intriguing", "Playful"]
|
||||
tone = st.selectbox(
|
||||
"🎨 Desired Tone (optional):",
|
||||
options=tone_options,
|
||||
help="Choose the overall tone you want for your meta description. 🎭",
|
||||
)
|
||||
|
||||
# Column 2: Search Intent and Language
|
||||
with col2:
|
||||
search_type = st.selectbox(
|
||||
"🔍 Search Intent:",
|
||||
("Informational Intent", "Commercial Intent", "Transactional Intent", "Navigational Intent"),
|
||||
index=0,
|
||||
)
|
||||
|
||||
language_options = ["English", "Spanish", "French", "German", "Other"]
|
||||
language_choice = st.selectbox(
|
||||
"🌐 Preferred Language:",
|
||||
options=language_options,
|
||||
help="Select the language for your meta description. 🗣️",
|
||||
)
|
||||
|
||||
language = (
|
||||
st.text_input(
|
||||
"Specify Other Language:",
|
||||
placeholder="e.g., Italian, Chinese",
|
||||
help="Enter your preferred language. 🌍",
|
||||
)
|
||||
if language_choice == "Other"
|
||||
else language_choice
|
||||
)
|
||||
|
||||
# Generate Meta Description button
|
||||
if st.button("**✨ Generate Meta Description ✨**"):
|
||||
if not keywords.strip():
|
||||
st.error("**🫣 Target Keywords are required! Please provide at least one keyword.**")
|
||||
return
|
||||
|
||||
with st.spinner("Crafting your Meta descriptions... ⏳"):
|
||||
blog_metadesc = generate_blog_metadesc(keywords, tone, search_type, language)
|
||||
if blog_metadesc:
|
||||
st.success("**🎉 Meta Descriptions Generated Successfully! 🚀**")
|
||||
with st.expander("**Your SEO-Boosting Blog Meta Descriptions 🎆🎇**", expanded=True):
|
||||
st.markdown(blog_metadesc)
|
||||
else:
|
||||
st.error("💥 **Failed to generate blog meta description. Please try again!**")
|
||||
|
||||
|
||||
def generate_blog_metadesc(keywords, tone, search_type, language):
|
||||
"""
|
||||
Generate blog meta descriptions using LLM.
|
||||
|
||||
Args:
|
||||
keywords (str): Comma-separated target keywords.
|
||||
tone (str): Desired tone for the meta description.
|
||||
search_type (str): Search intent type.
|
||||
language (str): Preferred language for the description.
|
||||
|
||||
Returns:
|
||||
str: Generated meta descriptions or error message.
|
||||
"""
|
||||
prompt = f"""
|
||||
Craft 3 engaging and SEO-friendly meta descriptions for a blog post based on the following details:
|
||||
|
||||
Blog Post Keywords: {keywords}
|
||||
Search Intent Type: {search_type}
|
||||
Desired Tone: {tone}
|
||||
Preferred Language: {language}
|
||||
|
||||
Output Format:
|
||||
|
||||
Respond with 3 compelling and concise meta descriptions, approximately 155-160 characters long, that incorporate the target keywords, reflect the blog post content, resonate with the target audience, and entice users to click through to read the full article.
|
||||
"""
|
||||
try:
|
||||
return llm_text_gen(prompt)
|
||||
except Exception as err:
|
||||
logger.error(f"Error generating meta description: {err}")
|
||||
st.error(f"💥 Error: Failed to generate response from LLM: {err}")
|
||||
return None
|
||||
1070
ToBeMigrated/ai_seo_tools/on_page_seo_analyzer.py
Normal file
1070
ToBeMigrated/ai_seo_tools/on_page_seo_analyzer.py
Normal file
File diff suppressed because it is too large
Load Diff
129
ToBeMigrated/ai_seo_tools/opengraph_generator.py
Normal file
129
ToBeMigrated/ai_seo_tools/opengraph_generator.py
Normal file
@@ -0,0 +1,129 @@
|
||||
import streamlit as st
|
||||
import requests
|
||||
from bs4 import BeautifulSoup
|
||||
from ..gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
|
||||
|
||||
def generate_og_tags(url, title_hint, description_hint, platform="General"):
|
||||
"""
|
||||
Generate Open Graph tags based on the provided URL, title hint, description hint, and platform.
|
||||
|
||||
Args:
|
||||
url (str): The URL of the webpage.
|
||||
title_hint (str): A hint for the title.
|
||||
description_hint (str): A hint for the description.
|
||||
platform (str): The platform for which to generate the tags (General, Facebook, or Twitter).
|
||||
|
||||
Returns:
|
||||
str: The generated Open Graph tags or an error message.
|
||||
"""
|
||||
# Create a prompt for the text generation model
|
||||
prompt = (
|
||||
f"Generate Open Graph tags for the following page:\nURL: {url}\n"
|
||||
f"Title hint: {title_hint}\nDescription hint: {description_hint}"
|
||||
)
|
||||
if platform == "Facebook":
|
||||
prompt += "\nSpecifically for Facebook"
|
||||
elif platform == "Twitter":
|
||||
prompt += "\nSpecifically for Twitter"
|
||||
|
||||
try:
|
||||
# Generate Open Graph tags using the text generation model
|
||||
response = llm_text_gen(prompt)
|
||||
return response
|
||||
except Exception as err:
|
||||
st.error(f"Failed to generate Open Graph tags: {err}")
|
||||
return None
|
||||
|
||||
|
||||
def extract_default_og_tags(url):
|
||||
"""
|
||||
Extract default Open Graph tags from the provided URL.
|
||||
|
||||
Args:
|
||||
url (str): The URL of the webpage.
|
||||
|
||||
Returns:
|
||||
tuple: A tuple containing the title, description, and image URL, or None in case of an error.
|
||||
"""
|
||||
try:
|
||||
# Fetch the HTML content of the URL
|
||||
response = requests.get(url)
|
||||
response.raise_for_status()
|
||||
|
||||
# Parse the HTML content using BeautifulSoup
|
||||
soup = BeautifulSoup(response.content, 'html.parser')
|
||||
|
||||
# Extract the title, description, and image URL
|
||||
title = soup.find('title').text if soup.find('title') else None
|
||||
description = soup.find('meta', attrs={'name': 'description'})['content'] if soup.find('meta', attrs={'name': 'description'}) else None
|
||||
image_url = soup.find('meta', attrs={'property': 'og:image'})['content'] if soup.find('meta', attrs={'property': 'og:image'}) else None
|
||||
|
||||
return title, description, image_url
|
||||
|
||||
except requests.exceptions.RequestException as req_err:
|
||||
st.error(f"Error fetching the URL: {req_err}")
|
||||
return None, None, None
|
||||
|
||||
except Exception as err:
|
||||
st.error(f"Error parsing the HTML content: {err}")
|
||||
return None, None, None
|
||||
|
||||
|
||||
def og_tag_generator():
|
||||
"""Main function to run the Streamlit app."""
|
||||
st.title("AI Open Graph Tag Generator")
|
||||
|
||||
# Platform selection
|
||||
platform = st.selectbox(
|
||||
"**Select the platform**",
|
||||
["General", "Facebook", "Twitter"],
|
||||
help="Choose the platform for which you want to generate Open Graph tags."
|
||||
)
|
||||
|
||||
# URL input
|
||||
url = st.text_input(
|
||||
"**Enter the URL of the page to generate Open Graph tags for:**",
|
||||
placeholder="e.g., https://example.com",
|
||||
help="Provide the URL of the page you want to generate Open Graph tags for."
|
||||
)
|
||||
|
||||
if url:
|
||||
# Extract default Open Graph tags
|
||||
title, description, image_url = extract_default_og_tags(url)
|
||||
|
||||
# Title hint input
|
||||
title_hint = st.text_input(
|
||||
"**Modify existing title or suggest a new one (optional):**",
|
||||
value=title if title else "",
|
||||
placeholder="e.g., Amazing Blog Post Title"
|
||||
)
|
||||
|
||||
# Description hint input
|
||||
description_hint = st.text_area(
|
||||
"**Modify existing description or suggest a new one (optional):**",
|
||||
value=description if description else "",
|
||||
placeholder="e.g., This is a detailed description of the content."
|
||||
)
|
||||
|
||||
# Image URL hint input
|
||||
image_hint = st.text_input(
|
||||
"**Use this image or suggest a new URL (optional):**",
|
||||
value=image_url if image_url else "",
|
||||
placeholder="e.g., https://example.com/image.jpg"
|
||||
)
|
||||
|
||||
# Generate Open Graph tags
|
||||
if st.button("Generate Open Graph Tags"):
|
||||
with st.spinner("Generating Open Graph tags..."):
|
||||
try:
|
||||
og_tags = generate_og_tags(url, title_hint, description_hint, platform)
|
||||
if og_tags:
|
||||
st.success("Open Graph tags generated successfully!")
|
||||
st.markdown(og_tags)
|
||||
else:
|
||||
st.error("Failed to generate Open Graph tags.")
|
||||
except Exception as e:
|
||||
st.error(f"Failed to generate Open Graph tags: {e}")
|
||||
else:
|
||||
st.info("Please enter a URL to generate Open Graph tags.")
|
||||
2
ToBeMigrated/ai_seo_tools/opengraph_image_generate.py
Normal file
2
ToBeMigrated/ai_seo_tools/opengraph_image_generate.py
Normal file
@@ -0,0 +1,2 @@
|
||||
|
||||
ogImage TBD
|
||||
187
ToBeMigrated/ai_seo_tools/optimize_images_for_upload.py
Normal file
187
ToBeMigrated/ai_seo_tools/optimize_images_for_upload.py
Normal file
@@ -0,0 +1,187 @@
|
||||
import os
|
||||
import sys
|
||||
import tinify
|
||||
from PIL import Image
|
||||
from loguru import logger
|
||||
from dotenv import load_dotenv
|
||||
import streamlit as st
|
||||
from tempfile import NamedTemporaryFile
|
||||
|
||||
# Load environment variables
|
||||
load_dotenv()
|
||||
|
||||
# Set Tinyfy API key from environment variable
|
||||
TINIFY_API_KEY = os.getenv('TINIFY_API_KEY')
|
||||
if TINIFY_API_KEY:
|
||||
tinify.key = TINIFY_API_KEY
|
||||
|
||||
def setup_logger() -> None:
|
||||
"""Configure the logger."""
|
||||
logger.remove()
|
||||
logger.add(
|
||||
sys.stdout,
|
||||
colorize=True,
|
||||
format="<level>{level}</level>|<green>{file}:{line}:{function}</green>| {message}"
|
||||
)
|
||||
|
||||
setup_logger()
|
||||
|
||||
def compress_image(image: Image.Image, quality: int = 45, resize: tuple = None, preserve_exif: bool = False) -> Image.Image:
|
||||
"""
|
||||
Compress and optionally resize an image.
|
||||
|
||||
Args:
|
||||
image (PIL.Image): Image object to compress.
|
||||
quality (int): Quality of the output image (1-100).
|
||||
resize (tuple): Tuple (width, height) to resize the image.
|
||||
preserve_exif (bool): Preserve EXIF data if True.
|
||||
|
||||
Returns:
|
||||
PIL.Image: The compressed and resized image object.
|
||||
"""
|
||||
try:
|
||||
if image.mode == 'RGBA':
|
||||
logger.info("Converting RGBA image to RGB.")
|
||||
image = image.convert('RGB')
|
||||
|
||||
exif = image.info.get('exif') if preserve_exif and 'exif' in image.info else None
|
||||
|
||||
if resize:
|
||||
image = image.resize(resize, Image.LANCZOS)
|
||||
logger.info(f"Resized image to {resize}")
|
||||
|
||||
with NamedTemporaryFile(delete=False, suffix=".jpg") as temp_file:
|
||||
temp_path = temp_file.name
|
||||
try:
|
||||
image.save(temp_path, optimize=True, quality=quality, exif=exif)
|
||||
except Exception as exif_error:
|
||||
logger.warning(f"Error saving image with EXIF: {exif_error}. Saving without EXIF.")
|
||||
image.save(temp_path, optimize=True, quality=quality)
|
||||
|
||||
logger.info("Image compression successful.")
|
||||
return Image.open(temp_path)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Error compressing image: {e}")
|
||||
st.error("Failed to compress the image. Please try again.")
|
||||
return None
|
||||
|
||||
def convert_to_webp(image: Image.Image, image_path: str) -> str:
|
||||
"""
|
||||
Convert an image to WebP format.
|
||||
|
||||
Args:
|
||||
image (PIL.Image): Image object to convert.
|
||||
image_path (str): Path to save the WebP image.
|
||||
|
||||
Returns:
|
||||
str: Path to the WebP image.
|
||||
"""
|
||||
try:
|
||||
webp_path = os.path.splitext(image_path)[0] + '.webp'
|
||||
image.save(webp_path, 'WEBP', quality=80, method=6)
|
||||
return webp_path
|
||||
except Exception as e:
|
||||
logger.error(f"Error converting image to WebP: {e}")
|
||||
st.error("Failed to convert the image to WebP format. Please try again.")
|
||||
return None
|
||||
|
||||
def compress_image_tinyfy(image_path: str) -> None:
|
||||
"""
|
||||
Compress an image using Tinyfy API.
|
||||
|
||||
Args:
|
||||
image_path (str): Path to the image to be compressed.
|
||||
|
||||
Returns:
|
||||
None
|
||||
"""
|
||||
try:
|
||||
if not tinify.key:
|
||||
logger.warning("Tinyfy API key is not set. Skipping Tinyfy compression.")
|
||||
return
|
||||
|
||||
source = tinify.from_file(image_path)
|
||||
source.to_file(image_path)
|
||||
logger.info("Tinyfy compression successful.")
|
||||
except tinify.errors.AccountError:
|
||||
logger.error("Verify your Tinyfy API key and account limit.")
|
||||
st.warning("Tinyfy compression failed. Check your API key and account limit.")
|
||||
except Exception as e:
|
||||
logger.error(f"Error during Tinyfy compression: {e}")
|
||||
st.warning("Tinyfy compression failed. Ensure the API key is set.")
|
||||
|
||||
def optimize_image(image: Image.Image, image_path: str, quality: int, resize: tuple, preserve_exif: bool) -> str:
|
||||
"""
|
||||
Optimize the image by compressing and converting it to WebP, with optional Tinyfy compression.
|
||||
|
||||
Args:
|
||||
image (PIL.Image): The original image.
|
||||
image_path (str): The path to the image file.
|
||||
quality (int): Quality level for compression.
|
||||
resize (tuple): Dimensions to resize the image.
|
||||
preserve_exif (bool): Whether to preserve EXIF data.
|
||||
|
||||
Returns:
|
||||
str: Path to the optimized WebP image, or None if failed.
|
||||
"""
|
||||
logger.info("Starting image optimization process...")
|
||||
|
||||
compressed_image = compress_image(image, quality, resize, preserve_exif)
|
||||
if compressed_image is None:
|
||||
return None
|
||||
|
||||
webp_path = convert_to_webp(compressed_image, image_path)
|
||||
if webp_path is None:
|
||||
return None
|
||||
|
||||
if tinify.key:
|
||||
compress_image_tinyfy(webp_path)
|
||||
else:
|
||||
logger.info("Tinyfy key not provided, skipping Tinyfy compression.")
|
||||
|
||||
return webp_path
|
||||
|
||||
def main_img_optimizer() -> None:
|
||||
st.title("ALwrity Image Optimizer")
|
||||
st.markdown("## Upload an image to optimize its size and format.")
|
||||
|
||||
input_tinify_key = st.text_input("Optional: Enter your Tinyfy API Key")
|
||||
if input_tinify_key:
|
||||
tinify.key = input_tinify_key
|
||||
|
||||
uploaded_file = st.file_uploader("Upload an image", type=['jpg', 'jpeg', 'png', 'gif', 'bmp', 'webp'])
|
||||
|
||||
if uploaded_file:
|
||||
image = Image.open(uploaded_file)
|
||||
st.image(image, caption="Original Image", use_column_width=True)
|
||||
|
||||
quality = st.slider("Compression Quality", 1, 100, 45)
|
||||
preserve_exif = st.checkbox("Preserve EXIF Data", value=False)
|
||||
resize = st.checkbox("Resize Image")
|
||||
|
||||
if resize:
|
||||
width = st.number_input("Width", value=image.width)
|
||||
height = st.number_input("Height", value=image.height)
|
||||
resize_dims = (width, height)
|
||||
else:
|
||||
resize_dims = None
|
||||
|
||||
if st.button("Optimize Image"):
|
||||
with st.spinner("Optimizing..."):
|
||||
if tinify.key:
|
||||
st.info("Tinyfy compression will be applied.")
|
||||
|
||||
webp_path = optimize_image(image, uploaded_file.name, quality, resize_dims, preserve_exif)
|
||||
|
||||
if webp_path:
|
||||
st.image(webp_path, caption="Optimized Image (WebP)", use_column_width=True)
|
||||
st.success("Image optimization completed!")
|
||||
|
||||
with open(webp_path, "rb") as file:
|
||||
st.download_button(
|
||||
label="Download Optimized Image",
|
||||
data=file,
|
||||
file_name=os.path.basename(webp_path),
|
||||
mime="image/webp"
|
||||
)
|
||||
340
ToBeMigrated/ai_seo_tools/seo_analyzer_api.py
Normal file
340
ToBeMigrated/ai_seo_tools/seo_analyzer_api.py
Normal file
@@ -0,0 +1,340 @@
|
||||
"""
|
||||
FastAPI endpoint for the Comprehensive SEO Analyzer
|
||||
Provides data for the React SEO Dashboard
|
||||
"""
|
||||
|
||||
from fastapi import FastAPI, HTTPException
|
||||
from pydantic import BaseModel, HttpUrl
|
||||
from typing import List, Optional, Dict, Any
|
||||
from datetime import datetime
|
||||
import json
|
||||
|
||||
from .comprehensive_seo_analyzer import ComprehensiveSEOAnalyzer, SEOAnalysisResult
|
||||
|
||||
app = FastAPI(
|
||||
title="Comprehensive SEO Analyzer API",
|
||||
description="API for analyzing website SEO performance with actionable insights",
|
||||
version="1.0.0"
|
||||
)
|
||||
|
||||
# Initialize the analyzer
|
||||
seo_analyzer = ComprehensiveSEOAnalyzer()
|
||||
|
||||
class SEOAnalysisRequest(BaseModel):
|
||||
url: HttpUrl
|
||||
target_keywords: Optional[List[str]] = None
|
||||
|
||||
class SEOAnalysisResponse(BaseModel):
|
||||
url: str
|
||||
timestamp: datetime
|
||||
overall_score: int
|
||||
health_status: str
|
||||
critical_issues: List[str]
|
||||
warnings: List[str]
|
||||
recommendations: List[str]
|
||||
data: Dict[str, Any]
|
||||
success: bool
|
||||
message: str
|
||||
|
||||
@app.post("/analyze-seo", response_model=SEOAnalysisResponse)
|
||||
async def analyze_seo(request: SEOAnalysisRequest):
|
||||
"""
|
||||
Analyze a URL for comprehensive SEO performance
|
||||
|
||||
Args:
|
||||
request: SEOAnalysisRequest containing URL and optional target keywords
|
||||
|
||||
Returns:
|
||||
SEOAnalysisResponse with detailed analysis results
|
||||
"""
|
||||
try:
|
||||
# Convert URL to string
|
||||
url_str = str(request.url)
|
||||
|
||||
# Perform analysis
|
||||
result = seo_analyzer.analyze_url(url_str, request.target_keywords)
|
||||
|
||||
# Convert to response format
|
||||
response_data = {
|
||||
'url': result.url,
|
||||
'timestamp': result.timestamp,
|
||||
'overall_score': result.overall_score,
|
||||
'health_status': result.health_status,
|
||||
'critical_issues': result.critical_issues,
|
||||
'warnings': result.warnings,
|
||||
'recommendations': result.recommendations,
|
||||
'data': result.data,
|
||||
'success': True,
|
||||
'message': f"SEO analysis completed successfully for {result.url}"
|
||||
}
|
||||
|
||||
return SEOAnalysisResponse(**response_data)
|
||||
|
||||
except Exception as e:
|
||||
raise HTTPException(
|
||||
status_code=500,
|
||||
detail=f"Error analyzing SEO: {str(e)}"
|
||||
)
|
||||
|
||||
@app.get("/health")
|
||||
async def health_check():
|
||||
"""Health check endpoint"""
|
||||
return {
|
||||
"status": "healthy",
|
||||
"timestamp": datetime.now(),
|
||||
"service": "Comprehensive SEO Analyzer API"
|
||||
}
|
||||
|
||||
@app.get("/analysis-summary/{url:path}")
|
||||
async def get_analysis_summary(url: str):
|
||||
"""
|
||||
Get a quick summary of SEO analysis for a URL
|
||||
|
||||
Args:
|
||||
url: The URL to analyze
|
||||
|
||||
Returns:
|
||||
Summary of SEO analysis
|
||||
"""
|
||||
try:
|
||||
# Ensure URL has protocol
|
||||
if not url.startswith(('http://', 'https://')):
|
||||
url = f"https://{url}"
|
||||
|
||||
# Perform analysis
|
||||
result = seo_analyzer.analyze_url(url)
|
||||
|
||||
# Create summary
|
||||
summary = {
|
||||
"url": result.url,
|
||||
"overall_score": result.overall_score,
|
||||
"health_status": result.health_status,
|
||||
"critical_issues_count": len(result.critical_issues),
|
||||
"warnings_count": len(result.warnings),
|
||||
"recommendations_count": len(result.recommendations),
|
||||
"top_issues": result.critical_issues[:3],
|
||||
"top_recommendations": result.recommendations[:3],
|
||||
"analysis_timestamp": result.timestamp.isoformat()
|
||||
}
|
||||
|
||||
return summary
|
||||
|
||||
except Exception as e:
|
||||
raise HTTPException(
|
||||
status_code=500,
|
||||
detail=f"Error getting analysis summary: {str(e)}"
|
||||
)
|
||||
|
||||
@app.get("/seo-metrics/{url:path}")
|
||||
async def get_seo_metrics(url: str):
|
||||
"""
|
||||
Get detailed SEO metrics for dashboard display
|
||||
|
||||
Args:
|
||||
url: The URL to analyze
|
||||
|
||||
Returns:
|
||||
Detailed SEO metrics for React dashboard
|
||||
"""
|
||||
try:
|
||||
# Ensure URL has protocol
|
||||
if not url.startswith(('http://', 'https://')):
|
||||
url = f"https://{url}"
|
||||
|
||||
# Perform analysis
|
||||
result = seo_analyzer.analyze_url(url)
|
||||
|
||||
# Extract metrics for dashboard
|
||||
metrics = {
|
||||
"overall_score": result.overall_score,
|
||||
"health_status": result.health_status,
|
||||
"url_structure_score": result.data.get('url_structure', {}).get('score', 0),
|
||||
"meta_data_score": result.data.get('meta_data', {}).get('score', 0),
|
||||
"content_score": result.data.get('content_analysis', {}).get('score', 0),
|
||||
"technical_score": result.data.get('technical_seo', {}).get('score', 0),
|
||||
"performance_score": result.data.get('performance', {}).get('score', 0),
|
||||
"accessibility_score": result.data.get('accessibility', {}).get('score', 0),
|
||||
"user_experience_score": result.data.get('user_experience', {}).get('score', 0),
|
||||
"security_score": result.data.get('security_headers', {}).get('score', 0)
|
||||
}
|
||||
|
||||
# Add detailed data for each category
|
||||
dashboard_data = {
|
||||
"metrics": metrics,
|
||||
"critical_issues": result.critical_issues,
|
||||
"warnings": result.warnings,
|
||||
"recommendations": result.recommendations,
|
||||
"detailed_analysis": {
|
||||
"url_structure": result.data.get('url_structure', {}),
|
||||
"meta_data": result.data.get('meta_data', {}),
|
||||
"content_analysis": result.data.get('content_analysis', {}),
|
||||
"technical_seo": result.data.get('technical_seo', {}),
|
||||
"performance": result.data.get('performance', {}),
|
||||
"accessibility": result.data.get('accessibility', {}),
|
||||
"user_experience": result.data.get('user_experience', {}),
|
||||
"security_headers": result.data.get('security_headers', {}),
|
||||
"keyword_analysis": result.data.get('keyword_analysis', {})
|
||||
},
|
||||
"timestamp": result.timestamp.isoformat(),
|
||||
"url": result.url
|
||||
}
|
||||
|
||||
return dashboard_data
|
||||
|
||||
except Exception as e:
|
||||
raise HTTPException(
|
||||
status_code=500,
|
||||
detail=f"Error getting SEO metrics: {str(e)}"
|
||||
)
|
||||
|
||||
@app.post("/batch-analyze")
|
||||
async def batch_analyze(urls: List[str]):
|
||||
"""
|
||||
Analyze multiple URLs in batch
|
||||
|
||||
Args:
|
||||
urls: List of URLs to analyze
|
||||
|
||||
Returns:
|
||||
Batch analysis results
|
||||
"""
|
||||
try:
|
||||
results = []
|
||||
|
||||
for url in urls:
|
||||
try:
|
||||
# Ensure URL has protocol
|
||||
if not url.startswith(('http://', 'https://')):
|
||||
url = f"https://{url}"
|
||||
|
||||
# Perform analysis
|
||||
result = seo_analyzer.analyze_url(url)
|
||||
|
||||
# Add to results
|
||||
results.append({
|
||||
"url": result.url,
|
||||
"overall_score": result.overall_score,
|
||||
"health_status": result.health_status,
|
||||
"critical_issues_count": len(result.critical_issues),
|
||||
"warnings_count": len(result.warnings),
|
||||
"success": True
|
||||
})
|
||||
|
||||
except Exception as e:
|
||||
# Add error result
|
||||
results.append({
|
||||
"url": url,
|
||||
"overall_score": 0,
|
||||
"health_status": "error",
|
||||
"critical_issues_count": 0,
|
||||
"warnings_count": 0,
|
||||
"success": False,
|
||||
"error": str(e)
|
||||
})
|
||||
|
||||
return {
|
||||
"total_urls": len(urls),
|
||||
"successful_analyses": len([r for r in results if r['success']]),
|
||||
"failed_analyses": len([r for r in results if not r['success']]),
|
||||
"results": results
|
||||
}
|
||||
|
||||
except Exception as e:
|
||||
raise HTTPException(
|
||||
status_code=500,
|
||||
detail=f"Error in batch analysis: {str(e)}"
|
||||
)
|
||||
|
||||
# Enhanced prompts for better results
|
||||
ENHANCED_PROMPTS = {
|
||||
"critical_issue": "🚨 CRITICAL: This issue is severely impacting your SEO performance and must be fixed immediately.",
|
||||
"warning": "⚠️ WARNING: This could be improved to boost your search rankings.",
|
||||
"recommendation": "💡 RECOMMENDATION: Implement this to improve your SEO score.",
|
||||
"excellent": "🎉 EXCELLENT: Your SEO is performing very well in this area!",
|
||||
"good": "✅ GOOD: Your SEO is performing well, with room for minor improvements.",
|
||||
"needs_improvement": "🔧 NEEDS IMPROVEMENT: Several areas need attention to boost your SEO.",
|
||||
"poor": "❌ POOR: Significant improvements needed across multiple areas."
|
||||
}
|
||||
|
||||
def enhance_analysis_result(result: SEOAnalysisResult) -> SEOAnalysisResult:
|
||||
"""
|
||||
Enhance analysis results with better prompts and user-friendly language
|
||||
"""
|
||||
# Enhance critical issues
|
||||
enhanced_critical_issues = []
|
||||
for issue in result.critical_issues:
|
||||
enhanced_issue = f"{ENHANCED_PROMPTS['critical_issue']} {issue}"
|
||||
enhanced_critical_issues.append(enhanced_issue)
|
||||
|
||||
# Enhance warnings
|
||||
enhanced_warnings = []
|
||||
for warning in result.warnings:
|
||||
enhanced_warning = f"{ENHANCED_PROMPTS['warning']} {warning}"
|
||||
enhanced_warnings.append(enhanced_warning)
|
||||
|
||||
# Enhance recommendations
|
||||
enhanced_recommendations = []
|
||||
for rec in result.recommendations:
|
||||
enhanced_rec = f"{ENHANCED_PROMPTS['recommendation']} {rec}"
|
||||
enhanced_recommendations.append(enhanced_rec)
|
||||
|
||||
# Create enhanced result
|
||||
enhanced_result = SEOAnalysisResult(
|
||||
url=result.url,
|
||||
timestamp=result.timestamp,
|
||||
overall_score=result.overall_score,
|
||||
health_status=result.health_status,
|
||||
critical_issues=enhanced_critical_issues,
|
||||
warnings=enhanced_warnings,
|
||||
recommendations=enhanced_recommendations,
|
||||
data=result.data
|
||||
)
|
||||
|
||||
return enhanced_result
|
||||
|
||||
@app.post("/analyze-seo-enhanced", response_model=SEOAnalysisResponse)
|
||||
async def analyze_seo_enhanced(request: SEOAnalysisRequest):
|
||||
"""
|
||||
Analyze a URL with enhanced, user-friendly prompts
|
||||
|
||||
Args:
|
||||
request: SEOAnalysisRequest containing URL and optional target keywords
|
||||
|
||||
Returns:
|
||||
SEOAnalysisResponse with enhanced, user-friendly analysis results
|
||||
"""
|
||||
try:
|
||||
# Convert URL to string
|
||||
url_str = str(request.url)
|
||||
|
||||
# Perform analysis
|
||||
result = seo_analyzer.analyze_url(url_str, request.target_keywords)
|
||||
|
||||
# Enhance results
|
||||
enhanced_result = enhance_analysis_result(result)
|
||||
|
||||
# Convert to response format
|
||||
response_data = {
|
||||
'url': enhanced_result.url,
|
||||
'timestamp': enhanced_result.timestamp,
|
||||
'overall_score': enhanced_result.overall_score,
|
||||
'health_status': enhanced_result.health_status,
|
||||
'critical_issues': enhanced_result.critical_issues,
|
||||
'warnings': enhanced_result.warnings,
|
||||
'recommendations': enhanced_result.recommendations,
|
||||
'data': enhanced_result.data,
|
||||
'success': True,
|
||||
'message': f"Enhanced SEO analysis completed successfully for {enhanced_result.url}"
|
||||
}
|
||||
|
||||
return SEOAnalysisResponse(**response_data)
|
||||
|
||||
except Exception as e:
|
||||
raise HTTPException(
|
||||
status_code=500,
|
||||
detail=f"Error analyzing SEO: {str(e)}"
|
||||
)
|
||||
|
||||
if __name__ == "__main__":
|
||||
import uvicorn
|
||||
uvicorn.run(app, host="0.0.0.0", port=8000)
|
||||
130
ToBeMigrated/ai_seo_tools/seo_structured_data.py
Normal file
130
ToBeMigrated/ai_seo_tools/seo_structured_data.py
Normal file
@@ -0,0 +1,130 @@
|
||||
import streamlit as st
|
||||
import json
|
||||
from datetime import date
|
||||
from dotenv import load_dotenv
|
||||
|
||||
from ..ai_web_researcher.firecrawl_web_crawler import scrape_url
|
||||
from ..gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
|
||||
# Load environment variables
|
||||
load_dotenv()
|
||||
|
||||
# Define a dictionary for schema types
|
||||
schema_types = {
|
||||
"Article": {
|
||||
"fields": ["Headline", "Author", "Date Published", "Keywords"],
|
||||
"schema_type": "Article",
|
||||
},
|
||||
"Product": {
|
||||
"fields": ["Name", "Description", "Price", "Brand", "Image URL"],
|
||||
"schema_type": "Product",
|
||||
},
|
||||
"Recipe": {
|
||||
"fields": ["Name", "Ingredients", "Cooking Time", "Serving Size", "Image URL"],
|
||||
"schema_type": "Recipe",
|
||||
},
|
||||
"Event": {
|
||||
"fields": ["Name", "Start Date", "End Date", "Location", "Description"],
|
||||
"schema_type": "Event",
|
||||
},
|
||||
"LocalBusiness": {
|
||||
"fields": ["Name", "Address", "Phone Number", "Opening Hours", "Image URL"],
|
||||
"schema_type": "LocalBusiness",
|
||||
},
|
||||
# ... (add more schema types as needed)
|
||||
}
|
||||
|
||||
def generate_json_data(content_type, details, url):
|
||||
"""Generates structured data (JSON-LD) based on user input."""
|
||||
try:
|
||||
scraped_text = scrape_url(url)
|
||||
except Exception as err:
|
||||
st.error(f"Failed to scrape web page from URL: {url} - Error: {err}")
|
||||
return
|
||||
|
||||
schema = schema_types.get(content_type)
|
||||
if not schema:
|
||||
st.error(f"Invalid content type: {content_type}")
|
||||
return
|
||||
|
||||
data = {
|
||||
"@context": "https://schema.org",
|
||||
"@type": schema["schema_type"],
|
||||
}
|
||||
for field in schema["fields"]:
|
||||
value = details.get(field)
|
||||
if isinstance(value, date):
|
||||
value = value.isoformat()
|
||||
data[field] = value if value else "N/A" # Use placeholder values if input is missing
|
||||
|
||||
if url:
|
||||
data['url'] = url
|
||||
|
||||
llm_structured_data = get_llm_structured_data(content_type, data, scraped_text)
|
||||
return llm_structured_data
|
||||
|
||||
def get_llm_structured_data(content_type, data, scraped_text):
|
||||
"""Function to get structured data from LLM."""
|
||||
prompt = f"""Given the following information:
|
||||
|
||||
HTML Content: <<<HTML>>> {scraped_text} <<<END_HTML>>>
|
||||
Content Type: <<<CONTENT_TYPE>>> {content_type} <<<END_CONTENT_TYPE>>>
|
||||
Additional Relevant Data: <<<ADDITIONAL_DATA>>> {data} <<<END_ADDITIONAL_DATA>>>
|
||||
|
||||
Create a detailed structured data (JSON-LD) script for SEO purposes.
|
||||
The structured data should help search engines understand the content and features of the webpage, enhancing its visibility and potential for rich snippets in search results.
|
||||
|
||||
Detailed Steps:
|
||||
Parse the HTML content to extract relevant information like the title, main heading, and body content.
|
||||
Use the contentType to determine the structured data type (e.g., Article, Product, Recipe).
|
||||
Integrate the additional relevant data (e.g., author, datePublished, keywords) into the structured data.
|
||||
Ensure all URLs, images, and other attributes are correctly formatted and included.
|
||||
Validate the generated JSON-LD to ensure it meets schema.org standards and is free of errors.
|
||||
|
||||
Expected Output:
|
||||
Generate a JSON-LD structured data snippet based on the provided inputs."""
|
||||
|
||||
try:
|
||||
response = llm_text_gen(prompt)
|
||||
return response
|
||||
except Exception as err:
|
||||
st.error(f"Failed to get response from LLM: {err}")
|
||||
return
|
||||
|
||||
def ai_structured_data():
|
||||
st.title("📝 Generate Structured Data for SEO 🚀")
|
||||
st.markdown("**Make your content more discoverable with rich snippets.**")
|
||||
|
||||
content_type = st.selectbox("**Select Content Type**", list(schema_types.keys()))
|
||||
|
||||
details = {}
|
||||
schema_fields = schema_types[content_type]["fields"]
|
||||
num_fields = len(schema_fields)
|
||||
|
||||
url = st.text_input("**URL :**", placeholder="Enter the URL of your webpage")
|
||||
for i in range(0, num_fields, 2):
|
||||
cols = st.columns(2)
|
||||
for j in range(2):
|
||||
if i + j < num_fields:
|
||||
field = schema_fields[i + j]
|
||||
if "Date" in field:
|
||||
details[field] = cols[j].date_input(field)
|
||||
else:
|
||||
details[field] = cols[j].text_input(field, placeholder=f"Enter {field.lower()}")
|
||||
|
||||
if st.button("Generate Structured Data"):
|
||||
if not url:
|
||||
st.error("URL is required to generate structured data.")
|
||||
return
|
||||
|
||||
structured_data = generate_json_data(content_type, details, url)
|
||||
if structured_data:
|
||||
st.subheader("Generated Structured Data (JSON-LD):")
|
||||
st.markdown(structured_data)
|
||||
|
||||
st.download_button(
|
||||
label="Download JSON-LD",
|
||||
data=structured_data,
|
||||
file_name=f"{content_type}_structured_data.json",
|
||||
mime="application/json",
|
||||
)
|
||||
340
ToBeMigrated/ai_seo_tools/sitemap_analysis.py
Normal file
340
ToBeMigrated/ai_seo_tools/sitemap_analysis.py
Normal file
@@ -0,0 +1,340 @@
|
||||
import streamlit as st
|
||||
import advertools as adv
|
||||
import pandas as pd
|
||||
import plotly.graph_objects as go
|
||||
from urllib.error import URLError
|
||||
import xml.etree.ElementTree as ET
|
||||
import requests
|
||||
|
||||
|
||||
def main():
|
||||
"""
|
||||
Main function to run the Sitemap Analyzer Streamlit app.
|
||||
"""
|
||||
st.title("📊 Sitemap Analyzer")
|
||||
st.write("""
|
||||
This tool analyzes a website's sitemap to understand its content structure and publishing trends.
|
||||
Enter a sitemap URL to start your analysis.
|
||||
""")
|
||||
|
||||
sitemap_url = st.text_input(
|
||||
"Please enter the sitemap URL:",
|
||||
"https://www.example.com/sitemap.xml"
|
||||
)
|
||||
|
||||
if st.button("Analyze Sitemap"):
|
||||
try:
|
||||
sitemap_df = fetch_all_sitemaps(sitemap_url)
|
||||
if sitemap_df is not None and not sitemap_df.empty:
|
||||
sitemap_df = process_lastmod_column(sitemap_df)
|
||||
ppmonth = analyze_content_trends(sitemap_df)
|
||||
sitemap_df = categorize_and_shorten_sitemaps(sitemap_df)
|
||||
|
||||
display_key_metrics(sitemap_df, ppmonth)
|
||||
plot_sitemap_content_distribution(sitemap_df)
|
||||
plot_content_trends(ppmonth)
|
||||
plot_content_type_breakdown(sitemap_df)
|
||||
plot_publishing_frequency(sitemap_df)
|
||||
|
||||
st.success("🎉 Analysis complete!")
|
||||
else:
|
||||
st.error("No valid URLs found in the sitemap.")
|
||||
except URLError as e:
|
||||
st.error(f"Error fetching the sitemap: {e}")
|
||||
except Exception as e:
|
||||
st.error(f"An unexpected error occurred: {e}")
|
||||
|
||||
|
||||
def fetch_all_sitemaps(sitemap_url):
|
||||
"""
|
||||
Fetches all sitemaps from the provided sitemap URL and concatenates their URLs into a DataFrame.
|
||||
|
||||
Parameters:
|
||||
sitemap_url (str): The URL of the sitemap.
|
||||
|
||||
Returns:
|
||||
DataFrame: A DataFrame containing all URLs from the sitemaps.
|
||||
"""
|
||||
st.write(f"🚀 Fetching and analyzing the sitemap: {sitemap_url}...")
|
||||
|
||||
try:
|
||||
sitemap_df = fetch_sitemap(sitemap_url)
|
||||
|
||||
if sitemap_df is not None:
|
||||
all_sitemaps = sitemap_df.loc[
|
||||
sitemap_df['loc'].str.contains('sitemap'),
|
||||
'loc'
|
||||
].tolist()
|
||||
|
||||
if all_sitemaps:
|
||||
st.write(
|
||||
f"🔄 Found {len(all_sitemaps)} additional sitemaps. Fetching data from them..."
|
||||
)
|
||||
all_urls_df = pd.DataFrame()
|
||||
|
||||
for sitemap in all_sitemaps:
|
||||
try:
|
||||
st.write(f"Fetching URLs from {sitemap}...")
|
||||
temp_df = fetch_sitemap(sitemap)
|
||||
if temp_df is not None:
|
||||
all_urls_df = pd.concat(
|
||||
[all_urls_df, temp_df], ignore_index=True
|
||||
)
|
||||
except Exception as e:
|
||||
st.error(f"Error fetching {sitemap}: {e}")
|
||||
|
||||
st.write(
|
||||
f"✅ Successfully fetched {len(all_urls_df)} URLs from all sitemaps."
|
||||
)
|
||||
return all_urls_df
|
||||
|
||||
else:
|
||||
st.write(f"✅ Successfully fetched {len(sitemap_df)} URLs from the main sitemap.")
|
||||
return sitemap_df
|
||||
else:
|
||||
return None
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"⚠️ Error fetching the sitemap: {e}")
|
||||
return None
|
||||
|
||||
|
||||
def fetch_sitemap(url):
|
||||
"""
|
||||
Fetches and parses the sitemap from the provided URL.
|
||||
|
||||
Parameters:
|
||||
url (str): The URL of the sitemap.
|
||||
|
||||
Returns:
|
||||
DataFrame: A DataFrame containing the URLs from the sitemap.
|
||||
"""
|
||||
try:
|
||||
response = requests.get(url)
|
||||
response.raise_for_status()
|
||||
|
||||
ET.fromstring(response.content)
|
||||
|
||||
sitemap_df = adv.sitemap_to_df(url)
|
||||
return sitemap_df
|
||||
|
||||
except requests.RequestException as e:
|
||||
st.error(f"⚠️ Request error: {e}")
|
||||
return None
|
||||
except ET.ParseError as e:
|
||||
st.error(f"⚠️ XML parsing error: {e}")
|
||||
return None
|
||||
|
||||
|
||||
def process_lastmod_column(sitemap_df):
|
||||
"""
|
||||
Processes the 'lastmod' column in the sitemap DataFrame by converting it to DateTime format and setting it as the index.
|
||||
|
||||
Parameters:
|
||||
sitemap_df (DataFrame): The sitemap DataFrame.
|
||||
|
||||
Returns:
|
||||
DataFrame: The processed sitemap DataFrame with 'lastmod' as the index.
|
||||
"""
|
||||
st.write("📅 Converting 'lastmod' column to DateTime format and setting it as the index...")
|
||||
|
||||
try:
|
||||
sitemap_df = sitemap_df.dropna(subset=['lastmod'])
|
||||
sitemap_df['lastmod'] = pd.to_datetime(sitemap_df['lastmod'])
|
||||
sitemap_df.set_index('lastmod', inplace=True)
|
||||
|
||||
st.write("✅ 'lastmod' column successfully converted to DateTime format and set as the index.")
|
||||
return sitemap_df
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"⚠️ Error processing the 'lastmod' column: {e}")
|
||||
return None
|
||||
|
||||
|
||||
def categorize_and_shorten_sitemaps(sitemap_df):
|
||||
"""
|
||||
Categorizes and shortens the sitemap names in the sitemap DataFrame.
|
||||
|
||||
Parameters:
|
||||
sitemap_df (DataFrame): The sitemap DataFrame.
|
||||
|
||||
Returns:
|
||||
DataFrame: The sitemap DataFrame with categorized and shortened sitemap names.
|
||||
"""
|
||||
st.write("🔍 Categorizing and shortening sitemap names...")
|
||||
|
||||
try:
|
||||
sitemap_df['sitemap_name'] = sitemap_df['sitemap'].str.split('/').str[4]
|
||||
sitemap_df['sitemap_name'] = sitemap_df['sitemap_name'].replace({
|
||||
'sitemap-site-kasko-fiyatlari.xml': 'Kasko',
|
||||
'sitemap-site-bireysel.xml': 'Personal',
|
||||
'sitemap-site-kurumsal.xml': 'Cooperate',
|
||||
'sitemap-site-arac-sigortasi.xml': 'Car',
|
||||
'sitemap-site.xml': 'Others'
|
||||
})
|
||||
|
||||
st.write("✅ Sitemap names categorized and shortened.")
|
||||
return sitemap_df
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"⚠️ Error categorizing sitemap names: {e}")
|
||||
return sitemap_df
|
||||
|
||||
|
||||
def analyze_content_trends(sitemap_df):
|
||||
"""
|
||||
Analyzes content publishing trends in the sitemap DataFrame.
|
||||
|
||||
Parameters:
|
||||
sitemap_df (DataFrame): The sitemap DataFrame.
|
||||
|
||||
Returns:
|
||||
Series: A Series representing the number of contents published each month.
|
||||
"""
|
||||
st.write("📅 Analyzing content publishing trends...")
|
||||
|
||||
try:
|
||||
ppmonth = sitemap_df.resample('M').size()
|
||||
sitemap_df['monthly_count'] = sitemap_df.index.to_period('M').value_counts().sort_index()
|
||||
|
||||
st.write("✅ Content trends analysis completed.")
|
||||
return ppmonth
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"⚠️ Error during content trends analysis: {e}")
|
||||
return pd.Series()
|
||||
|
||||
|
||||
def display_key_metrics(sitemap_df, ppmonth):
|
||||
"""
|
||||
Displays key metrics of the sitemap analysis.
|
||||
|
||||
Parameters:
|
||||
sitemap_df (DataFrame): The sitemap DataFrame.
|
||||
ppmonth (Series): The Series representing the number of contents published each month.
|
||||
"""
|
||||
st.write("### Key Metrics")
|
||||
|
||||
total_urls = len(sitemap_df)
|
||||
total_articles = ppmonth.sum()
|
||||
average_frequency = ppmonth.mean()
|
||||
|
||||
st.write(f"**Total URLs Found:** {total_urls:,}")
|
||||
st.write(f"**Total Articles Published:** {total_articles:,}")
|
||||
st.write(f"**Average Monthly Publishing Frequency:** {average_frequency:.2f} articles/month")
|
||||
|
||||
|
||||
def plot_sitemap_content_distribution(sitemap_df):
|
||||
"""
|
||||
Plots the content distribution by sitemap categories.
|
||||
|
||||
Parameters:
|
||||
sitemap_df (DataFrame): The sitemap DataFrame.
|
||||
"""
|
||||
st.write("📊 Visualizing content amount by sitemap categories...")
|
||||
|
||||
try:
|
||||
if 'sitemap_name' in sitemap_df.columns:
|
||||
stmc = sitemap_df.groupby('sitemap_name').size()
|
||||
fig = go.Figure()
|
||||
fig.add_bar(x=stmc.index, y=stmc.values, name='Sitemap Categories')
|
||||
fig.update_layout(
|
||||
title='Content Amount by Sitemap Categories',
|
||||
xaxis_title='Sitemap Categories',
|
||||
yaxis_title='Number of Articles',
|
||||
paper_bgcolor='#E5ECF6'
|
||||
)
|
||||
st.plotly_chart(fig)
|
||||
else:
|
||||
st.warning("⚠️ The 'sitemap_name' column is missing in the data.")
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"⚠️ Error during sitemap content distribution plotting: {e}")
|
||||
|
||||
|
||||
def plot_content_trends(ppmonth):
|
||||
"""
|
||||
Plots the content publishing trends over time.
|
||||
|
||||
Parameters:
|
||||
ppmonth (Series): The Series representing the number of contents published each month.
|
||||
"""
|
||||
st.write("📈 Plotting content publishing trends over time...")
|
||||
|
||||
try:
|
||||
fig = go.Figure()
|
||||
fig.add_scatter(x=ppmonth.index, y=ppmonth.values, mode='lines+markers', name='Publishing Trends')
|
||||
fig.update_layout(
|
||||
title='Content Publishing Trends Over Time',
|
||||
xaxis_title='Month',
|
||||
yaxis_title='Number of Articles',
|
||||
paper_bgcolor='#E5ECF6'
|
||||
)
|
||||
st.plotly_chart(fig)
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"⚠️ Error during content trends plotting: {e}")
|
||||
|
||||
|
||||
def plot_content_type_breakdown(sitemap_df):
|
||||
"""
|
||||
Plots the content type breakdown.
|
||||
|
||||
Parameters:
|
||||
sitemap_df (DataFrame): The sitemap DataFrame.
|
||||
"""
|
||||
st.write("🔍 Plotting content type breakdown...")
|
||||
|
||||
try:
|
||||
if 'sitemap_name' in sitemap_df.columns and not sitemap_df['sitemap_name'].empty:
|
||||
content_type_counts = sitemap_df['sitemap_name'].value_counts()
|
||||
st.write("Content Type Counts:", content_type_counts)
|
||||
|
||||
if not content_type_counts.empty:
|
||||
fig = go.Figure(data=[go.Pie(labels=content_type_counts.index, values=content_type_counts.values)])
|
||||
fig.update_layout(
|
||||
title='Content Type Breakdown',
|
||||
paper_bgcolor='#E5ECF6'
|
||||
)
|
||||
st.plotly_chart(fig)
|
||||
else:
|
||||
st.warning("⚠️ No content types to display.")
|
||||
else:
|
||||
st.warning("⚠️ The 'sitemap_name' column is missing or empty.")
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"⚠️ Error during content type breakdown plotting: {e}")
|
||||
|
||||
|
||||
def plot_publishing_frequency(sitemap_df):
|
||||
"""
|
||||
Plots the publishing frequency by month.
|
||||
|
||||
Parameters:
|
||||
sitemap_df (DataFrame): The sitemap DataFrame.
|
||||
"""
|
||||
st.write("📆 Plotting publishing frequency by month...")
|
||||
|
||||
try:
|
||||
if not sitemap_df.empty:
|
||||
frequency_by_month = sitemap_df.index.to_period('M').value_counts().sort_index()
|
||||
frequency_by_month.index = frequency_by_month.index.astype(str)
|
||||
|
||||
fig = go.Figure()
|
||||
fig.add_bar(x=frequency_by_month.index, y=frequency_by_month.values, name='Publishing Frequency')
|
||||
fig.update_layout(
|
||||
title='Publishing Frequency by Month',
|
||||
xaxis_title='Month',
|
||||
yaxis_title='Number of Articles',
|
||||
paper_bgcolor='#E5ECF6'
|
||||
)
|
||||
st.plotly_chart(fig)
|
||||
else:
|
||||
st.warning("⚠️ No data available to plot publishing frequency.")
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"⚠️ Error during publishing frequency plotting: {e}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
22
ToBeMigrated/ai_seo_tools/technical_seo_crawler/__init__.py
Normal file
22
ToBeMigrated/ai_seo_tools/technical_seo_crawler/__init__.py
Normal file
@@ -0,0 +1,22 @@
|
||||
"""
|
||||
Technical SEO Crawler Package.
|
||||
|
||||
This package provides comprehensive technical SEO analysis capabilities
|
||||
with advertools integration and AI-powered recommendations.
|
||||
|
||||
Components:
|
||||
- TechnicalSEOCrawler: Core crawler with technical analysis
|
||||
- TechnicalSEOCrawlerUI: Streamlit interface for the crawler
|
||||
"""
|
||||
|
||||
from .crawler import TechnicalSEOCrawler
|
||||
from .ui import TechnicalSEOCrawlerUI, render_technical_seo_crawler
|
||||
|
||||
__version__ = "1.0.0"
|
||||
__author__ = "ALwrity"
|
||||
|
||||
__all__ = [
|
||||
'TechnicalSEOCrawler',
|
||||
'TechnicalSEOCrawlerUI',
|
||||
'render_technical_seo_crawler'
|
||||
]
|
||||
709
ToBeMigrated/ai_seo_tools/technical_seo_crawler/crawler.py
Normal file
709
ToBeMigrated/ai_seo_tools/technical_seo_crawler/crawler.py
Normal file
@@ -0,0 +1,709 @@
|
||||
"""
|
||||
Comprehensive Technical SEO Crawler using Advertools Integration.
|
||||
|
||||
This module provides advanced site-wide technical SEO analysis using:
|
||||
- adv.crawl: Complete website crawling and analysis
|
||||
- adv.crawl_headers: HTTP headers and server analysis
|
||||
- adv.crawl_images: Image optimization analysis
|
||||
- adv.url_to_df: URL structure optimization
|
||||
- AI-powered technical recommendations
|
||||
"""
|
||||
|
||||
import streamlit as st
|
||||
import pandas as pd
|
||||
import advertools as adv
|
||||
from typing import Dict, Any, List, Optional, Tuple
|
||||
from urllib.parse import urlparse, urljoin
|
||||
import tempfile
|
||||
import os
|
||||
from datetime import datetime
|
||||
import json
|
||||
from collections import Counter, defaultdict
|
||||
from loguru import logger
|
||||
import numpy as np
|
||||
|
||||
# Import existing modules
|
||||
from lib.gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
from lib.utils.website_analyzer.analyzer import WebsiteAnalyzer
|
||||
|
||||
class TechnicalSEOCrawler:
|
||||
"""Comprehensive technical SEO crawler with advertools integration."""
|
||||
|
||||
def __init__(self):
|
||||
"""Initialize the technical SEO crawler."""
|
||||
self.temp_dir = tempfile.mkdtemp()
|
||||
logger.info("TechnicalSEOCrawler initialized")
|
||||
|
||||
def analyze_website_technical_seo(self, website_url: str, crawl_depth: int = 3,
|
||||
max_pages: int = 500) -> Dict[str, Any]:
|
||||
"""
|
||||
Perform comprehensive technical SEO analysis.
|
||||
|
||||
Args:
|
||||
website_url: Website URL to analyze
|
||||
crawl_depth: How deep to crawl (1-5)
|
||||
max_pages: Maximum pages to crawl (50-1000)
|
||||
|
||||
Returns:
|
||||
Comprehensive technical SEO analysis results
|
||||
"""
|
||||
try:
|
||||
st.info("🚀 Starting Comprehensive Technical SEO Crawl...")
|
||||
|
||||
# Initialize results structure
|
||||
results = {
|
||||
'analysis_timestamp': datetime.utcnow().isoformat(),
|
||||
'website_url': website_url,
|
||||
'crawl_settings': {
|
||||
'depth': crawl_depth,
|
||||
'max_pages': max_pages
|
||||
},
|
||||
'crawl_overview': {},
|
||||
'technical_issues': {},
|
||||
'performance_analysis': {},
|
||||
'content_analysis': {},
|
||||
'url_structure': {},
|
||||
'image_optimization': {},
|
||||
'security_headers': {},
|
||||
'mobile_seo': {},
|
||||
'structured_data': {},
|
||||
'ai_recommendations': {}
|
||||
}
|
||||
|
||||
# Phase 1: Core Website Crawl
|
||||
with st.expander("🕷️ Website Crawling Progress", expanded=True):
|
||||
crawl_data = self._perform_comprehensive_crawl(website_url, crawl_depth, max_pages)
|
||||
results['crawl_overview'] = crawl_data
|
||||
st.success(f"✅ Crawled {crawl_data.get('pages_crawled', 0)} pages")
|
||||
|
||||
# Phase 2: Technical Issues Detection
|
||||
with st.expander("🔍 Technical Issues Analysis", expanded=True):
|
||||
technical_issues = self._analyze_technical_issues(crawl_data)
|
||||
results['technical_issues'] = technical_issues
|
||||
st.success("✅ Identified technical SEO issues")
|
||||
|
||||
# Phase 3: Performance Analysis
|
||||
with st.expander("⚡ Performance Analysis", expanded=True):
|
||||
performance = self._analyze_performance_metrics(crawl_data)
|
||||
results['performance_analysis'] = performance
|
||||
st.success("✅ Analyzed website performance metrics")
|
||||
|
||||
# Phase 4: Content & Structure Analysis
|
||||
with st.expander("📊 Content Structure Analysis", expanded=True):
|
||||
content_analysis = self._analyze_content_structure(crawl_data)
|
||||
results['content_analysis'] = content_analysis
|
||||
st.success("✅ Analyzed content structure and optimization")
|
||||
|
||||
# Phase 5: URL Structure Optimization
|
||||
with st.expander("🔗 URL Structure Analysis", expanded=True):
|
||||
url_analysis = self._analyze_url_structure(crawl_data)
|
||||
results['url_structure'] = url_analysis
|
||||
st.success("✅ Analyzed URL structure and patterns")
|
||||
|
||||
# Phase 6: Image SEO Analysis
|
||||
with st.expander("🖼️ Image SEO Analysis", expanded=True):
|
||||
image_analysis = self._analyze_image_seo(website_url)
|
||||
results['image_optimization'] = image_analysis
|
||||
st.success("✅ Analyzed image optimization")
|
||||
|
||||
# Phase 7: Security & Headers Analysis
|
||||
with st.expander("🛡️ Security Headers Analysis", expanded=True):
|
||||
security_analysis = self._analyze_security_headers(website_url)
|
||||
results['security_headers'] = security_analysis
|
||||
st.success("✅ Analyzed security headers")
|
||||
|
||||
# Phase 8: Mobile SEO Analysis
|
||||
with st.expander("📱 Mobile SEO Analysis", expanded=True):
|
||||
mobile_analysis = self._analyze_mobile_seo(crawl_data)
|
||||
results['mobile_seo'] = mobile_analysis
|
||||
st.success("✅ Analyzed mobile SEO factors")
|
||||
|
||||
# Phase 9: AI-Powered Recommendations
|
||||
with st.expander("🤖 AI Technical Recommendations", expanded=True):
|
||||
ai_recommendations = self._generate_technical_recommendations(results)
|
||||
results['ai_recommendations'] = ai_recommendations
|
||||
st.success("✅ Generated AI-powered technical recommendations")
|
||||
|
||||
return results
|
||||
|
||||
except Exception as e:
|
||||
error_msg = f"Error in technical SEO analysis: {str(e)}"
|
||||
logger.error(error_msg, exc_info=True)
|
||||
st.error(error_msg)
|
||||
return {'error': error_msg}
|
||||
|
||||
def _perform_comprehensive_crawl(self, website_url: str, depth: int, max_pages: int) -> Dict[str, Any]:
|
||||
"""Perform comprehensive website crawl using adv.crawl."""
|
||||
try:
|
||||
st.info("🕷️ Crawling website for comprehensive analysis...")
|
||||
|
||||
# Create crawl output file
|
||||
crawl_file = os.path.join(self.temp_dir, "technical_crawl.jl")
|
||||
|
||||
# Configure crawl settings for technical SEO
|
||||
custom_settings = {
|
||||
'DEPTH_LIMIT': depth,
|
||||
'CLOSESPIDER_PAGECOUNT': max_pages,
|
||||
'DOWNLOAD_DELAY': 0.5, # Be respectful
|
||||
'CONCURRENT_REQUESTS': 8,
|
||||
'ROBOTSTXT_OBEY': True,
|
||||
'USER_AGENT': 'ALwrity-TechnicalSEO-Crawler/1.0',
|
||||
'COOKIES_ENABLED': False,
|
||||
'TELNETCONSOLE_ENABLED': False,
|
||||
'LOG_LEVEL': 'WARNING'
|
||||
}
|
||||
|
||||
# Start crawl
|
||||
adv.crawl(
|
||||
url_list=[website_url],
|
||||
output_file=crawl_file,
|
||||
follow_links=True,
|
||||
custom_settings=custom_settings
|
||||
)
|
||||
|
||||
# Read and process crawl results
|
||||
if os.path.exists(crawl_file):
|
||||
crawl_df = pd.read_json(crawl_file, lines=True)
|
||||
|
||||
# Basic crawl statistics
|
||||
crawl_overview = {
|
||||
'pages_crawled': len(crawl_df),
|
||||
'status_codes': crawl_df['status'].value_counts().to_dict(),
|
||||
'crawl_file_path': crawl_file,
|
||||
'crawl_dataframe': crawl_df,
|
||||
'domains_found': crawl_df['url'].apply(lambda x: urlparse(x).netloc).nunique(),
|
||||
'avg_response_time': crawl_df.get('download_latency', pd.Series()).mean(),
|
||||
'total_content_size': crawl_df.get('size', pd.Series()).sum()
|
||||
}
|
||||
|
||||
return crawl_overview
|
||||
else:
|
||||
st.error("Crawl file not created")
|
||||
return {}
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"Error in website crawl: {str(e)}")
|
||||
return {}
|
||||
|
||||
def _analyze_technical_issues(self, crawl_data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Analyze technical SEO issues from crawl data."""
|
||||
try:
|
||||
st.info("🔍 Detecting technical SEO issues...")
|
||||
|
||||
if 'crawl_dataframe' not in crawl_data:
|
||||
return {}
|
||||
|
||||
df = crawl_data['crawl_dataframe']
|
||||
|
||||
technical_issues = {
|
||||
'http_errors': {},
|
||||
'redirect_issues': {},
|
||||
'duplicate_content': {},
|
||||
'missing_elements': {},
|
||||
'page_speed_issues': {},
|
||||
'crawlability_issues': {}
|
||||
}
|
||||
|
||||
# HTTP Status Code Issues
|
||||
error_codes = df[df['status'] >= 400]['status'].value_counts().to_dict()
|
||||
technical_issues['http_errors'] = {
|
||||
'total_errors': len(df[df['status'] >= 400]),
|
||||
'error_breakdown': error_codes,
|
||||
'error_pages': df[df['status'] >= 400][['url', 'status']].to_dict('records')[:50]
|
||||
}
|
||||
|
||||
# Redirect Analysis
|
||||
redirects = df[df['status'].isin([301, 302, 303, 307, 308])]
|
||||
technical_issues['redirect_issues'] = {
|
||||
'total_redirects': len(redirects),
|
||||
'redirect_chains': self._find_redirect_chains(redirects),
|
||||
'redirect_types': redirects['status'].value_counts().to_dict()
|
||||
}
|
||||
|
||||
# Duplicate Content Detection
|
||||
if 'title' in df.columns:
|
||||
duplicate_titles = df['title'].value_counts()
|
||||
duplicate_titles = duplicate_titles[duplicate_titles > 1]
|
||||
|
||||
technical_issues['duplicate_content'] = {
|
||||
'duplicate_titles': len(duplicate_titles),
|
||||
'duplicate_title_groups': duplicate_titles.to_dict(),
|
||||
'pages_with_duplicate_titles': df[df['title'].isin(duplicate_titles.index)][['url', 'title']].to_dict('records')[:20]
|
||||
}
|
||||
|
||||
# Missing Elements Analysis
|
||||
missing_elements = {
|
||||
'missing_titles': len(df[(df['title'].isna()) | (df['title'] == '')]) if 'title' in df.columns else 0,
|
||||
'missing_meta_desc': len(df[(df['meta_desc'].isna()) | (df['meta_desc'] == '')]) if 'meta_desc' in df.columns else 0,
|
||||
'missing_h1': len(df[(df['h1'].isna()) | (df['h1'] == '')]) if 'h1' in df.columns else 0
|
||||
}
|
||||
technical_issues['missing_elements'] = missing_elements
|
||||
|
||||
# Page Speed Issues
|
||||
if 'download_latency' in df.columns:
|
||||
slow_pages = df[df['download_latency'] > 3.0] # Pages taking >3s
|
||||
technical_issues['page_speed_issues'] = {
|
||||
'slow_pages_count': len(slow_pages),
|
||||
'avg_load_time': df['download_latency'].mean(),
|
||||
'slowest_pages': slow_pages.nlargest(10, 'download_latency')[['url', 'download_latency']].to_dict('records')
|
||||
}
|
||||
|
||||
return technical_issues
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"Error analyzing technical issues: {str(e)}")
|
||||
return {}
|
||||
|
||||
def _analyze_performance_metrics(self, crawl_data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Analyze website performance metrics."""
|
||||
try:
|
||||
st.info("⚡ Analyzing performance metrics...")
|
||||
|
||||
if 'crawl_dataframe' not in crawl_data:
|
||||
return {}
|
||||
|
||||
df = crawl_data['crawl_dataframe']
|
||||
|
||||
performance = {
|
||||
'load_time_analysis': {},
|
||||
'content_size_analysis': {},
|
||||
'server_performance': {},
|
||||
'optimization_opportunities': []
|
||||
}
|
||||
|
||||
# Load Time Analysis
|
||||
if 'download_latency' in df.columns:
|
||||
load_times = df['download_latency'].dropna()
|
||||
performance['load_time_analysis'] = {
|
||||
'avg_load_time': load_times.mean(),
|
||||
'median_load_time': load_times.median(),
|
||||
'p95_load_time': load_times.quantile(0.95),
|
||||
'fastest_page': load_times.min(),
|
||||
'slowest_page': load_times.max(),
|
||||
'pages_over_3s': len(load_times[load_times > 3]),
|
||||
'performance_distribution': {
|
||||
'fast_pages': len(load_times[load_times <= 1]),
|
||||
'moderate_pages': len(load_times[(load_times > 1) & (load_times <= 3)]),
|
||||
'slow_pages': len(load_times[load_times > 3])
|
||||
}
|
||||
}
|
||||
|
||||
# Content Size Analysis
|
||||
if 'size' in df.columns:
|
||||
sizes = df['size'].dropna()
|
||||
performance['content_size_analysis'] = {
|
||||
'avg_page_size': sizes.mean(),
|
||||
'median_page_size': sizes.median(),
|
||||
'largest_page': sizes.max(),
|
||||
'smallest_page': sizes.min(),
|
||||
'pages_over_1mb': len(sizes[sizes > 1048576]), # 1MB
|
||||
'total_content_size': sizes.sum()
|
||||
}
|
||||
|
||||
# Server Performance
|
||||
status_codes = df['status'].value_counts()
|
||||
total_pages = len(df)
|
||||
performance['server_performance'] = {
|
||||
'success_rate': status_codes.get(200, 0) / total_pages * 100,
|
||||
'error_rate': sum(status_codes.get(code, 0) for code in range(400, 600)) / total_pages * 100,
|
||||
'redirect_rate': sum(status_codes.get(code, 0) for code in [301, 302, 303, 307, 308]) / total_pages * 100
|
||||
}
|
||||
|
||||
return performance
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"Error analyzing performance: {str(e)}")
|
||||
return {}
|
||||
|
||||
def _analyze_content_structure(self, crawl_data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Analyze content structure and SEO elements."""
|
||||
try:
|
||||
st.info("📊 Analyzing content structure...")
|
||||
|
||||
if 'crawl_dataframe' not in crawl_data:
|
||||
return {}
|
||||
|
||||
df = crawl_data['crawl_dataframe']
|
||||
|
||||
content_analysis = {
|
||||
'title_analysis': {},
|
||||
'meta_description_analysis': {},
|
||||
'heading_structure': {},
|
||||
'internal_linking': {},
|
||||
'content_optimization': {}
|
||||
}
|
||||
|
||||
# Title Analysis
|
||||
if 'title' in df.columns:
|
||||
titles = df['title'].dropna()
|
||||
title_lengths = titles.str.len()
|
||||
|
||||
content_analysis['title_analysis'] = {
|
||||
'avg_title_length': title_lengths.mean(),
|
||||
'title_length_distribution': {
|
||||
'too_short': len(title_lengths[title_lengths < 30]),
|
||||
'optimal': len(title_lengths[(title_lengths >= 30) & (title_lengths <= 60)]),
|
||||
'too_long': len(title_lengths[title_lengths > 60])
|
||||
},
|
||||
'duplicate_titles': len(titles.value_counts()[titles.value_counts() > 1]),
|
||||
'missing_titles': len(df) - len(titles)
|
||||
}
|
||||
|
||||
# Meta Description Analysis
|
||||
if 'meta_desc' in df.columns:
|
||||
meta_descs = df['meta_desc'].dropna()
|
||||
meta_lengths = meta_descs.str.len()
|
||||
|
||||
content_analysis['meta_description_analysis'] = {
|
||||
'avg_meta_length': meta_lengths.mean(),
|
||||
'meta_length_distribution': {
|
||||
'too_short': len(meta_lengths[meta_lengths < 120]),
|
||||
'optimal': len(meta_lengths[(meta_lengths >= 120) & (meta_lengths <= 160)]),
|
||||
'too_long': len(meta_lengths[meta_lengths > 160])
|
||||
},
|
||||
'missing_meta_descriptions': len(df) - len(meta_descs)
|
||||
}
|
||||
|
||||
# Heading Structure Analysis
|
||||
heading_cols = [col for col in df.columns if col.startswith('h') and col[1:].isdigit()]
|
||||
if heading_cols:
|
||||
heading_analysis = {}
|
||||
for col in heading_cols:
|
||||
headings = df[col].dropna()
|
||||
heading_analysis[f'{col}_usage'] = {
|
||||
'pages_with_heading': len(headings),
|
||||
'usage_rate': len(headings) / len(df) * 100,
|
||||
'avg_length': headings.str.len().mean() if len(headings) > 0 else 0
|
||||
}
|
||||
content_analysis['heading_structure'] = heading_analysis
|
||||
|
||||
# Internal Linking Analysis
|
||||
if 'links_internal' in df.columns:
|
||||
internal_links = df['links_internal'].apply(lambda x: len(x) if isinstance(x, list) else 0)
|
||||
content_analysis['internal_linking'] = {
|
||||
'avg_internal_links': internal_links.mean(),
|
||||
'pages_with_no_internal_links': len(internal_links[internal_links == 0]),
|
||||
'max_internal_links': internal_links.max(),
|
||||
'internal_link_distribution': internal_links.describe().to_dict()
|
||||
}
|
||||
|
||||
return content_analysis
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"Error analyzing content structure: {str(e)}")
|
||||
return {}
|
||||
|
||||
def _analyze_url_structure(self, crawl_data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Analyze URL structure and optimization using adv.url_to_df."""
|
||||
try:
|
||||
st.info("🔗 Analyzing URL structure...")
|
||||
|
||||
if 'crawl_dataframe' not in crawl_data:
|
||||
return {}
|
||||
|
||||
df = crawl_data['crawl_dataframe']
|
||||
urls = df['url'].tolist()
|
||||
|
||||
# Use advertools to analyze URL structure
|
||||
url_df = adv.url_to_df(urls)
|
||||
|
||||
url_analysis = {
|
||||
'url_length_analysis': {},
|
||||
'url_structure_patterns': {},
|
||||
'url_optimization': {},
|
||||
'path_analysis': {}
|
||||
}
|
||||
|
||||
# URL Length Analysis
|
||||
url_lengths = url_df['url'].str.len()
|
||||
url_analysis['url_length_analysis'] = {
|
||||
'avg_url_length': url_lengths.mean(),
|
||||
'max_url_length': url_lengths.max(),
|
||||
'long_urls_count': len(url_lengths[url_lengths > 100]),
|
||||
'url_length_distribution': url_lengths.describe().to_dict()
|
||||
}
|
||||
|
||||
# Path Depth Analysis
|
||||
if 'dir_1' in url_df.columns:
|
||||
path_depths = url_df.apply(lambda row: sum(1 for i in range(1, 10) if f'dir_{i}' in row and pd.notna(row[f'dir_{i}'])), axis=1)
|
||||
url_analysis['path_analysis'] = {
|
||||
'avg_path_depth': path_depths.mean(),
|
||||
'max_path_depth': path_depths.max(),
|
||||
'deep_paths_count': len(path_depths[path_depths > 4]),
|
||||
'path_depth_distribution': path_depths.value_counts().to_dict()
|
||||
}
|
||||
|
||||
# URL Structure Patterns
|
||||
domains = url_df['netloc'].value_counts()
|
||||
schemes = url_df['scheme'].value_counts()
|
||||
|
||||
url_analysis['url_structure_patterns'] = {
|
||||
'domains_found': domains.to_dict(),
|
||||
'schemes_used': schemes.to_dict(),
|
||||
'subdomain_usage': len(url_df[url_df['netloc'].str.contains('\.', regex=True)]),
|
||||
'https_usage': schemes.get('https', 0) / len(url_df) * 100
|
||||
}
|
||||
|
||||
# URL Optimization Issues
|
||||
optimization_issues = []
|
||||
|
||||
# Check for non-HTTPS URLs
|
||||
if schemes.get('http', 0) > 0:
|
||||
optimization_issues.append(f"{schemes.get('http', 0)} pages not using HTTPS")
|
||||
|
||||
# Check for long URLs
|
||||
long_urls = len(url_lengths[url_lengths > 100])
|
||||
if long_urls > 0:
|
||||
optimization_issues.append(f"{long_urls} URLs are too long (>100 characters)")
|
||||
|
||||
# Check for deep paths
|
||||
if 'path_analysis' in url_analysis:
|
||||
deep_paths = url_analysis['path_analysis']['deep_paths_count']
|
||||
if deep_paths > 0:
|
||||
optimization_issues.append(f"{deep_paths} URLs have deep path structures (>4 levels)")
|
||||
|
||||
url_analysis['url_optimization'] = {
|
||||
'issues_found': len(optimization_issues),
|
||||
'optimization_recommendations': optimization_issues
|
||||
}
|
||||
|
||||
return url_analysis
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"Error analyzing URL structure: {str(e)}")
|
||||
return {}
|
||||
|
||||
def _analyze_image_seo(self, website_url: str) -> Dict[str, Any]:
|
||||
"""Analyze image SEO using adv.crawl_images."""
|
||||
try:
|
||||
st.info("🖼️ Analyzing image SEO...")
|
||||
|
||||
# Create image crawl output file
|
||||
image_file = os.path.join(self.temp_dir, "image_crawl.jl")
|
||||
|
||||
# Crawl images
|
||||
adv.crawl_images(
|
||||
url_list=[website_url],
|
||||
output_file=image_file,
|
||||
custom_settings={
|
||||
'DEPTH_LIMIT': 2,
|
||||
'CLOSESPIDER_PAGECOUNT': 100,
|
||||
'DOWNLOAD_DELAY': 1
|
||||
}
|
||||
)
|
||||
|
||||
image_analysis = {
|
||||
'image_count': 0,
|
||||
'alt_text_analysis': {},
|
||||
'image_format_analysis': {},
|
||||
'image_size_analysis': {},
|
||||
'optimization_opportunities': []
|
||||
}
|
||||
|
||||
if os.path.exists(image_file):
|
||||
image_df = pd.read_json(image_file, lines=True)
|
||||
|
||||
image_analysis['image_count'] = len(image_df)
|
||||
|
||||
# Alt text analysis
|
||||
if 'img_alt' in image_df.columns:
|
||||
alt_texts = image_df['img_alt'].dropna()
|
||||
missing_alt = len(image_df) - len(alt_texts)
|
||||
|
||||
image_analysis['alt_text_analysis'] = {
|
||||
'images_with_alt': len(alt_texts),
|
||||
'images_missing_alt': missing_alt,
|
||||
'alt_text_coverage': len(alt_texts) / len(image_df) * 100,
|
||||
'avg_alt_length': alt_texts.str.len().mean() if len(alt_texts) > 0 else 0
|
||||
}
|
||||
|
||||
# Image format analysis
|
||||
if 'img_src' in image_df.columns:
|
||||
# Extract file extensions
|
||||
extensions = image_df['img_src'].str.extract(r'\.([a-zA-Z]{2,4})(?:\?|$)')
|
||||
format_counts = extensions[0].value_counts()
|
||||
|
||||
image_analysis['image_format_analysis'] = {
|
||||
'format_distribution': format_counts.to_dict(),
|
||||
'modern_format_usage': format_counts.get('webp', 0) + format_counts.get('avif', 0)
|
||||
}
|
||||
|
||||
return image_analysis
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"Error analyzing images: {str(e)}")
|
||||
return {}
|
||||
|
||||
def _analyze_security_headers(self, website_url: str) -> Dict[str, Any]:
|
||||
"""Analyze security headers using adv.crawl_headers."""
|
||||
try:
|
||||
st.info("🛡️ Analyzing security headers...")
|
||||
|
||||
# Create headers output file
|
||||
headers_file = os.path.join(self.temp_dir, "security_headers.jl")
|
||||
|
||||
# Crawl headers
|
||||
adv.crawl_headers([website_url], output_file=headers_file)
|
||||
|
||||
security_analysis = {
|
||||
'security_headers_present': {},
|
||||
'security_score': 0,
|
||||
'security_recommendations': []
|
||||
}
|
||||
|
||||
if os.path.exists(headers_file):
|
||||
headers_df = pd.read_json(headers_file, lines=True)
|
||||
|
||||
# Check for important security headers
|
||||
security_headers = {
|
||||
'X-Frame-Options': 'resp_headers_X-Frame-Options',
|
||||
'X-Content-Type-Options': 'resp_headers_X-Content-Type-Options',
|
||||
'X-XSS-Protection': 'resp_headers_X-XSS-Protection',
|
||||
'Strict-Transport-Security': 'resp_headers_Strict-Transport-Security',
|
||||
'Content-Security-Policy': 'resp_headers_Content-Security-Policy',
|
||||
'Referrer-Policy': 'resp_headers_Referrer-Policy'
|
||||
}
|
||||
|
||||
headers_present = {}
|
||||
for header_name, column_name in security_headers.items():
|
||||
is_present = column_name in headers_df.columns and headers_df[column_name].notna().any()
|
||||
headers_present[header_name] = is_present
|
||||
|
||||
security_analysis['security_headers_present'] = headers_present
|
||||
|
||||
# Calculate security score
|
||||
present_count = sum(headers_present.values())
|
||||
security_analysis['security_score'] = (present_count / len(security_headers)) * 100
|
||||
|
||||
# Generate recommendations
|
||||
recommendations = []
|
||||
for header_name, is_present in headers_present.items():
|
||||
if not is_present:
|
||||
recommendations.append(f"Add {header_name} header for improved security")
|
||||
|
||||
security_analysis['security_recommendations'] = recommendations
|
||||
|
||||
return security_analysis
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"Error analyzing security headers: {str(e)}")
|
||||
return {}
|
||||
|
||||
def _analyze_mobile_seo(self, crawl_data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Analyze mobile SEO factors."""
|
||||
try:
|
||||
st.info("📱 Analyzing mobile SEO factors...")
|
||||
|
||||
if 'crawl_dataframe' not in crawl_data:
|
||||
return {}
|
||||
|
||||
df = crawl_data['crawl_dataframe']
|
||||
|
||||
mobile_analysis = {
|
||||
'viewport_analysis': {},
|
||||
'mobile_optimization': {},
|
||||
'responsive_design_indicators': {}
|
||||
}
|
||||
|
||||
# Viewport meta tag analysis
|
||||
if 'viewport' in df.columns:
|
||||
viewport_present = df['viewport'].notna().sum()
|
||||
mobile_analysis['viewport_analysis'] = {
|
||||
'pages_with_viewport': viewport_present,
|
||||
'viewport_coverage': viewport_present / len(df) * 100,
|
||||
'pages_missing_viewport': len(df) - viewport_present
|
||||
}
|
||||
|
||||
# Check for mobile-specific meta tags and indicators
|
||||
mobile_indicators = []
|
||||
|
||||
# Check for touch icons
|
||||
if any('touch-icon' in col for col in df.columns):
|
||||
mobile_indicators.append("Touch icons configured")
|
||||
|
||||
# Check for responsive design indicators in content
|
||||
# This is a simplified check - in practice, you'd analyze CSS and page structure
|
||||
mobile_analysis['mobile_optimization'] = {
|
||||
'mobile_indicators_found': len(mobile_indicators),
|
||||
'mobile_indicators': mobile_indicators
|
||||
}
|
||||
|
||||
return mobile_analysis
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"Error analyzing mobile SEO: {str(e)}")
|
||||
return {}
|
||||
|
||||
def _generate_technical_recommendations(self, results: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Generate AI-powered technical SEO recommendations."""
|
||||
try:
|
||||
st.info("🤖 Generating technical recommendations...")
|
||||
|
||||
# Prepare technical analysis summary for AI
|
||||
technical_summary = {
|
||||
'website_url': results.get('website_url', ''),
|
||||
'pages_crawled': results.get('crawl_overview', {}).get('pages_crawled', 0),
|
||||
'error_count': results.get('technical_issues', {}).get('http_errors', {}).get('total_errors', 0),
|
||||
'avg_load_time': results.get('performance_analysis', {}).get('load_time_analysis', {}).get('avg_load_time', 0),
|
||||
'security_score': results.get('security_headers', {}).get('security_score', 0),
|
||||
'missing_titles': results.get('content_analysis', {}).get('title_analysis', {}).get('missing_titles', 0),
|
||||
'missing_meta_desc': results.get('content_analysis', {}).get('meta_description_analysis', {}).get('missing_meta_descriptions', 0)
|
||||
}
|
||||
|
||||
# Generate AI recommendations
|
||||
prompt = f"""
|
||||
As a technical SEO expert, analyze this comprehensive website audit and provide prioritized recommendations:
|
||||
|
||||
WEBSITE: {technical_summary['website_url']}
|
||||
PAGES ANALYZED: {technical_summary['pages_crawled']}
|
||||
|
||||
TECHNICAL ISSUES:
|
||||
- HTTP Errors: {technical_summary['error_count']}
|
||||
- Average Load Time: {technical_summary['avg_load_time']:.2f}s
|
||||
- Security Score: {technical_summary['security_score']:.1f}%
|
||||
- Missing Titles: {technical_summary['missing_titles']}
|
||||
- Missing Meta Descriptions: {technical_summary['missing_meta_desc']}
|
||||
|
||||
PROVIDE:
|
||||
1. Critical Issues (Fix Immediately)
|
||||
2. High Priority Optimizations
|
||||
3. Medium Priority Improvements
|
||||
4. Long-term Technical Strategy
|
||||
5. Specific Implementation Steps
|
||||
6. Expected Impact Assessment
|
||||
|
||||
Format as JSON with clear priorities and actionable recommendations.
|
||||
"""
|
||||
|
||||
ai_response = llm_text_gen(
|
||||
prompt=prompt,
|
||||
system_prompt="You are a senior technical SEO specialist with expertise in website optimization, Core Web Vitals, and search engine best practices.",
|
||||
response_format="json_object"
|
||||
)
|
||||
|
||||
if ai_response:
|
||||
return ai_response
|
||||
else:
|
||||
return {'recommendations': ['AI recommendations temporarily unavailable']}
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"Error generating recommendations: {str(e)}")
|
||||
return {}
|
||||
|
||||
def _find_redirect_chains(self, redirects_df: pd.DataFrame) -> List[Dict[str, Any]]:
|
||||
"""Find redirect chains in the crawled data."""
|
||||
# Simplified redirect chain detection
|
||||
# In a full implementation, you'd trace the redirect paths
|
||||
redirect_chains = []
|
||||
|
||||
if len(redirects_df) > 0:
|
||||
# Group redirects by status code
|
||||
for status_code in redirects_df['status'].unique():
|
||||
status_redirects = redirects_df[redirects_df['status'] == status_code]
|
||||
redirect_chains.append({
|
||||
'status_code': int(status_code),
|
||||
'count': len(status_redirects),
|
||||
'examples': status_redirects['url'].head(5).tolist()
|
||||
})
|
||||
|
||||
return redirect_chains
|
||||
968
ToBeMigrated/ai_seo_tools/technical_seo_crawler/ui.py
Normal file
968
ToBeMigrated/ai_seo_tools/technical_seo_crawler/ui.py
Normal file
@@ -0,0 +1,968 @@
|
||||
"""
|
||||
Technical SEO Crawler UI with Comprehensive Analysis Dashboard.
|
||||
|
||||
This module provides a professional Streamlit interface for the Technical SEO Crawler
|
||||
with detailed analysis results, visualization, and export capabilities.
|
||||
"""
|
||||
|
||||
import streamlit as st
|
||||
import pandas as pd
|
||||
from typing import Dict, Any, List
|
||||
import json
|
||||
from datetime import datetime
|
||||
import io
|
||||
import base64
|
||||
import plotly.express as px
|
||||
import plotly.graph_objects as go
|
||||
from plotly.subplots import make_subplots
|
||||
|
||||
from .crawler import TechnicalSEOCrawler
|
||||
from lib.alwrity_ui.dashboard_styles import apply_dashboard_style, render_dashboard_header
|
||||
|
||||
class TechnicalSEOCrawlerUI:
|
||||
"""Professional UI for Technical SEO Crawler."""
|
||||
|
||||
def __init__(self):
|
||||
"""Initialize the Technical SEO Crawler UI."""
|
||||
self.crawler = TechnicalSEOCrawler()
|
||||
|
||||
# Apply dashboard styling
|
||||
apply_dashboard_style()
|
||||
|
||||
def render(self):
|
||||
"""Render the Technical SEO Crawler interface."""
|
||||
|
||||
# Enhanced dashboard header
|
||||
render_dashboard_header(
|
||||
"🔧 Technical SEO Crawler",
|
||||
"Comprehensive site-wide technical SEO analysis with AI-powered recommendations. Identify and fix technical issues that impact your search rankings."
|
||||
)
|
||||
|
||||
# Main content area
|
||||
with st.container():
|
||||
# Analysis input form
|
||||
self._render_crawler_form()
|
||||
|
||||
# Session state for results
|
||||
if 'technical_seo_results' in st.session_state and st.session_state.technical_seo_results:
|
||||
st.markdown("---")
|
||||
self._render_results_dashboard(st.session_state.technical_seo_results)
|
||||
|
||||
def _render_crawler_form(self):
|
||||
"""Render the crawler configuration form."""
|
||||
st.markdown("## 🚀 Configure Technical SEO Audit")
|
||||
|
||||
with st.form("technical_seo_crawler_form"):
|
||||
# Website URL input
|
||||
col1, col2 = st.columns([3, 1])
|
||||
|
||||
with col1:
|
||||
website_url = st.text_input(
|
||||
"🌐 Website URL to Audit",
|
||||
placeholder="https://yourwebsite.com",
|
||||
help="Enter the website URL for comprehensive technical SEO analysis"
|
||||
)
|
||||
|
||||
with col2:
|
||||
audit_type = st.selectbox(
|
||||
"🎯 Audit Type",
|
||||
options=["Standard", "Deep", "Quick"],
|
||||
help="Choose the depth of analysis"
|
||||
)
|
||||
|
||||
# Crawl configuration
|
||||
st.markdown("### ⚙️ Crawl Configuration")
|
||||
|
||||
col1, col2, col3 = st.columns(3)
|
||||
|
||||
with col1:
|
||||
if audit_type == "Quick":
|
||||
crawl_depth = st.slider("Crawl Depth", 1, 2, 1)
|
||||
max_pages = st.slider("Max Pages", 10, 100, 50)
|
||||
elif audit_type == "Deep":
|
||||
crawl_depth = st.slider("Crawl Depth", 1, 5, 4)
|
||||
max_pages = st.slider("Max Pages", 100, 1000, 500)
|
||||
else: # Standard
|
||||
crawl_depth = st.slider("Crawl Depth", 1, 4, 3)
|
||||
max_pages = st.slider("Max Pages", 50, 500, 200)
|
||||
|
||||
with col2:
|
||||
analyze_images = st.checkbox(
|
||||
"🖼️ Analyze Images",
|
||||
value=True,
|
||||
help="Include image SEO analysis"
|
||||
)
|
||||
|
||||
analyze_security = st.checkbox(
|
||||
"🛡️ Security Headers",
|
||||
value=True,
|
||||
help="Analyze security headers"
|
||||
)
|
||||
|
||||
with col3:
|
||||
analyze_mobile = st.checkbox(
|
||||
"📱 Mobile SEO",
|
||||
value=True,
|
||||
help="Include mobile SEO analysis"
|
||||
)
|
||||
|
||||
ai_recommendations = st.checkbox(
|
||||
"🤖 AI Recommendations",
|
||||
value=True,
|
||||
help="Generate AI-powered recommendations"
|
||||
)
|
||||
|
||||
# Analysis scope
|
||||
st.markdown("### 🎯 Analysis Scope")
|
||||
|
||||
analysis_options = st.multiselect(
|
||||
"Select Analysis Components",
|
||||
options=[
|
||||
"Technical Issues Detection",
|
||||
"Performance Analysis",
|
||||
"Content Structure Analysis",
|
||||
"URL Structure Optimization",
|
||||
"Internal Linking Analysis",
|
||||
"Duplicate Content Detection"
|
||||
],
|
||||
default=[
|
||||
"Technical Issues Detection",
|
||||
"Performance Analysis",
|
||||
"Content Structure Analysis"
|
||||
],
|
||||
help="Choose which analysis components to include"
|
||||
)
|
||||
|
||||
# Submit button
|
||||
submitted = st.form_submit_button(
|
||||
"🚀 Start Technical SEO Audit",
|
||||
use_container_width=True,
|
||||
type="primary"
|
||||
)
|
||||
|
||||
if submitted:
|
||||
# Validate inputs
|
||||
if not website_url or not website_url.startswith(('http://', 'https://')):
|
||||
st.error("❌ Please enter a valid website URL starting with http:// or https://")
|
||||
return
|
||||
|
||||
# Run technical SEO analysis
|
||||
self._run_technical_analysis(
|
||||
website_url=website_url,
|
||||
crawl_depth=crawl_depth,
|
||||
max_pages=max_pages,
|
||||
options={
|
||||
'analyze_images': analyze_images,
|
||||
'analyze_security': analyze_security,
|
||||
'analyze_mobile': analyze_mobile,
|
||||
'ai_recommendations': ai_recommendations,
|
||||
'analysis_scope': analysis_options
|
||||
}
|
||||
)
|
||||
|
||||
def _run_technical_analysis(self, website_url: str, crawl_depth: int,
|
||||
max_pages: int, options: Dict[str, Any]):
|
||||
"""Run the technical SEO analysis."""
|
||||
|
||||
try:
|
||||
with st.spinner("🔄 Running Comprehensive Technical SEO Audit..."):
|
||||
|
||||
# Initialize progress tracking
|
||||
progress_bar = st.progress(0)
|
||||
status_text = st.empty()
|
||||
|
||||
# Update progress
|
||||
progress_bar.progress(10)
|
||||
status_text.text("🚀 Initializing technical SEO crawler...")
|
||||
|
||||
# Run comprehensive analysis
|
||||
results = self.crawler.analyze_website_technical_seo(
|
||||
website_url=website_url,
|
||||
crawl_depth=crawl_depth,
|
||||
max_pages=max_pages
|
||||
)
|
||||
|
||||
progress_bar.progress(100)
|
||||
status_text.text("✅ Technical SEO audit complete!")
|
||||
|
||||
# Store results in session state
|
||||
st.session_state.technical_seo_results = results
|
||||
|
||||
# Clear progress indicators
|
||||
progress_bar.empty()
|
||||
status_text.empty()
|
||||
|
||||
if 'error' in results:
|
||||
st.error(f"❌ Analysis failed: {results['error']}")
|
||||
else:
|
||||
st.success("🎉 Technical SEO Audit completed successfully!")
|
||||
st.balloons()
|
||||
|
||||
# Rerun to show results
|
||||
st.rerun()
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"❌ Error running technical analysis: {str(e)}")
|
||||
|
||||
def _render_results_dashboard(self, results: Dict[str, Any]):
|
||||
"""Render the comprehensive results dashboard."""
|
||||
|
||||
if 'error' in results:
|
||||
st.error(f"❌ Analysis Error: {results['error']}")
|
||||
return
|
||||
|
||||
# Results header
|
||||
st.markdown("## 📊 Technical SEO Audit Results")
|
||||
|
||||
# Key metrics overview
|
||||
self._render_metrics_overview(results)
|
||||
|
||||
# Detailed analysis tabs
|
||||
self._render_detailed_analysis(results)
|
||||
|
||||
# Export functionality
|
||||
self._render_export_options(results)
|
||||
|
||||
def _render_metrics_overview(self, results: Dict[str, Any]):
|
||||
"""Render key metrics overview."""
|
||||
|
||||
st.markdown("### 📈 Audit Overview")
|
||||
|
||||
# Create metrics columns
|
||||
col1, col2, col3, col4, col5, col6 = st.columns(6)
|
||||
|
||||
with col1:
|
||||
pages_crawled = results.get('crawl_overview', {}).get('pages_crawled', 0)
|
||||
st.metric(
|
||||
"🕷️ Pages Crawled",
|
||||
pages_crawled,
|
||||
help="Total pages analyzed"
|
||||
)
|
||||
|
||||
with col2:
|
||||
error_count = results.get('technical_issues', {}).get('http_errors', {}).get('total_errors', 0)
|
||||
st.metric(
|
||||
"❌ HTTP Errors",
|
||||
error_count,
|
||||
delta=f"-{error_count}" if error_count > 0 else None,
|
||||
help="Pages with HTTP errors (4xx, 5xx)"
|
||||
)
|
||||
|
||||
with col3:
|
||||
avg_load_time = results.get('performance_analysis', {}).get('load_time_analysis', {}).get('avg_load_time', 0)
|
||||
st.metric(
|
||||
"⚡ Avg Load Time",
|
||||
f"{avg_load_time:.2f}s",
|
||||
delta=f"+{avg_load_time:.2f}s" if avg_load_time > 3 else None,
|
||||
help="Average page load time"
|
||||
)
|
||||
|
||||
with col4:
|
||||
security_score = results.get('security_headers', {}).get('security_score', 0)
|
||||
st.metric(
|
||||
"🛡️ Security Score",
|
||||
f"{security_score:.0f}%",
|
||||
delta=f"{security_score:.0f}%" if security_score < 100 else None,
|
||||
help="Security headers implementation score"
|
||||
)
|
||||
|
||||
with col5:
|
||||
missing_titles = results.get('content_analysis', {}).get('title_analysis', {}).get('missing_titles', 0)
|
||||
st.metric(
|
||||
"📝 Missing Titles",
|
||||
missing_titles,
|
||||
delta=f"-{missing_titles}" if missing_titles > 0 else None,
|
||||
help="Pages without title tags"
|
||||
)
|
||||
|
||||
with col6:
|
||||
image_count = results.get('image_optimization', {}).get('image_count', 0)
|
||||
st.metric(
|
||||
"🖼️ Images Analyzed",
|
||||
image_count,
|
||||
help="Total images found and analyzed"
|
||||
)
|
||||
|
||||
# Analysis timestamp
|
||||
if results.get('analysis_timestamp'):
|
||||
timestamp = datetime.fromisoformat(results['analysis_timestamp'].replace('Z', '+00:00'))
|
||||
st.caption(f"📅 Audit completed: {timestamp.strftime('%Y-%m-%d %H:%M:%S UTC')}")
|
||||
|
||||
def _render_detailed_analysis(self, results: Dict[str, Any]):
|
||||
"""Render detailed analysis in tabs."""
|
||||
|
||||
# Create main analysis tabs
|
||||
tab1, tab2, tab3, tab4, tab5, tab6, tab7 = st.tabs([
|
||||
"🔍 Technical Issues",
|
||||
"⚡ Performance",
|
||||
"📊 Content Analysis",
|
||||
"🔗 URL Structure",
|
||||
"🖼️ Image SEO",
|
||||
"🛡️ Security",
|
||||
"🤖 AI Recommendations"
|
||||
])
|
||||
|
||||
with tab1:
|
||||
self._render_technical_issues(results.get('technical_issues', {}))
|
||||
|
||||
with tab2:
|
||||
self._render_performance_analysis(results.get('performance_analysis', {}))
|
||||
|
||||
with tab3:
|
||||
self._render_content_analysis(results.get('content_analysis', {}))
|
||||
|
||||
with tab4:
|
||||
self._render_url_structure(results.get('url_structure', {}))
|
||||
|
||||
with tab5:
|
||||
self._render_image_analysis(results.get('image_optimization', {}))
|
||||
|
||||
with tab6:
|
||||
self._render_security_analysis(results.get('security_headers', {}))
|
||||
|
||||
with tab7:
|
||||
self._render_ai_recommendations(results.get('ai_recommendations', {}))
|
||||
|
||||
def _render_technical_issues(self, technical_data: Dict[str, Any]):
|
||||
"""Render technical issues analysis."""
|
||||
|
||||
st.markdown("### 🔍 Technical SEO Issues")
|
||||
|
||||
if not technical_data:
|
||||
st.info("No technical issues data available")
|
||||
return
|
||||
|
||||
# HTTP Errors
|
||||
if technical_data.get('http_errors'):
|
||||
http_errors = technical_data['http_errors']
|
||||
|
||||
st.markdown("#### ❌ HTTP Status Code Errors")
|
||||
|
||||
if http_errors.get('total_errors', 0) > 0:
|
||||
st.error(f"Found {http_errors['total_errors']} pages with HTTP errors!")
|
||||
|
||||
# Error breakdown chart
|
||||
if http_errors.get('error_breakdown'):
|
||||
error_df = pd.DataFrame(
|
||||
list(http_errors['error_breakdown'].items()),
|
||||
columns=['Status Code', 'Count']
|
||||
)
|
||||
|
||||
fig = px.bar(error_df, x='Status Code', y='Count',
|
||||
title="HTTP Error Distribution")
|
||||
st.plotly_chart(fig, use_container_width=True)
|
||||
|
||||
# Error pages table
|
||||
if http_errors.get('error_pages'):
|
||||
st.markdown("**Pages with Errors:**")
|
||||
error_pages_df = pd.DataFrame(http_errors['error_pages'])
|
||||
st.dataframe(error_pages_df, use_container_width=True)
|
||||
else:
|
||||
st.success("✅ No HTTP errors found!")
|
||||
|
||||
# Redirect Issues
|
||||
if technical_data.get('redirect_issues'):
|
||||
redirect_data = technical_data['redirect_issues']
|
||||
|
||||
st.markdown("#### 🔄 Redirect Analysis")
|
||||
|
||||
total_redirects = redirect_data.get('total_redirects', 0)
|
||||
|
||||
if total_redirects > 0:
|
||||
st.warning(f"Found {total_redirects} redirect(s)")
|
||||
|
||||
# Redirect types
|
||||
if redirect_data.get('redirect_types'):
|
||||
redirect_df = pd.DataFrame(
|
||||
list(redirect_data['redirect_types'].items()),
|
||||
columns=['Redirect Type', 'Count']
|
||||
)
|
||||
st.bar_chart(redirect_df.set_index('Redirect Type'))
|
||||
else:
|
||||
st.success("✅ No redirects found")
|
||||
|
||||
# Duplicate Content
|
||||
if technical_data.get('duplicate_content'):
|
||||
duplicate_data = technical_data['duplicate_content']
|
||||
|
||||
st.markdown("#### 📋 Duplicate Content Issues")
|
||||
|
||||
duplicate_titles = duplicate_data.get('duplicate_titles', 0)
|
||||
|
||||
if duplicate_titles > 0:
|
||||
st.warning(f"Found {duplicate_titles} duplicate title(s)")
|
||||
|
||||
# Show duplicate title groups
|
||||
if duplicate_data.get('pages_with_duplicate_titles'):
|
||||
duplicate_df = pd.DataFrame(duplicate_data['pages_with_duplicate_titles'])
|
||||
st.dataframe(duplicate_df, use_container_width=True)
|
||||
else:
|
||||
st.success("✅ No duplicate titles found")
|
||||
|
||||
# Missing Elements
|
||||
if technical_data.get('missing_elements'):
|
||||
missing_data = technical_data['missing_elements']
|
||||
|
||||
st.markdown("#### 📝 Missing SEO Elements")
|
||||
|
||||
col1, col2, col3 = st.columns(3)
|
||||
|
||||
with col1:
|
||||
missing_titles = missing_data.get('missing_titles', 0)
|
||||
if missing_titles > 0:
|
||||
st.error(f"Missing Titles: {missing_titles}")
|
||||
else:
|
||||
st.success("All pages have titles ✅")
|
||||
|
||||
with col2:
|
||||
missing_meta = missing_data.get('missing_meta_desc', 0)
|
||||
if missing_meta > 0:
|
||||
st.error(f"Missing Meta Descriptions: {missing_meta}")
|
||||
else:
|
||||
st.success("All pages have meta descriptions ✅")
|
||||
|
||||
with col3:
|
||||
missing_h1 = missing_data.get('missing_h1', 0)
|
||||
if missing_h1 > 0:
|
||||
st.error(f"Missing H1 tags: {missing_h1}")
|
||||
else:
|
||||
st.success("All pages have H1 tags ✅")
|
||||
|
||||
def _render_performance_analysis(self, performance_data: Dict[str, Any]):
|
||||
"""Render performance analysis."""
|
||||
|
||||
st.markdown("### ⚡ Website Performance Analysis")
|
||||
|
||||
if not performance_data:
|
||||
st.info("No performance data available")
|
||||
return
|
||||
|
||||
# Load Time Analysis
|
||||
if performance_data.get('load_time_analysis'):
|
||||
load_time_data = performance_data['load_time_analysis']
|
||||
|
||||
st.markdown("#### 🚀 Page Load Time Analysis")
|
||||
|
||||
col1, col2, col3 = st.columns(3)
|
||||
|
||||
with col1:
|
||||
avg_load = load_time_data.get('avg_load_time', 0)
|
||||
st.metric("Average Load Time", f"{avg_load:.2f}s")
|
||||
|
||||
with col2:
|
||||
median_load = load_time_data.get('median_load_time', 0)
|
||||
st.metric("Median Load Time", f"{median_load:.2f}s")
|
||||
|
||||
with col3:
|
||||
p95_load = load_time_data.get('p95_load_time', 0)
|
||||
st.metric("95th Percentile", f"{p95_load:.2f}s")
|
||||
|
||||
# Performance distribution
|
||||
if load_time_data.get('performance_distribution'):
|
||||
perf_dist = load_time_data['performance_distribution']
|
||||
|
||||
# Create pie chart for performance distribution
|
||||
labels = ['Fast (≤1s)', 'Moderate (1-3s)', 'Slow (>3s)']
|
||||
values = [
|
||||
perf_dist.get('fast_pages', 0),
|
||||
perf_dist.get('moderate_pages', 0),
|
||||
perf_dist.get('slow_pages', 0)
|
||||
]
|
||||
|
||||
fig = px.pie(values=values, names=labels,
|
||||
title="Page Load Time Distribution")
|
||||
st.plotly_chart(fig, use_container_width=True)
|
||||
|
||||
# Content Size Analysis
|
||||
if performance_data.get('content_size_analysis'):
|
||||
size_data = performance_data['content_size_analysis']
|
||||
|
||||
st.markdown("#### 📦 Content Size Analysis")
|
||||
|
||||
col1, col2, col3 = st.columns(3)
|
||||
|
||||
with col1:
|
||||
avg_size = size_data.get('avg_page_size', 0)
|
||||
st.metric("Average Page Size", f"{avg_size/1024:.1f} KB")
|
||||
|
||||
with col2:
|
||||
largest_size = size_data.get('largest_page', 0)
|
||||
st.metric("Largest Page", f"{largest_size/1024:.1f} KB")
|
||||
|
||||
with col3:
|
||||
large_pages = size_data.get('pages_over_1mb', 0)
|
||||
st.metric("Pages >1MB", large_pages)
|
||||
|
||||
# Server Performance
|
||||
if performance_data.get('server_performance'):
|
||||
server_data = performance_data['server_performance']
|
||||
|
||||
st.markdown("#### 🖥️ Server Performance")
|
||||
|
||||
col1, col2, col3 = st.columns(3)
|
||||
|
||||
with col1:
|
||||
success_rate = server_data.get('success_rate', 0)
|
||||
st.metric("Success Rate", f"{success_rate:.1f}%")
|
||||
|
||||
with col2:
|
||||
error_rate = server_data.get('error_rate', 0)
|
||||
st.metric("Error Rate", f"{error_rate:.1f}%")
|
||||
|
||||
with col3:
|
||||
redirect_rate = server_data.get('redirect_rate', 0)
|
||||
st.metric("Redirect Rate", f"{redirect_rate:.1f}%")
|
||||
|
||||
def _render_content_analysis(self, content_data: Dict[str, Any]):
|
||||
"""Render content structure analysis."""
|
||||
|
||||
st.markdown("### 📊 Content Structure Analysis")
|
||||
|
||||
if not content_data:
|
||||
st.info("No content analysis data available")
|
||||
return
|
||||
|
||||
# Title Analysis
|
||||
if content_data.get('title_analysis'):
|
||||
title_data = content_data['title_analysis']
|
||||
|
||||
st.markdown("#### 📝 Title Tag Analysis")
|
||||
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
avg_title_length = title_data.get('avg_title_length', 0)
|
||||
st.metric("Average Title Length", f"{avg_title_length:.0f} chars")
|
||||
|
||||
duplicate_titles = title_data.get('duplicate_titles', 0)
|
||||
st.metric("Duplicate Titles", duplicate_titles)
|
||||
|
||||
with col2:
|
||||
# Title length distribution
|
||||
if title_data.get('title_length_distribution'):
|
||||
length_dist = title_data['title_length_distribution']
|
||||
|
||||
labels = ['Too Short (<30)', 'Optimal (30-60)', 'Too Long (>60)']
|
||||
values = [
|
||||
length_dist.get('too_short', 0),
|
||||
length_dist.get('optimal', 0),
|
||||
length_dist.get('too_long', 0)
|
||||
]
|
||||
|
||||
fig = px.pie(values=values, names=labels,
|
||||
title="Title Length Distribution")
|
||||
st.plotly_chart(fig, use_container_width=True)
|
||||
|
||||
# Meta Description Analysis
|
||||
if content_data.get('meta_description_analysis'):
|
||||
meta_data = content_data['meta_description_analysis']
|
||||
|
||||
st.markdown("#### 🏷️ Meta Description Analysis")
|
||||
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
avg_meta_length = meta_data.get('avg_meta_length', 0)
|
||||
st.metric("Average Meta Length", f"{avg_meta_length:.0f} chars")
|
||||
|
||||
missing_meta = meta_data.get('missing_meta_descriptions', 0)
|
||||
st.metric("Missing Meta Descriptions", missing_meta)
|
||||
|
||||
with col2:
|
||||
# Meta length distribution
|
||||
if meta_data.get('meta_length_distribution'):
|
||||
meta_dist = meta_data['meta_length_distribution']
|
||||
|
||||
labels = ['Too Short (<120)', 'Optimal (120-160)', 'Too Long (>160)']
|
||||
values = [
|
||||
meta_dist.get('too_short', 0),
|
||||
meta_dist.get('optimal', 0),
|
||||
meta_dist.get('too_long', 0)
|
||||
]
|
||||
|
||||
fig = px.pie(values=values, names=labels,
|
||||
title="Meta Description Length Distribution")
|
||||
st.plotly_chart(fig, use_container_width=True)
|
||||
|
||||
# Heading Structure
|
||||
if content_data.get('heading_structure'):
|
||||
heading_data = content_data['heading_structure']
|
||||
|
||||
st.markdown("#### 📋 Heading Structure Analysis")
|
||||
|
||||
# Create heading usage chart
|
||||
heading_usage = []
|
||||
for heading_type, data in heading_data.items():
|
||||
heading_usage.append({
|
||||
'Heading': heading_type.replace('_usage', '').upper(),
|
||||
'Usage Rate': data.get('usage_rate', 0),
|
||||
'Pages': data.get('pages_with_heading', 0)
|
||||
})
|
||||
|
||||
if heading_usage:
|
||||
heading_df = pd.DataFrame(heading_usage)
|
||||
|
||||
fig = px.bar(heading_df, x='Heading', y='Usage Rate',
|
||||
title="Heading Tag Usage Rates")
|
||||
st.plotly_chart(fig, use_container_width=True)
|
||||
|
||||
st.dataframe(heading_df, use_container_width=True)
|
||||
|
||||
def _render_url_structure(self, url_data: Dict[str, Any]):
|
||||
"""Render URL structure analysis."""
|
||||
|
||||
st.markdown("### 🔗 URL Structure Analysis")
|
||||
|
||||
if not url_data:
|
||||
st.info("No URL structure data available")
|
||||
return
|
||||
|
||||
# URL Length Analysis
|
||||
if url_data.get('url_length_analysis'):
|
||||
length_data = url_data['url_length_analysis']
|
||||
|
||||
st.markdown("#### 📏 URL Length Analysis")
|
||||
|
||||
col1, col2, col3 = st.columns(3)
|
||||
|
||||
with col1:
|
||||
avg_length = length_data.get('avg_url_length', 0)
|
||||
st.metric("Average URL Length", f"{avg_length:.0f} chars")
|
||||
|
||||
with col2:
|
||||
max_length = length_data.get('max_url_length', 0)
|
||||
st.metric("Longest URL", f"{max_length:.0f} chars")
|
||||
|
||||
with col3:
|
||||
long_urls = length_data.get('long_urls_count', 0)
|
||||
st.metric("URLs >100 chars", long_urls)
|
||||
|
||||
# URL Structure Patterns
|
||||
if url_data.get('url_structure_patterns'):
|
||||
pattern_data = url_data['url_structure_patterns']
|
||||
|
||||
st.markdown("#### 🏗️ URL Structure Patterns")
|
||||
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
https_usage = pattern_data.get('https_usage', 0)
|
||||
st.metric("HTTPS Usage", f"{https_usage:.1f}%")
|
||||
|
||||
with col2:
|
||||
subdomain_usage = pattern_data.get('subdomain_usage', 0)
|
||||
st.metric("Subdomains Found", subdomain_usage)
|
||||
|
||||
# Path Analysis
|
||||
if url_data.get('path_analysis'):
|
||||
path_data = url_data['path_analysis']
|
||||
|
||||
st.markdown("#### 📂 Path Depth Analysis")
|
||||
|
||||
col1, col2, col3 = st.columns(3)
|
||||
|
||||
with col1:
|
||||
avg_depth = path_data.get('avg_path_depth', 0)
|
||||
st.metric("Average Path Depth", f"{avg_depth:.1f}")
|
||||
|
||||
with col2:
|
||||
max_depth = path_data.get('max_path_depth', 0)
|
||||
st.metric("Maximum Depth", max_depth)
|
||||
|
||||
with col3:
|
||||
deep_paths = path_data.get('deep_paths_count', 0)
|
||||
st.metric("Deep Paths (>4)", deep_paths)
|
||||
|
||||
# Optimization Issues
|
||||
if url_data.get('url_optimization'):
|
||||
opt_data = url_data['url_optimization']
|
||||
|
||||
st.markdown("#### ⚠️ URL Optimization Issues")
|
||||
|
||||
issues_found = opt_data.get('issues_found', 0)
|
||||
recommendations = opt_data.get('optimization_recommendations', [])
|
||||
|
||||
if issues_found > 0:
|
||||
st.warning(f"Found {issues_found} URL optimization issue(s)")
|
||||
|
||||
for rec in recommendations:
|
||||
st.write(f"• {rec}")
|
||||
else:
|
||||
st.success("✅ No URL optimization issues found")
|
||||
|
||||
def _render_image_analysis(self, image_data: Dict[str, Any]):
|
||||
"""Render image SEO analysis."""
|
||||
|
||||
st.markdown("### 🖼️ Image SEO Analysis")
|
||||
|
||||
if not image_data:
|
||||
st.info("No image analysis data available")
|
||||
return
|
||||
|
||||
# Image overview
|
||||
image_count = image_data.get('image_count', 0)
|
||||
st.metric("Total Images Found", image_count)
|
||||
|
||||
if image_count > 0:
|
||||
# Alt text analysis
|
||||
if image_data.get('alt_text_analysis'):
|
||||
alt_data = image_data['alt_text_analysis']
|
||||
|
||||
st.markdown("#### 📝 Alt Text Analysis")
|
||||
|
||||
col1, col2, col3 = st.columns(3)
|
||||
|
||||
with col1:
|
||||
images_with_alt = alt_data.get('images_with_alt', 0)
|
||||
st.metric("Images with Alt Text", images_with_alt)
|
||||
|
||||
with col2:
|
||||
images_missing_alt = alt_data.get('images_missing_alt', 0)
|
||||
st.metric("Missing Alt Text", images_missing_alt)
|
||||
|
||||
with col3:
|
||||
alt_coverage = alt_data.get('alt_text_coverage', 0)
|
||||
st.metric("Alt Text Coverage", f"{alt_coverage:.1f}%")
|
||||
|
||||
# Image format analysis
|
||||
if image_data.get('image_format_analysis'):
|
||||
format_data = image_data['image_format_analysis']
|
||||
|
||||
st.markdown("#### 🎨 Image Format Analysis")
|
||||
|
||||
if format_data.get('format_distribution'):
|
||||
format_dist = format_data['format_distribution']
|
||||
|
||||
format_df = pd.DataFrame(
|
||||
list(format_dist.items()),
|
||||
columns=['Format', 'Count']
|
||||
)
|
||||
|
||||
fig = px.pie(format_df, values='Count', names='Format',
|
||||
title="Image Format Distribution")
|
||||
st.plotly_chart(fig, use_container_width=True)
|
||||
|
||||
modern_formats = format_data.get('modern_format_usage', 0)
|
||||
st.metric("Modern Formats (WebP/AVIF)", modern_formats)
|
||||
else:
|
||||
st.info("No images found to analyze")
|
||||
|
||||
def _render_security_analysis(self, security_data: Dict[str, Any]):
|
||||
"""Render security analysis."""
|
||||
|
||||
st.markdown("### 🛡️ Security Headers Analysis")
|
||||
|
||||
if not security_data:
|
||||
st.info("No security analysis data available")
|
||||
return
|
||||
|
||||
# Security score
|
||||
security_score = security_data.get('security_score', 0)
|
||||
|
||||
col1, col2 = st.columns([1, 2])
|
||||
|
||||
with col1:
|
||||
st.metric("Security Score", f"{security_score:.0f}%")
|
||||
|
||||
if security_score >= 80:
|
||||
st.success("🔒 Good security posture")
|
||||
elif security_score >= 50:
|
||||
st.warning("⚠️ Moderate security")
|
||||
else:
|
||||
st.error("🚨 Poor security posture")
|
||||
|
||||
with col2:
|
||||
# Security headers status
|
||||
if security_data.get('security_headers_present'):
|
||||
headers_status = security_data['security_headers_present']
|
||||
|
||||
st.markdown("**Security Headers Status:**")
|
||||
|
||||
for header, present in headers_status.items():
|
||||
status = "✅" if present else "❌"
|
||||
st.write(f"{status} {header}")
|
||||
|
||||
# Security recommendations
|
||||
if security_data.get('security_recommendations'):
|
||||
recommendations = security_data['security_recommendations']
|
||||
|
||||
if recommendations:
|
||||
st.markdown("#### 🔧 Security Recommendations")
|
||||
|
||||
for rec in recommendations:
|
||||
st.write(f"• {rec}")
|
||||
else:
|
||||
st.success("✅ All security headers properly configured")
|
||||
|
||||
def _render_ai_recommendations(self, ai_data: Dict[str, Any]):
|
||||
"""Render AI-generated recommendations."""
|
||||
|
||||
st.markdown("### 🤖 AI-Powered Technical Recommendations")
|
||||
|
||||
if not ai_data:
|
||||
st.info("No AI recommendations available")
|
||||
return
|
||||
|
||||
# Critical Issues
|
||||
if ai_data.get('critical_issues'):
|
||||
st.markdown("#### 🚨 Critical Issues (Fix Immediately)")
|
||||
|
||||
critical_issues = ai_data['critical_issues']
|
||||
for issue in critical_issues:
|
||||
st.error(f"🚨 {issue}")
|
||||
|
||||
# High Priority
|
||||
if ai_data.get('high_priority'):
|
||||
st.markdown("#### 🔥 High Priority Optimizations")
|
||||
|
||||
high_priority = ai_data['high_priority']
|
||||
for item in high_priority:
|
||||
st.warning(f"⚡ {item}")
|
||||
|
||||
# Medium Priority
|
||||
if ai_data.get('medium_priority'):
|
||||
st.markdown("#### 📈 Medium Priority Improvements")
|
||||
|
||||
medium_priority = ai_data['medium_priority']
|
||||
for item in medium_priority:
|
||||
st.info(f"📊 {item}")
|
||||
|
||||
# Implementation Steps
|
||||
if ai_data.get('implementation_steps'):
|
||||
st.markdown("#### 🛠️ Implementation Steps")
|
||||
|
||||
steps = ai_data['implementation_steps']
|
||||
for i, step in enumerate(steps, 1):
|
||||
st.write(f"{i}. {step}")
|
||||
|
||||
# Expected Impact
|
||||
if ai_data.get('expected_impact'):
|
||||
st.markdown("#### 📈 Expected Impact Assessment")
|
||||
|
||||
impact = ai_data['expected_impact']
|
||||
st.markdown(impact)
|
||||
|
||||
def _render_export_options(self, results: Dict[str, Any]):
|
||||
"""Render export options for analysis results."""
|
||||
|
||||
st.markdown("---")
|
||||
st.markdown("### 📥 Export Technical SEO Audit")
|
||||
|
||||
col1, col2, col3 = st.columns(3)
|
||||
|
||||
with col1:
|
||||
# JSON export
|
||||
if st.button("📄 Export Full Report (JSON)", use_container_width=True):
|
||||
json_data = json.dumps(results, indent=2, default=str)
|
||||
|
||||
st.download_button(
|
||||
label="⬇️ Download JSON Report",
|
||||
data=json_data,
|
||||
file_name=f"technical_seo_audit_{datetime.now().strftime('%Y%m%d_%H%M%S')}.json",
|
||||
mime="application/json",
|
||||
use_container_width=True
|
||||
)
|
||||
|
||||
with col2:
|
||||
# CSV export for issues
|
||||
if st.button("📊 Export Issues CSV", use_container_width=True):
|
||||
issues_data = self._prepare_issues_csv(results)
|
||||
|
||||
if issues_data:
|
||||
st.download_button(
|
||||
label="⬇️ Download Issues CSV",
|
||||
data=issues_data,
|
||||
file_name=f"technical_issues_{datetime.now().strftime('%Y%m%d_%H%M%S')}.csv",
|
||||
mime="text/csv",
|
||||
use_container_width=True
|
||||
)
|
||||
else:
|
||||
st.info("No issues found to export")
|
||||
|
||||
with col3:
|
||||
# Executive summary
|
||||
if st.button("📋 Executive Summary", use_container_width=True):
|
||||
summary = self._generate_executive_summary(results)
|
||||
|
||||
st.download_button(
|
||||
label="⬇️ Download Summary",
|
||||
data=summary,
|
||||
file_name=f"technical_seo_summary_{datetime.now().strftime('%Y%m%d_%H%M%S')}.txt",
|
||||
mime="text/plain",
|
||||
use_container_width=True
|
||||
)
|
||||
|
||||
def _prepare_issues_csv(self, results: Dict[str, Any]) -> str:
|
||||
"""Prepare CSV data for technical issues."""
|
||||
|
||||
issues_list = []
|
||||
|
||||
# HTTP errors
|
||||
http_errors = results.get('technical_issues', {}).get('http_errors', {})
|
||||
if http_errors.get('error_pages'):
|
||||
for error in http_errors['error_pages']:
|
||||
issues_list.append({
|
||||
'Issue Type': 'HTTP Error',
|
||||
'Severity': 'High',
|
||||
'URL': error.get('url', ''),
|
||||
'Status Code': error.get('status', ''),
|
||||
'Description': f"HTTP {error.get('status', '')} error"
|
||||
})
|
||||
|
||||
# Missing elements
|
||||
missing_elements = results.get('technical_issues', {}).get('missing_elements', {})
|
||||
|
||||
# Add more issue types as needed...
|
||||
|
||||
if issues_list:
|
||||
issues_df = pd.DataFrame(issues_list)
|
||||
return issues_df.to_csv(index=False)
|
||||
|
||||
return ""
|
||||
|
||||
def _generate_executive_summary(self, results: Dict[str, Any]) -> str:
|
||||
"""Generate executive summary report."""
|
||||
|
||||
website_url = results.get('website_url', 'Unknown')
|
||||
timestamp = results.get('analysis_timestamp', datetime.now().isoformat())
|
||||
|
||||
summary = f"""
|
||||
TECHNICAL SEO AUDIT - EXECUTIVE SUMMARY
|
||||
======================================
|
||||
|
||||
Website: {website_url}
|
||||
Audit Date: {timestamp}
|
||||
|
||||
AUDIT OVERVIEW
|
||||
--------------
|
||||
Pages Crawled: {results.get('crawl_overview', {}).get('pages_crawled', 0)}
|
||||
HTTP Errors: {results.get('technical_issues', {}).get('http_errors', {}).get('total_errors', 0)}
|
||||
Average Load Time: {results.get('performance_analysis', {}).get('load_time_analysis', {}).get('avg_load_time', 0):.2f}s
|
||||
Security Score: {results.get('security_headers', {}).get('security_score', 0):.0f}%
|
||||
|
||||
CRITICAL FINDINGS
|
||||
-----------------
|
||||
"""
|
||||
|
||||
# Add critical findings
|
||||
error_count = results.get('technical_issues', {}).get('http_errors', {}).get('total_errors', 0)
|
||||
if error_count > 0:
|
||||
summary += f"• {error_count} pages have HTTP errors requiring immediate attention\n"
|
||||
|
||||
avg_load_time = results.get('performance_analysis', {}).get('load_time_analysis', {}).get('avg_load_time', 0)
|
||||
if avg_load_time > 3:
|
||||
summary += f"• Page load times are slow (avg: {avg_load_time:.2f}s), impacting user experience\n"
|
||||
|
||||
security_score = results.get('security_headers', {}).get('security_score', 0)
|
||||
if security_score < 80:
|
||||
summary += f"• Security headers need improvement (current score: {security_score:.0f}%)\n"
|
||||
|
||||
summary += f"\n\nDetailed technical audit completed by ALwrity Technical SEO Crawler\nGenerated: {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}"
|
||||
|
||||
return summary
|
||||
|
||||
# Render function for integration with main dashboard
|
||||
def render_technical_seo_crawler():
|
||||
"""Render the Technical SEO Crawler UI."""
|
||||
ui = TechnicalSEOCrawlerUI()
|
||||
ui.render()
|
||||
58
ToBeMigrated/ai_seo_tools/textstaty.py
Normal file
58
ToBeMigrated/ai_seo_tools/textstaty.py
Normal file
@@ -0,0 +1,58 @@
|
||||
"""Text analysis tools using textstat."""
|
||||
|
||||
import streamlit as st
|
||||
from textstat import textstat
|
||||
|
||||
def analyze_text(text):
|
||||
"""Analyze text using textstat metrics."""
|
||||
if not text:
|
||||
st.warning("Please enter some text to analyze.")
|
||||
return
|
||||
|
||||
# Calculate various metrics
|
||||
metrics = {
|
||||
"Flesch Reading Ease": textstat.flesch_reading_ease(text),
|
||||
"Flesch-Kincaid Grade Level": textstat.flesch_kincaid_grade(text),
|
||||
"Gunning Fog Index": textstat.gunning_fog(text),
|
||||
"SMOG Index": textstat.smog_index(text),
|
||||
"Automated Readability Index": textstat.automated_readability_index(text),
|
||||
"Coleman-Liau Index": textstat.coleman_liau_index(text),
|
||||
"Linsear Write Formula": textstat.linsear_write_formula(text),
|
||||
"Dale-Chall Readability Score": textstat.dale_chall_readability_score(text),
|
||||
"Readability Consensus": textstat.readability_consensus(text)
|
||||
}
|
||||
|
||||
# Display metrics in a clean format
|
||||
st.subheader("Text Analysis Results")
|
||||
for metric, value in metrics.items():
|
||||
st.metric(metric, f"{value:.2f}")
|
||||
|
||||
# Add visualizations
|
||||
st.subheader("Visualization")
|
||||
st.bar_chart(metrics)
|
||||
|
||||
st.title("📖 Text Readability Analyzer: Making Your Content Easy to Read")
|
||||
|
||||
st.write("""
|
||||
This tool is your guide to writing content that's easy for your audience to understand.
|
||||
Just paste in a sample of your text, and we'll break down the readability scores and offer actionable tips!
|
||||
""")
|
||||
|
||||
text_input = st.text_area("Paste your text here:", height=200)
|
||||
|
||||
if st.button("Analyze!"):
|
||||
with st.spinner("Analyzing your text..."):
|
||||
test_data = text_input
|
||||
if not test_data.strip():
|
||||
st.error("Please enter text to analyze.")
|
||||
else:
|
||||
analyze_text(test_data)
|
||||
|
||||
st.subheader("Key Takeaways:")
|
||||
st.write("---")
|
||||
st.markdown("""
|
||||
* **Don't Be Afraid to Simplify!** Often, simpler language makes content more impactful and easier to digest.
|
||||
* **Aim for a Reading Level Appropriate for Your Audience:** Consider the education level, background, and familiarity of your readers.
|
||||
* **Use Short Sentences:** This makes your content more scannable and easier to read.
|
||||
* **Write for Everyone:** Accessibility should always be a priority. When in doubt, aim for clear, concise language!
|
||||
""")
|
||||
102
ToBeMigrated/ai_writers/ai_news_article_writer.py
Normal file
102
ToBeMigrated/ai_writers/ai_news_article_writer.py
Normal file
@@ -0,0 +1,102 @@
|
||||
######################################################
|
||||
#
|
||||
# Alwrity, as an AI news writer, will have to be factually correct.
|
||||
# We will do multiple rounds of web research and cite our sources.
|
||||
# 'include_urls' will focus news articles only from well known sources.
|
||||
# Choosing a country will help us get better results.
|
||||
#
|
||||
######################################################
|
||||
|
||||
import sys
|
||||
import os
|
||||
import json
|
||||
from textwrap import dedent
|
||||
from pathlib import Path
|
||||
from datetime import datetime
|
||||
|
||||
from dotenv import load_dotenv
|
||||
load_dotenv(Path('../../.env'))
|
||||
from loguru import logger
|
||||
logger.remove()
|
||||
logger.add(sys.stdout,
|
||||
colorize=True,
|
||||
format="<level>{level}</level>|<green>{file}:{line}:{function}</green>| {message}"
|
||||
)
|
||||
|
||||
from ..gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
from ..ai_web_researcher.google_serp_search import perform_serper_news_search
|
||||
|
||||
|
||||
def ai_news_generation(news_keywords, news_country, news_language):
|
||||
""" Generate news aritcle based on given keywords. """
|
||||
# Use to store the blog in a string, to save in a *.md file.
|
||||
blog_markdown_str = ""
|
||||
|
||||
logger.info(f"Researching and Writing News Article on keywords: {news_keywords}")
|
||||
# Call on the got-researcher, tavily apis for this. Do google search for organic competition.
|
||||
try:
|
||||
google_news_result = perform_serper_news_search(news_keywords, news_country, news_language)
|
||||
blog_markdown_str = write_news_google_search(news_keywords, news_country, news_language, google_news_result)
|
||||
#print(blog_markdown_str)
|
||||
except Exception as err:
|
||||
logger.error(f"Failed in Google News web research: {err}")
|
||||
logger.info("\n######### Draft1: Finished News article from Google web search: ###########\n\n")
|
||||
return blog_markdown_str
|
||||
|
||||
|
||||
def write_news_google_search(news_keywords, news_country, news_language, search_results):
|
||||
"""Combine the given online research and gpt blog content"""
|
||||
news_language = get_language_name(news_language)
|
||||
news_country = get_country_name(news_country)
|
||||
|
||||
prompt = f"""
|
||||
As an experienced {news_language} news journalist and editor,
|
||||
I will provide you with my 'News keywords' and its 'google search results'.
|
||||
Your goal is to write a News report, backed by given google search results.
|
||||
Important, as a news report, its imperative that your content is factually correct and cited.
|
||||
|
||||
Follow below guidelines:
|
||||
1). Understand and utilize the provided google search result json.
|
||||
2). Always provide in-line citations and provide referance links.
|
||||
3). Understand the given news item and adapt your tone accordingly.
|
||||
4). Always include the dates when then news was reported.
|
||||
6). Do not explain, describe your response.
|
||||
7). Your blog should be highly formatted in markdown style and highly readable.
|
||||
8). Important: Please read the entire prompt before writing anything. Follow the prompt exactly as I instructed.
|
||||
|
||||
\n\nNews Keywords: "{news_keywords}"\n\n
|
||||
Google search Result: "{search_results}"
|
||||
"""
|
||||
logger.info("Generating blog and FAQs from Google web search results.")
|
||||
try:
|
||||
response = llm_text_gen(prompt)
|
||||
return response
|
||||
except Exception as err:
|
||||
logger.error(f"Exit: Failed to get response from LLM: {err}")
|
||||
exit(1)
|
||||
|
||||
|
||||
def get_language_name(language_code):
|
||||
languages = {
|
||||
"es": "Spanish",
|
||||
"vn": "Vietnamese",
|
||||
"en": "English",
|
||||
"ar": "Arabic",
|
||||
"hi": "Hindi",
|
||||
"de": "German",
|
||||
"zh-cn": "Chinese (Simplified)"
|
||||
# Add more language codes and corresponding names as needed
|
||||
}
|
||||
return languages.get(language_code, "Unknown")
|
||||
|
||||
def get_country_name(country_code):
|
||||
countries = {
|
||||
"es": "Spain",
|
||||
"vn": "Vietnam",
|
||||
"pk": "Pakistan",
|
||||
"in": "India",
|
||||
"de": "Germany",
|
||||
"cn": "China"
|
||||
# Add more country codes and corresponding names as needed
|
||||
}
|
||||
return countries.get(country_code, "Unknown")
|
||||
115
ToBeMigrated/ai_writers/ai_product_description_writer.py
Normal file
115
ToBeMigrated/ai_writers/ai_product_description_writer.py
Normal file
@@ -0,0 +1,115 @@
|
||||
import streamlit as st
|
||||
import json
|
||||
|
||||
from ..gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
|
||||
|
||||
def generate_product_description(title, details, audience, tone, length, keywords):
|
||||
"""
|
||||
Generates a product description using OpenAI's API.
|
||||
|
||||
Args:
|
||||
title (str): The title of the product.
|
||||
details (list): A list of product details (features, benefits, etc.).
|
||||
audience (list): A list of target audience segments.
|
||||
tone (str): The desired tone of the description (e.g., "Formal", "Informal").
|
||||
length (str): The desired length of the description (e.g., "short", "medium", "long").
|
||||
keywords (str): Keywords related to the product (comma-separated).
|
||||
|
||||
Returns:
|
||||
str: The generated product description.
|
||||
"""
|
||||
prompt = f"""
|
||||
Write a compelling product description for {title}.
|
||||
|
||||
Highlight these key features: {', '.join(details)}
|
||||
|
||||
Emphasize the benefits of these features for the target audience ({audience}).
|
||||
Maintain a {tone} tone and aim for a length of approximately {length} words.
|
||||
|
||||
Use these keywords naturally throughout the description: {', '.join(keywords)}.
|
||||
|
||||
Remember to be persuasive and focus on the value proposition.
|
||||
"""
|
||||
|
||||
try:
|
||||
response = llm_text_gen(prompt)
|
||||
return response
|
||||
except Exception as err:
|
||||
logger.error(f"Exit: Failed to get response from LLM: {err}")
|
||||
exit(1)
|
||||
|
||||
|
||||
def display_inputs():
|
||||
st.title("📝 AI Product Description Writer 🚀")
|
||||
st.markdown("**Generate compelling and accurate product descriptions with AI.**")
|
||||
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
product_title = st.text_input("🏷️ **Product Title**", placeholder="Enter the product title (e.g., Wireless Bluetooth Headphones)")
|
||||
with col2:
|
||||
product_details = st.text_area("📄 **Product Details**", placeholder="Enter features, benefits, specifications, materials, etc. (e.g., Noise Cancellation, Long Battery Life, Water Resistant, Comfortable Design)")
|
||||
|
||||
col3, col4 = st.columns(2)
|
||||
|
||||
with col3:
|
||||
keywords = st.text_input("🔑 **Keywords**", placeholder="Enter keywords, comma-separated (e.g., wireless headphones, noise cancelling, Bluetooth 5.0)")
|
||||
with col4:
|
||||
target_audience = st.multiselect(
|
||||
"🎯 **Target Audience**",
|
||||
["Teens", "Adults", "Seniors", "Music Lovers", "Fitness Enthusiasts", "Tech Savvy", "Busy Professionals", "Travelers", "Casual Users"],
|
||||
placeholder="Select target audience (optional)"
|
||||
)
|
||||
|
||||
col5, col6 = st.columns(2)
|
||||
|
||||
with col5:
|
||||
description_length = st.selectbox(
|
||||
"📏 **Desired Description Length**",
|
||||
["Short (1-2 sentences)", "Medium (3-5 sentences)", "Long (6+ sentences)"],
|
||||
help="Select the desired length of the product description"
|
||||
)
|
||||
with col6:
|
||||
brand_tone = st.selectbox(
|
||||
"🎨 **Brand Tone**",
|
||||
["Formal", "Informal", "Fun & Energetic"],
|
||||
help="Select the desired tone for the description"
|
||||
)
|
||||
|
||||
return product_title, product_details, target_audience, brand_tone, description_length, keywords
|
||||
|
||||
|
||||
def display_output(description):
|
||||
if description:
|
||||
st.subheader("✨ Generated Product Description:")
|
||||
st.write(description)
|
||||
|
||||
json_ld = {
|
||||
"@context": "https://schema.org",
|
||||
"@type": "Product",
|
||||
"name": product_title,
|
||||
"description": description,
|
||||
"audience": target_audience,
|
||||
"brand": {
|
||||
"@type": "Brand",
|
||||
"name": "Your Brand Name"
|
||||
},
|
||||
"keywords": keywords.split(", ")
|
||||
}
|
||||
|
||||
|
||||
def write_ai_prod_desc():
|
||||
product_title, product_details, target_audience, brand_tone, description_length, keywords = display_inputs()
|
||||
|
||||
if st.button("Generate Product Description 🚀"):
|
||||
with st.spinner("Generating description..."):
|
||||
description = generate_product_description(
|
||||
product_title,
|
||||
product_details.split(", "), # Split details into a list
|
||||
target_audience,
|
||||
brand_tone,
|
||||
description_length.split(" ")[0].lower(), # Extract length from selectbox
|
||||
keywords
|
||||
)
|
||||
display_output(description)
|
||||
75
ToBeMigrated/ai_writers/ai_story_illustrator/README.md
Normal file
75
ToBeMigrated/ai_writers/ai_story_illustrator/README.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# AI Story Illustrator
|
||||
|
||||
The AI Story Illustrator is a powerful tool that generates beautiful illustrations for stories using Google's Gemini AI. This module allows users to input stories via text, file upload, or URL, and automatically generates appropriate illustrations for different scenes in the story.
|
||||
|
||||
## Features
|
||||
|
||||
- **Multiple Input Methods**: Input stories via direct text entry, file upload, or URL extraction
|
||||
- **Intelligent Scene Segmentation**: Automatically divides stories into logical segments for illustration
|
||||
- **Customizable Illustration Styles**: Choose from various artistic styles or define your own
|
||||
- **Scene Element Extraction**: Analyzes story segments to identify key visual elements
|
||||
- **Multiple Export Options**: Export as PDF storybook or ZIP archive of individual images
|
||||
- **Customizable Aspect Ratios**: Support for different image dimensions (16:9, 4:3, 1:1)
|
||||
- **Advanced Settings**: Control the number of segments to illustrate and other parameters
|
||||
|
||||
## Usage
|
||||
|
||||
The Story Illustrator is integrated into the Alwrity platform and can be accessed through the main interface. The workflow consists of three main steps:
|
||||
|
||||
1. **Story Input**: Enter your story text, upload a file, or provide a URL
|
||||
2. **Illustration Settings**: Configure the style, aspect ratio, and other parameters
|
||||
3. **Generate & Export**: Generate illustrations for all or individual segments and export the results
|
||||
|
||||
## Technical Details
|
||||
|
||||
### Dependencies
|
||||
|
||||
- Streamlit: For the user interface
|
||||
- Gemini AI: For image generation
|
||||
- BeautifulSoup: For URL text extraction
|
||||
- ReportLab: For PDF generation (optional)
|
||||
- PIL: For image processing
|
||||
|
||||
### Key Functions
|
||||
|
||||
- `segment_story()`: Divides a story into logical segments for illustration
|
||||
- `extract_scene_elements()`: Analyzes story segments to identify key visual elements
|
||||
- `generate_illustration_prompt()`: Creates detailed prompts for the AI image generator
|
||||
- `create_illustration()`: Generates an illustration for a story segment
|
||||
- `create_storybook_pdf()`: Combines story text and illustrations into a PDF
|
||||
- `create_zip_archive()`: Creates a ZIP archive of individual illustrations
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from lib.ai_writers.ai_story_illustrator.story_illustrator import write_story_illustrator
|
||||
|
||||
# Run the Story Illustrator app
|
||||
write_story_illustrator()
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
- **Provide Clear Segments**: The system works best with stories that have clear scene transitions
|
||||
- **Be Specific with Styles**: More specific style descriptions yield better results
|
||||
- **Balance Text and Images**: For best results, aim for segments of 100-500 words per illustration
|
||||
- **Review and Regenerate**: If an illustration doesn't capture the scene well, use the regenerate option
|
||||
|
||||
## Future Enhancements
|
||||
|
||||
- Support for more export formats (EPUB, HTML)
|
||||
- Enhanced character consistency across illustrations
|
||||
- Animation options for digital storytelling
|
||||
- Voice narration integration
|
||||
- Custom character design options
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- If illustrations are not generating, check your internet connection and API access
|
||||
- If PDF export fails, ensure ReportLab is installed (`pip install reportlab`)
|
||||
- If URL extraction fails, try copying the text manually
|
||||
- For large stories, consider processing in smaller batches
|
||||
|
||||
## Credits
|
||||
|
||||
This module uses Google's Gemini AI for image generation and leverages various open-source libraries for text processing and document generation.
|
||||
7
ToBeMigrated/ai_writers/ai_story_illustrator/__init__.py
Normal file
7
ToBeMigrated/ai_writers/ai_story_illustrator/__init__.py
Normal file
@@ -0,0 +1,7 @@
|
||||
"""
|
||||
AI Story Illustrator module for generating illustrations for stories using AI.
|
||||
"""
|
||||
|
||||
from .story_illustrator import write_story_illustrator
|
||||
|
||||
__all__ = ['write_story_illustrator']
|
||||
@@ -0,0 +1,727 @@
|
||||
"""
|
||||
AI Story Illustrator - Generate illustrations for stories using Gemini AI
|
||||
|
||||
This module provides functionality to generate illustrations for stories using Google's Gemini AI.
|
||||
Users can input stories via text, file upload, or URL, and the system will generate appropriate
|
||||
illustrations for different scenes in the story.
|
||||
|
||||
Based on: https://github.com/google-gemini/cookbook/blob/main/examples/Book_illustration.ipynb
|
||||
"""
|
||||
|
||||
import streamlit as st
|
||||
import os
|
||||
import re
|
||||
import time
|
||||
import tempfile
|
||||
import requests
|
||||
from pathlib import Path
|
||||
import io
|
||||
import base64
|
||||
import json
|
||||
import uuid
|
||||
import logging
|
||||
from urllib.parse import urlparse
|
||||
from bs4 import BeautifulSoup
|
||||
import zipfile
|
||||
|
||||
# Configure logging
|
||||
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
|
||||
logger = logging.getLogger('story_illustrator')
|
||||
|
||||
# Constants
|
||||
MAX_STORY_LENGTH = 10000 # Maximum story length in characters
|
||||
MIN_SEGMENT_LENGTH = 100 # Minimum segment length for illustration
|
||||
MAX_SEGMENTS = 20 # Maximum number of segments to illustrate
|
||||
DEFAULT_STYLE = "digital art" # Default illustration style
|
||||
DEFAULT_ASPECT_RATIO = "16:9" # Default aspect ratio
|
||||
|
||||
|
||||
def extract_text_from_url(url):
|
||||
"""Extract text content from a URL."""
|
||||
try:
|
||||
headers = {
|
||||
'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36'
|
||||
}
|
||||
response = requests.get(url, headers=headers, timeout=10)
|
||||
response.raise_for_status()
|
||||
|
||||
soup = BeautifulSoup(response.content, 'html.parser')
|
||||
|
||||
# Remove script and style elements
|
||||
for script in soup(["script", "style"]):
|
||||
script.extract()
|
||||
|
||||
# Get text
|
||||
text = soup.get_text(separator='\\n')
|
||||
|
||||
# Break into lines and remove leading and trailing space on each
|
||||
lines = (line.strip() for line in text.splitlines())
|
||||
# Break multi-headlines into a line each
|
||||
chunks = (phrase.strip() for line in lines for phrase in line.split(" "))
|
||||
# Drop blank lines
|
||||
text = '\\n'.join(chunk for chunk in chunks if chunk)
|
||||
|
||||
return text
|
||||
except Exception as e:
|
||||
logger.error(f"Error extracting text from URL: {e}")
|
||||
return None
|
||||
|
||||
|
||||
def segment_story(story_text, min_segment_length=MIN_SEGMENT_LENGTH, max_segments=MAX_SEGMENTS):
|
||||
"""
|
||||
Segment a story into logical parts for illustration.
|
||||
Uses paragraph breaks, scene changes, and other indicators to create segments.
|
||||
"""
|
||||
# Clean up the text
|
||||
story_text = story_text.strip()
|
||||
|
||||
# Split by paragraphs first
|
||||
paragraphs = re.split(r'\\n\s*\\n', story_text)
|
||||
|
||||
# Initialize segments
|
||||
segments = []
|
||||
current_segment = ""
|
||||
|
||||
for paragraph in paragraphs:
|
||||
# Skip empty paragraphs
|
||||
if not paragraph.strip():
|
||||
continue
|
||||
|
||||
# If adding this paragraph would make the segment too long, start a new segment
|
||||
if len(current_segment) + len(paragraph) > 1000: # Limit segment size
|
||||
if current_segment:
|
||||
segments.append(current_segment.strip())
|
||||
current_segment = paragraph
|
||||
else:
|
||||
# Add paragraph to current segment
|
||||
if current_segment:
|
||||
current_segment += "\\n\\n" + paragraph
|
||||
else:
|
||||
current_segment = paragraph
|
||||
|
||||
# Add the last segment if it exists
|
||||
if current_segment:
|
||||
segments.append(current_segment.strip())
|
||||
|
||||
# Combine very short segments
|
||||
i = 0
|
||||
while i < len(segments) - 1:
|
||||
if len(segments[i]) < min_segment_length:
|
||||
segments[i] += "\\n\\n" + segments[i+1]
|
||||
segments.pop(i+1)
|
||||
else:
|
||||
i += 1
|
||||
|
||||
# Limit the number of segments
|
||||
if len(segments) > max_segments:
|
||||
# Combine segments to reduce the total number
|
||||
new_segments = []
|
||||
segment_size = len(segments) / max_segments
|
||||
|
||||
for i in range(max_segments):
|
||||
start_idx = int(i * segment_size)
|
||||
end_idx = int((i + 1) * segment_size)
|
||||
combined_segment = "\\n\\n".join(segments[start_idx:end_idx])
|
||||
new_segments.append(combined_segment)
|
||||
|
||||
segments = new_segments
|
||||
|
||||
return segments
|
||||
|
||||
|
||||
def extract_scene_elements(segment):
|
||||
"""
|
||||
Extract key scene elements from a story segment using LLM.
|
||||
This helps create more accurate illustration prompts.
|
||||
"""
|
||||
from ...gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
|
||||
prompt = f"""
|
||||
Analyze the following story segment and extract key visual elements for an illustration:
|
||||
|
||||
{segment}
|
||||
|
||||
Please provide:
|
||||
1. Main characters present (with brief visual descriptions)
|
||||
2. Setting/location details
|
||||
3. Key action or emotional moment to illustrate
|
||||
4. Important objects or props
|
||||
5. Time of day and lighting
|
||||
6. Weather or atmospheric conditions (if applicable)
|
||||
|
||||
Format your response as JSON with these keys: "characters", "setting", "key_moment", "objects", "lighting", "atmosphere"
|
||||
"""
|
||||
|
||||
try:
|
||||
response = llm_text_gen(prompt)
|
||||
|
||||
# Try to extract JSON from the response
|
||||
try:
|
||||
# Find JSON content between triple backticks if present
|
||||
json_match = re.search(r'```json\s*(.*?)\s*```', response, re.DOTALL)
|
||||
if json_match:
|
||||
json_str = json_match.group(1)
|
||||
else:
|
||||
# Otherwise try to parse the whole response as JSON
|
||||
json_str = response
|
||||
|
||||
scene_elements = json.loads(json_str)
|
||||
return scene_elements
|
||||
except json.JSONDecodeError:
|
||||
# If JSON parsing fails, extract information using regex
|
||||
characters = re.search(r'"characters":\s*"([^"]*)"', response)
|
||||
setting = re.search(r'"setting":\s*"([^"]*)"', response)
|
||||
|
||||
return {
|
||||
"characters": characters.group(1) if characters else "",
|
||||
"setting": setting.group(1) if setting else "",
|
||||
"key_moment": "",
|
||||
"objects": "",
|
||||
"lighting": "",
|
||||
"atmosphere": ""
|
||||
}
|
||||
except Exception as e:
|
||||
logger.error(f"Error extracting scene elements: {e}")
|
||||
return {
|
||||
"characters": "",
|
||||
"setting": "",
|
||||
"key_moment": "",
|
||||
"objects": "",
|
||||
"lighting": "",
|
||||
"atmosphere": ""
|
||||
}
|
||||
|
||||
|
||||
def generate_illustration_prompt(segment, style, characters=None, setting=None):
|
||||
"""
|
||||
Generate a prompt for the illustration based on the segment content.
|
||||
|
||||
Args:
|
||||
segment: The story segment to illustrate
|
||||
style: The artistic style for the illustration
|
||||
characters: Optional character descriptions
|
||||
setting: Optional setting description
|
||||
|
||||
Returns:
|
||||
A prompt string for the image generation model
|
||||
"""
|
||||
# Create a base prompt
|
||||
base_prompt = f"""
|
||||
Create a detailed illustration for the following story segment in {style} style:
|
||||
|
||||
{segment[:500]} # Limit segment length for prompt
|
||||
|
||||
The illustration should capture the key elements, mood, and action of this scene.
|
||||
"""
|
||||
|
||||
# Add character information if provided
|
||||
if characters:
|
||||
base_prompt += f"\\n\\nThe main characters in this scene are: {characters}"
|
||||
|
||||
# Add setting information if provided
|
||||
if setting:
|
||||
base_prompt += f"\\n\\nThe setting is: {setting}"
|
||||
|
||||
# Add style-specific instructions
|
||||
if "watercolor" in style.lower():
|
||||
base_prompt += "\\n\\nUse soft, flowing watercolor techniques with visible brush strokes and color blending."
|
||||
elif "digital art" in style.lower():
|
||||
base_prompt += "\\n\\nCreate a polished digital illustration with clean lines and vibrant colors."
|
||||
elif "pencil sketch" in style.lower():
|
||||
base_prompt += "\\n\\nUse pencil sketch techniques with visible hatching, shading, and line work."
|
||||
|
||||
# Add final quality instructions
|
||||
base_prompt += """
|
||||
|
||||
Make the illustration:
|
||||
- Visually engaging and detailed
|
||||
- Appropriate for a storybook
|
||||
- Focused on the main action or emotion of the scene
|
||||
- With good composition and visual storytelling
|
||||
"""
|
||||
|
||||
return base_prompt.strip()
|
||||
|
||||
|
||||
def create_illustration(segment, style, aspect_ratio="16:9"):
|
||||
"""
|
||||
Create an illustration for a story segment.
|
||||
|
||||
Args:
|
||||
segment: The story segment to illustrate
|
||||
style: The artistic style for the illustration
|
||||
aspect_ratio: The aspect ratio for the illustration
|
||||
|
||||
Returns:
|
||||
Path to the generated image
|
||||
"""
|
||||
# Import here to avoid circular imports
|
||||
from ...gpt_providers.text_to_image_generation.gen_gemini_images import generate_gemini_image
|
||||
|
||||
# Extract scene elements to enhance the prompt
|
||||
scene_elements = extract_scene_elements(segment)
|
||||
|
||||
# Create a detailed prompt for the illustration
|
||||
prompt = generate_illustration_prompt(
|
||||
segment,
|
||||
style,
|
||||
characters=scene_elements.get("characters", ""),
|
||||
setting=scene_elements.get("setting", "")
|
||||
)
|
||||
|
||||
# Add key elements to the prompt
|
||||
key_moment = scene_elements.get("key_moment", "")
|
||||
objects = scene_elements.get("objects", "")
|
||||
lighting = scene_elements.get("lighting", "")
|
||||
atmosphere = scene_elements.get("atmosphere", "")
|
||||
|
||||
if key_moment:
|
||||
prompt += f"\\n\\nFocus on this key moment: {key_moment}"
|
||||
|
||||
if objects:
|
||||
prompt += f"\\n\\nInclude these important objects: {objects}"
|
||||
|
||||
if lighting:
|
||||
prompt += f"\\n\\nThe lighting is: {lighting}"
|
||||
|
||||
if atmosphere:
|
||||
prompt += f"\\n\\nThe atmosphere/weather is: {atmosphere}"
|
||||
|
||||
# Generate the illustration
|
||||
try:
|
||||
# Parse aspect ratio
|
||||
if aspect_ratio == "16:9":
|
||||
width, height = 16, 9
|
||||
elif aspect_ratio == "4:3":
|
||||
width, height = 4, 3
|
||||
elif aspect_ratio == "1:1":
|
||||
width, height = 1, 1
|
||||
else:
|
||||
width, height = 16, 9 # Default
|
||||
|
||||
# Generate image using Gemini
|
||||
image_path = generate_gemini_image(
|
||||
prompt=prompt,
|
||||
style=style.lower() if style else None,
|
||||
aspect_ratio=aspect_ratio
|
||||
)
|
||||
|
||||
return image_path
|
||||
except Exception as e:
|
||||
logger.error(f"Error creating illustration: {e}")
|
||||
return None
|
||||
|
||||
|
||||
def create_storybook_pdf(segments, illustrations, title, author, output_path):
|
||||
"""
|
||||
Create a PDF storybook with text and illustrations.
|
||||
|
||||
Args:
|
||||
segments: List of story segments
|
||||
illustrations: List of paths to illustrations
|
||||
title: Book title
|
||||
author: Book author
|
||||
output_path: Path to save the PDF
|
||||
|
||||
Returns:
|
||||
Path to the created PDF
|
||||
"""
|
||||
try:
|
||||
from reportlab.lib.pagesizes import letter, A4
|
||||
from reportlab.lib import colors
|
||||
from reportlab.platypus import SimpleDocTemplate, Paragraph, Spacer, Image as ReportLabImage, PageBreak
|
||||
from reportlab.lib.styles import getSampleStyleSheet, ParagraphStyle
|
||||
from reportlab.lib.units import inch
|
||||
|
||||
# Create a PDF document
|
||||
doc = SimpleDocTemplate(output_path, pagesize=A4)
|
||||
story = []
|
||||
|
||||
# Get styles
|
||||
styles = getSampleStyleSheet()
|
||||
title_style = styles['Title']
|
||||
author_style = styles['Normal']
|
||||
author_style.alignment = 1 # Center alignment
|
||||
normal_style = styles['Normal']
|
||||
|
||||
# Add title page
|
||||
story.append(Paragraph(title, title_style))
|
||||
story.append(Spacer(1, 0.5*inch))
|
||||
story.append(Paragraph(f"by {author}", author_style))
|
||||
story.append(PageBreak())
|
||||
|
||||
# Add content pages
|
||||
for i, (segment, illustration_path) in enumerate(zip(segments, illustrations)):
|
||||
if illustration_path and os.path.exists(illustration_path):
|
||||
# Add illustration
|
||||
img = ReportLabImage(illustration_path, width=6*inch, height=4*inch)
|
||||
story.append(img)
|
||||
story.append(Spacer(1, 0.25*inch))
|
||||
|
||||
# Add text
|
||||
for paragraph in segment.split('\\n\\n'):
|
||||
if paragraph.strip():
|
||||
story.append(Paragraph(paragraph, normal_style))
|
||||
story.append(Spacer(1, 0.1*inch))
|
||||
|
||||
# Add page break between segments
|
||||
if i < len(segments) - 1:
|
||||
story.append(PageBreak())
|
||||
|
||||
# Build the PDF
|
||||
doc.build(story)
|
||||
return output_path
|
||||
except Exception as e:
|
||||
logger.error(f"Error creating PDF: {e}")
|
||||
return None
|
||||
|
||||
|
||||
def create_zip_archive(files, output_path):
|
||||
"""
|
||||
Create a ZIP archive containing the provided files.
|
||||
|
||||
Args:
|
||||
files: Dictionary of {filename: file_path} to include in the archive
|
||||
output_path: Path to save the ZIP file
|
||||
|
||||
Returns:
|
||||
Path to the created ZIP file
|
||||
"""
|
||||
try:
|
||||
with zipfile.ZipFile(output_path, 'w') as zipf:
|
||||
for filename, file_path in files.items():
|
||||
if os.path.exists(file_path):
|
||||
zipf.write(file_path, arcname=filename)
|
||||
return output_path
|
||||
except Exception as e:
|
||||
logger.error(f"Error creating ZIP archive: {e}")
|
||||
return None
|
||||
|
||||
|
||||
def write_story_illustrator():
|
||||
"""Main function for the Story Illustrator Streamlit app."""
|
||||
st.title("AI Story Illustrator")
|
||||
st.write("Generate beautiful illustrations for your stories using AI")
|
||||
|
||||
# Create tabs for different sections
|
||||
tab1, tab2, tab3 = st.tabs(["Story Input", "Illustration Settings", "Generate & Export"])
|
||||
|
||||
# Initialize session state variables if they don't exist
|
||||
if "story_text" not in st.session_state:
|
||||
st.session_state.story_text = ""
|
||||
if "segments" not in st.session_state:
|
||||
st.session_state.segments = []
|
||||
if "illustrations" not in st.session_state:
|
||||
st.session_state.illustrations = []
|
||||
if "book_title" not in st.session_state:
|
||||
st.session_state.book_title = ""
|
||||
if "book_author" not in st.session_state:
|
||||
st.session_state.book_author = ""
|
||||
if "illustration_style" not in st.session_state:
|
||||
st.session_state.illustration_style = DEFAULT_STYLE
|
||||
if "aspect_ratio" not in st.session_state:
|
||||
st.session_state.aspect_ratio = DEFAULT_ASPECT_RATIO
|
||||
if "temp_files" not in st.session_state:
|
||||
st.session_state.temp_files = []
|
||||
|
||||
# Tab 1: Story Input
|
||||
with tab1:
|
||||
st.header("Step 1: Input Your Story")
|
||||
|
||||
# Input method selection
|
||||
input_method = st.radio(
|
||||
"Choose input method:",
|
||||
["Text Input", "File Upload", "URL"]
|
||||
)
|
||||
|
||||
if input_method == "Text Input":
|
||||
st.session_state.story_text = st.text_area(
|
||||
"Enter your story text:",
|
||||
value=st.session_state.story_text,
|
||||
height=300,
|
||||
max_chars=MAX_STORY_LENGTH,
|
||||
help="Enter the story text you want to illustrate (max 10,000 characters)"
|
||||
)
|
||||
|
||||
elif input_method == "File Upload":
|
||||
uploaded_file = st.file_uploader("Upload a text file:", type=["txt", "md"])
|
||||
if uploaded_file is not None:
|
||||
try:
|
||||
st.session_state.story_text = uploaded_file.getvalue().decode("utf-8")
|
||||
st.success(f"Successfully loaded file: {uploaded_file.name}")
|
||||
st.text_area("Preview:", value=st.session_state.story_text[:500] + "...", height=200, disabled=True)
|
||||
except Exception as e:
|
||||
st.error(f"Error reading file: {e}")
|
||||
|
||||
elif input_method == "URL":
|
||||
url = st.text_input("Enter URL containing the story:")
|
||||
if url:
|
||||
if st.button("Extract Text from URL"):
|
||||
with st.spinner("Extracting text from URL..."):
|
||||
extracted_text = extract_text_from_url(url)
|
||||
if extracted_text:
|
||||
st.session_state.story_text = extracted_text
|
||||
st.success("Successfully extracted text from URL")
|
||||
st.text_area("Preview:", value=st.session_state.story_text[:500] + "...", height=200, disabled=True)
|
||||
else:
|
||||
st.error("Failed to extract text from URL")
|
||||
|
||||
# Book metadata
|
||||
st.subheader("Book Metadata")
|
||||
col1, col2 = st.columns(2)
|
||||
with col1:
|
||||
st.session_state.book_title = st.text_input("Book Title:", value=st.session_state.book_title)
|
||||
with col2:
|
||||
st.session_state.book_author = st.text_input("Author:", value=st.session_state.book_author)
|
||||
|
||||
# Process story into segments
|
||||
if st.session_state.story_text:
|
||||
if st.button("Process Story into Segments"):
|
||||
with st.spinner("Processing story into segments..."):
|
||||
st.session_state.segments = segment_story(st.session_state.story_text)
|
||||
st.success(f"Story processed into {len(st.session_state.segments)} segments")
|
||||
|
||||
# Initialize illustrations list with None values
|
||||
st.session_state.illustrations = [None] * len(st.session_state.segments)
|
||||
|
||||
# Display segments
|
||||
st.subheader("Story Segments")
|
||||
for i, segment in enumerate(st.session_state.segments):
|
||||
with st.expander(f"Segment {i+1}"):
|
||||
st.write(segment)
|
||||
|
||||
# Tab 2: Illustration Settings
|
||||
with tab2:
|
||||
st.header("Step 2: Configure Illustration Settings")
|
||||
|
||||
# Style selection
|
||||
st.subheader("Illustration Style")
|
||||
style_options = [
|
||||
"Digital Art",
|
||||
"Watercolor Painting",
|
||||
"Pencil Sketch",
|
||||
"Oil Painting",
|
||||
"Cartoon",
|
||||
"Anime",
|
||||
"3D Render",
|
||||
"Pixel Art",
|
||||
"Children's Book Illustration",
|
||||
"Comic Book Style",
|
||||
"Fantasy Art",
|
||||
"Realistic"
|
||||
]
|
||||
|
||||
st.session_state.illustration_style = st.selectbox(
|
||||
"Choose an illustration style:",
|
||||
style_options,
|
||||
index=style_options.index(st.session_state.illustration_style) if st.session_state.illustration_style in style_options else 0
|
||||
)
|
||||
|
||||
# Custom style input
|
||||
use_custom_style = st.checkbox("Use custom style")
|
||||
if use_custom_style:
|
||||
custom_style = st.text_input("Describe your custom style:",
|
||||
placeholder="e.g., Impressionist painting with vibrant colors and visible brushstrokes")
|
||||
if custom_style:
|
||||
st.session_state.illustration_style = custom_style
|
||||
|
||||
# Display style examples
|
||||
st.info("💡 The style you choose will significantly impact the look and feel of your illustrations.")
|
||||
|
||||
# Aspect ratio selection
|
||||
st.subheader("Image Settings")
|
||||
aspect_ratio_options = {
|
||||
"16:9 (Widescreen)": "16:9",
|
||||
"4:3 (Standard)": "4:3",
|
||||
"1:1 (Square)": "1:1"
|
||||
}
|
||||
|
||||
selected_ratio = st.selectbox(
|
||||
"Choose aspect ratio:",
|
||||
list(aspect_ratio_options.keys()),
|
||||
index=list(aspect_ratio_options.values()).index(st.session_state.aspect_ratio) if st.session_state.aspect_ratio in aspect_ratio_options.values() else 0
|
||||
)
|
||||
st.session_state.aspect_ratio = aspect_ratio_options[selected_ratio]
|
||||
|
||||
# Advanced settings
|
||||
with st.expander("Advanced Settings"):
|
||||
st.slider("Number of segments to illustrate:", 1,
|
||||
max(len(st.session_state.segments), 1) if st.session_state.segments else 1,
|
||||
min(len(st.session_state.segments), MAX_SEGMENTS) if st.session_state.segments else 1,
|
||||
key="num_segments_to_illustrate")
|
||||
|
||||
st.checkbox("Generate cover image", value=True, key="generate_cover")
|
||||
|
||||
st.checkbox("Add text to illustrations", value=False, key="add_text_to_illustrations")
|
||||
|
||||
# Tab 3: Generate & Export
|
||||
with tab3:
|
||||
st.header("Step 3: Generate Illustrations & Export")
|
||||
|
||||
if not st.session_state.segments:
|
||||
st.warning("Please process your story into segments in Step 1 before generating illustrations.")
|
||||
else:
|
||||
# Generate illustrations
|
||||
st.subheader("Generate Illustrations")
|
||||
|
||||
num_segments = min(len(st.session_state.segments), st.session_state.get("num_segments_to_illustrate", len(st.session_state.segments)))
|
||||
|
||||
if st.button("Generate All Illustrations"):
|
||||
with st.spinner(f"Generating {num_segments} illustrations... This may take a while."):
|
||||
progress_bar = st.progress(0)
|
||||
|
||||
for i in range(num_segments):
|
||||
# Update progress
|
||||
progress_bar.progress((i) / num_segments)
|
||||
st.write(f"Generating illustration {i+1} of {num_segments}...")
|
||||
|
||||
# Generate illustration
|
||||
illustration_path = create_illustration(
|
||||
st.session_state.segments[i],
|
||||
st.session_state.illustration_style,
|
||||
st.session_state.aspect_ratio
|
||||
)
|
||||
|
||||
# Store the illustration path
|
||||
if illustration_path:
|
||||
st.session_state.illustrations[i] = illustration_path
|
||||
st.session_state.temp_files.append(illustration_path)
|
||||
|
||||
# Complete progress
|
||||
progress_bar.progress(1.0)
|
||||
st.success(f"Generated {num_segments} illustrations!")
|
||||
|
||||
# Generate individual illustrations
|
||||
st.subheader("Generate Individual Illustrations")
|
||||
|
||||
for i in range(num_segments):
|
||||
col1, col2 = st.columns([3, 1])
|
||||
|
||||
with col1:
|
||||
with st.expander(f"Segment {i+1}"):
|
||||
st.write(st.session_state.segments[i][:300] + "..." if len(st.session_state.segments[i]) > 300 else st.session_state.segments[i])
|
||||
|
||||
with col2:
|
||||
if st.button(f"Generate #{i+1}", key=f"gen_btn_{i}"):
|
||||
with st.spinner(f"Generating illustration {i+1}..."):
|
||||
illustration_path = create_illustration(
|
||||
st.session_state.segments[i],
|
||||
st.session_state.illustration_style,
|
||||
st.session_state.aspect_ratio
|
||||
)
|
||||
|
||||
if illustration_path:
|
||||
st.session_state.illustrations[i] = illustration_path
|
||||
st.session_state.temp_files.append(illustration_path)
|
||||
st.success(f"Generated illustration {i+1}!")
|
||||
|
||||
# Display generated illustrations
|
||||
st.subheader("Preview Illustrations")
|
||||
|
||||
if any(st.session_state.illustrations):
|
||||
for i, illustration_path in enumerate(st.session_state.illustrations[:num_segments]):
|
||||
if illustration_path and os.path.exists(illustration_path):
|
||||
with st.expander(f"Illustration {i+1}"):
|
||||
st.image(illustration_path, caption=f"Illustration for Segment {i+1}", use_column_width=True)
|
||||
|
||||
# Regenerate button
|
||||
if st.button(f"Regenerate", key=f"regen_btn_{i}"):
|
||||
with st.spinner(f"Regenerating illustration {i+1}..."):
|
||||
new_illustration_path = create_illustration(
|
||||
st.session_state.segments[i],
|
||||
st.session_state.illustration_style,
|
||||
st.session_state.aspect_ratio
|
||||
)
|
||||
|
||||
if new_illustration_path:
|
||||
st.session_state.illustrations[i] = new_illustration_path
|
||||
st.session_state.temp_files.append(new_illustration_path)
|
||||
st.rerun()
|
||||
else:
|
||||
st.info("No illustrations generated yet. Click 'Generate All Illustrations' or generate individual illustrations.")
|
||||
|
||||
# Export options
|
||||
st.subheader("Export Options")
|
||||
|
||||
if any(st.session_state.illustrations):
|
||||
export_format = st.radio(
|
||||
"Export format:",
|
||||
["PDF Storybook", "Individual Images (ZIP)", "Both"]
|
||||
)
|
||||
|
||||
if st.button("Export"):
|
||||
with st.spinner("Preparing export..."):
|
||||
# Create temporary directory for exports
|
||||
with tempfile.TemporaryDirectory() as temp_dir:
|
||||
# Filter out None values from illustrations
|
||||
valid_illustrations = [path for path in st.session_state.illustrations[:num_segments] if path and os.path.exists(path)]
|
||||
valid_segments = st.session_state.segments[:len(valid_illustrations)]
|
||||
|
||||
# Prepare filenames
|
||||
safe_title = "".join(c if c.isalnum() else "_" for c in st.session_state.book_title) if st.session_state.book_title else "story"
|
||||
timestamp = int(time.time())
|
||||
|
||||
# Export as PDF
|
||||
if export_format in ["PDF Storybook", "Both"]:
|
||||
pdf_path = os.path.join(temp_dir, f"{safe_title}_{timestamp}.pdf")
|
||||
|
||||
try:
|
||||
pdf_result = create_storybook_pdf(
|
||||
valid_segments,
|
||||
valid_illustrations,
|
||||
st.session_state.book_title or "Untitled Story",
|
||||
st.session_state.book_author or "Anonymous",
|
||||
pdf_path
|
||||
)
|
||||
|
||||
if pdf_result:
|
||||
with open(pdf_path, "rb") as f:
|
||||
st.download_button(
|
||||
label="Download PDF Storybook",
|
||||
data=f,
|
||||
file_name=f"{safe_title}.pdf",
|
||||
mime="application/pdf"
|
||||
)
|
||||
except Exception as e:
|
||||
st.error(f"Error creating PDF: {e}")
|
||||
st.info("Please install ReportLab to enable PDF export: pip install reportlab")
|
||||
|
||||
# Export as ZIP of images
|
||||
if export_format in ["Individual Images (ZIP)", "Both"]:
|
||||
zip_path = os.path.join(temp_dir, f"{safe_title}_illustrations_{timestamp}.zip")
|
||||
|
||||
# Prepare files for ZIP
|
||||
files_to_zip = {}
|
||||
for i, img_path in enumerate(valid_illustrations):
|
||||
if img_path and os.path.exists(img_path):
|
||||
files_to_zip[f"illustration_{i+1}.png"] = img_path
|
||||
|
||||
zip_result = create_zip_archive(files_to_zip, zip_path)
|
||||
|
||||
if zip_result:
|
||||
with open(zip_path, "rb") as f:
|
||||
st.download_button(
|
||||
label="Download Illustrations ZIP",
|
||||
data=f,
|
||||
file_name=f"{safe_title}_illustrations.zip",
|
||||
mime="application/zip"
|
||||
)
|
||||
else:
|
||||
st.info("Generate illustrations before exporting.")
|
||||
|
||||
# Cleanup temporary files when the session ends
|
||||
def cleanup_temp_files():
|
||||
for file_path in st.session_state.temp_files:
|
||||
try:
|
||||
if file_path and os.path.exists(file_path):
|
||||
os.remove(file_path)
|
||||
except Exception as e:
|
||||
logger.error(f"Error removing temporary file {file_path}: {e}")
|
||||
|
||||
# Register the cleanup function to run when the session ends
|
||||
import atexit
|
||||
atexit.register(cleanup_temp_files)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
write_story_illustrator()
|
||||
450
ToBeMigrated/ai_writers/ai_story_illustrator/utils.py
Normal file
450
ToBeMigrated/ai_writers/ai_story_illustrator/utils.py
Normal file
@@ -0,0 +1,450 @@
|
||||
"""
|
||||
Utility functions for the AI Story Illustrator module.
|
||||
|
||||
This module provides helper functions for file operations, string manipulation,
|
||||
and simple text analysis relevant to story processing.
|
||||
"""
|
||||
|
||||
import os
|
||||
import re
|
||||
import tempfile
|
||||
import uuid
|
||||
import logging
|
||||
import shutil
|
||||
from pathlib import Path
|
||||
from typing import List, Tuple, Optional, Union
|
||||
|
||||
# Attempt to import Pillow for image dimensions, but don't fail if not installed
|
||||
# unless the specific function is called.
|
||||
try:
|
||||
from PIL import Image
|
||||
_PIL_AVAILABLE = True
|
||||
except ImportError:
|
||||
_PIL_AVAILABLE = False
|
||||
|
||||
# Configure logging
|
||||
logging.basicConfig(
|
||||
level=logging.INFO,
|
||||
format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
|
||||
)
|
||||
logger = logging.getLogger('story_illustrator_utils')
|
||||
|
||||
# --- Constants ---
|
||||
IMAGE_EXTENSIONS = frozenset(['.jpg', '.jpeg', '.png', '.gif', '.bmp', '.webp'])
|
||||
TEXT_EXTENSIONS = frozenset(['.txt', '.md', '.text'])
|
||||
# Common English words that often start sentences, excluded from simple name detection
|
||||
COMMON_START_WORDS = frozenset([
|
||||
'The', 'A', 'An', 'And', 'But', 'Or', 'For', 'Nor', 'So', 'Yet', 'He', 'She',
|
||||
'It', 'They', 'We', 'You', 'I', 'In', 'On', 'At', 'To', 'From', 'With',
|
||||
'About', 'As', 'Is', 'Was', 'Were', 'Be', 'Been', 'Being', 'Have', 'Has',
|
||||
'Had', 'Do', 'Does', 'Did', 'Will', 'Would', 'Shall', 'Should', 'May',
|
||||
'Might', 'Must', 'Can', 'Could'
|
||||
])
|
||||
|
||||
|
||||
# --- File/Directory Operations ---
|
||||
|
||||
def create_temp_directory(prefix: str = "story_illustrator_") -> str:
|
||||
"""
|
||||
Creates a temporary directory using tempfile.mkdtemp.
|
||||
|
||||
Args:
|
||||
prefix: A prefix for the temporary directory name.
|
||||
|
||||
Returns:
|
||||
The absolute path to the created temporary directory.
|
||||
"""
|
||||
try:
|
||||
temp_dir = tempfile.mkdtemp(prefix=prefix)
|
||||
logger.info(f"Created temporary directory: {temp_dir}")
|
||||
return temp_dir
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to create temporary directory: {e}", exc_info=True)
|
||||
raise # Re-raise the exception after logging
|
||||
|
||||
|
||||
def sanitize_filename(filename: str) -> str:
|
||||
"""
|
||||
Sanitizes a filename by removing/replacing invalid characters for common filesystems.
|
||||
|
||||
Args:
|
||||
filename: The original filename string.
|
||||
|
||||
Returns:
|
||||
A sanitized filename string suitable for use in file paths.
|
||||
"""
|
||||
if not isinstance(filename, str):
|
||||
logger.warning("sanitize_filename received non-string input, converting.")
|
||||
filename = str(filename)
|
||||
|
||||
# Remove characters invalid for Windows/Unix filenames
|
||||
# Replace them with an underscore.
|
||||
sanitized = re.sub(r'[\\/*?:"<>|\']', "_", filename)
|
||||
# Replace consecutive underscores/spaces with a single underscore
|
||||
sanitized = re.sub(r'[_ ]+', '_', sanitized)
|
||||
# Remove leading/trailing spaces, dots, and underscores
|
||||
sanitized = sanitized.strip("._ ")
|
||||
|
||||
# Ensure the filename is not empty after sanitization
|
||||
if not sanitized:
|
||||
sanitized = "unnamed_file"
|
||||
logger.warning("Filename was empty after sanitization, using default.")
|
||||
|
||||
# Limit filename length (optional, adjust as needed)
|
||||
# max_len = 255 # Example limit
|
||||
# if len(sanitized) > max_len:
|
||||
# name, ext = os.path.splitext(sanitized)
|
||||
# sanitized = name[:max_len - len(ext) - 1] + "_" + ext
|
||||
# logger.warning(f"Filename truncated to maximum length: {sanitized}")
|
||||
|
||||
return sanitized
|
||||
|
||||
|
||||
def get_temp_file_path(
|
||||
directory: str, prefix: str = "file_", suffix: str = ".tmp"
|
||||
) -> str:
|
||||
"""
|
||||
Generates a unique temporary file path within the specified directory.
|
||||
|
||||
Args:
|
||||
directory: The directory where the temporary file should be located.
|
||||
prefix: A prefix for the filename.
|
||||
suffix: A suffix (extension) for the filename.
|
||||
|
||||
Returns:
|
||||
The full path for the unique temporary file.
|
||||
"""
|
||||
# Ensure suffix starts with a dot if it's meant to be an extension
|
||||
if suffix and not suffix.startswith("."):
|
||||
suffix = "." + suffix
|
||||
|
||||
unique_id = uuid.uuid4().hex[:12] # Longer hex UUID for better uniqueness
|
||||
filename = f"{prefix}{unique_id}{suffix}"
|
||||
return os.path.join(directory, filename)
|
||||
|
||||
|
||||
def ensure_directory_exists(directory: Union[str, Path]) -> str:
|
||||
"""
|
||||
Ensures that a directory exists, creating it recursively if necessary.
|
||||
|
||||
Args:
|
||||
directory: The path to the directory (string or Path object).
|
||||
|
||||
Returns:
|
||||
The absolute path to the directory as a string.
|
||||
|
||||
Raises:
|
||||
OSError: If the directory cannot be created (e.g., permission issues).
|
||||
"""
|
||||
dir_path = Path(directory).resolve() # Use Pathlib for robust handling
|
||||
try:
|
||||
dir_path.mkdir(parents=True, exist_ok=True)
|
||||
# Log only if it needed creation (or if verbose logging is on)
|
||||
# logger.info(f"Ensured directory exists: {dir_path}")
|
||||
return str(dir_path)
|
||||
except OSError as e:
|
||||
logger.error(f"Failed to create or access directory {dir_path}: {e}", exc_info=True)
|
||||
raise
|
||||
|
||||
|
||||
def cleanup_directory(directory: Union[str, Path]) -> None:
|
||||
"""
|
||||
Removes a directory and all its contents recursively. Handles errors gracefully.
|
||||
|
||||
Args:
|
||||
directory: The path to the directory to remove (string or Path object).
|
||||
"""
|
||||
dir_path = Path(directory)
|
||||
if not dir_path.exists():
|
||||
logger.debug(f"Cleanup skipped: Directory '{directory}' does not exist.")
|
||||
return
|
||||
|
||||
if not dir_path.is_dir():
|
||||
logger.warning(f"Cleanup warning: Path '{directory}' is not a directory.")
|
||||
return
|
||||
|
||||
try:
|
||||
shutil.rmtree(dir_path)
|
||||
logger.info(f"Successfully removed directory: {directory}")
|
||||
except OSError as e:
|
||||
logger.error(f"Error removing directory {directory}: {e}", exc_info=True)
|
||||
except Exception as e:
|
||||
logger.error(
|
||||
f"Unexpected error removing directory {directory}: {e}", exc_info=True
|
||||
)
|
||||
|
||||
|
||||
# --- File Type Checks ---
|
||||
|
||||
def get_file_extension(file_path: Union[str, Path]) -> str:
|
||||
"""
|
||||
Gets the lowercased file extension (including the dot) from a file path.
|
||||
|
||||
Args:
|
||||
file_path: The path to the file (string or Path object).
|
||||
|
||||
Returns:
|
||||
The file extension (e.g., '.txt', '.png') or an empty string if no extension.
|
||||
"""
|
||||
return Path(file_path).suffix.lower()
|
||||
|
||||
|
||||
def is_image_file(file_path: Union[str, Path]) -> bool:
|
||||
"""
|
||||
Checks if a file is likely an image based on its extension.
|
||||
|
||||
Args:
|
||||
file_path: The path to the file (string or Path object).
|
||||
|
||||
Returns:
|
||||
True if the file extension is in IMAGE_EXTENSIONS, False otherwise.
|
||||
"""
|
||||
return get_file_extension(file_path) in IMAGE_EXTENSIONS
|
||||
|
||||
|
||||
def is_text_file(file_path: Union[str, Path]) -> bool:
|
||||
"""
|
||||
Checks if a file is likely a text file based on its extension.
|
||||
|
||||
Args:
|
||||
file_path: The path to the file (string or Path object).
|
||||
|
||||
Returns:
|
||||
True if the file extension is in TEXT_EXTENSIONS, False otherwise.
|
||||
"""
|
||||
return get_file_extension(file_path) in TEXT_EXTENSIONS
|
||||
|
||||
|
||||
# --- Text Analysis (Simple Heuristics) ---
|
||||
|
||||
def extract_story_title_from_text(text: str) -> str:
|
||||
"""
|
||||
Attempts to extract a title from story text using simple heuristics.
|
||||
|
||||
Looks for patterns (in order):
|
||||
1. Markdown headers (#, ##, etc.) at the start of a line.
|
||||
2. The first non-empty line if it's short (< 100 chars) and followed by
|
||||
a blank line or is the only line.
|
||||
3. The first non-empty line if it's entirely in uppercase (< 100 chars).
|
||||
|
||||
Args:
|
||||
text: The story text content.
|
||||
|
||||
Returns:
|
||||
An extracted title string, or "Untitled Story" if no pattern matches.
|
||||
"""
|
||||
if not isinstance(text, str) or not text.strip():
|
||||
return "Untitled Story"
|
||||
|
||||
# 1. Check for markdown headers ( # Title, ## Title )
|
||||
# Needs to match start of line (^) with optional whitespace before #
|
||||
header_match = re.search(r'^\s*#+\s+(.+)$', text.strip(), re.MULTILINE)
|
||||
if header_match:
|
||||
title = header_match.group(1).strip()
|
||||
if title: return title
|
||||
|
||||
lines = text.strip().split('\n')
|
||||
if not lines:
|
||||
return "Untitled Story"
|
||||
|
||||
first_line = lines[0].strip()
|
||||
if not first_line: # Skip if first line is blank
|
||||
if len(lines) > 1:
|
||||
first_line = lines[1].strip() # Try second line
|
||||
else:
|
||||
return "Untitled Story"
|
||||
|
||||
if not first_line: # Still no title found
|
||||
return "Untitled Story"
|
||||
|
||||
# 2. Check if first line is short and potentially a title
|
||||
is_short = len(first_line) < 100
|
||||
is_followed_by_blank = len(lines) > 1 and not lines[1].strip()
|
||||
is_only_line = len(lines) == 1
|
||||
|
||||
if is_short and (is_followed_by_blank or is_only_line):
|
||||
return first_line
|
||||
|
||||
# 3. Check if first line is all caps (and short)
|
||||
is_all_caps = first_line == first_line.upper() and first_line.isalpha() # Check if it contains letters
|
||||
if is_short and is_all_caps:
|
||||
return first_line
|
||||
|
||||
# Default if no other pattern matched
|
||||
return "Untitled Story"
|
||||
|
||||
|
||||
def estimate_reading_time(text: str, words_per_minute: int = 200) -> float:
|
||||
"""
|
||||
Estimates the reading time of a text in minutes.
|
||||
|
||||
Args:
|
||||
text: The text content.
|
||||
words_per_minute: The assumed average reading speed.
|
||||
|
||||
Returns:
|
||||
The estimated reading time in minutes. Returns 0.0 for empty text.
|
||||
"""
|
||||
if not isinstance(text, str) or not text.strip():
|
||||
return 0.0
|
||||
if words_per_minute <= 0:
|
||||
raise ValueError("words_per_minute must be positive.")
|
||||
|
||||
word_count = len(text.split())
|
||||
minutes = word_count / words_per_minute
|
||||
return minutes
|
||||
|
||||
|
||||
def count_sentences(text: str) -> int:
|
||||
"""
|
||||
Counts the number of sentences in a text using a very simple heuristic.
|
||||
|
||||
Note: This is a basic implementation counting sentence-ending punctuation
|
||||
(. ! ?). It will be inaccurate with abbreviations (Mr., Mrs., etc.),
|
||||
ellipses, and complex sentence structures.
|
||||
|
||||
Args:
|
||||
text: The text content.
|
||||
|
||||
Returns:
|
||||
An estimated count of sentences. Returns 0 for empty text.
|
||||
"""
|
||||
if not isinstance(text, str) or not text.strip():
|
||||
return 0
|
||||
|
||||
# Find sequences of one or more sentence-ending punctuation marks
|
||||
sentence_endings = re.findall(r'[.!?]+', text)
|
||||
count = len(sentence_endings)
|
||||
|
||||
# Handle edge case where text might not end with punctuation but isn't empty
|
||||
if count == 0 and len(text.strip()) > 0:
|
||||
return 1 # Assume at least one sentence if text exists but no terminators found
|
||||
return count
|
||||
|
||||
|
||||
def extract_character_names(text: str, min_occurrences: int = 2) -> List[str]:
|
||||
"""
|
||||
Attempts to extract potential character names from story text.
|
||||
|
||||
Note: This is a simple heuristic based on finding capitalized words
|
||||
(excluding common sentence starters) that appear multiple times. It has
|
||||
limitations and may produce false positives or miss actual names.
|
||||
|
||||
Args:
|
||||
text: The story text content.
|
||||
min_occurrences: The minimum number of times a capitalized word must
|
||||
appear to be considered a potential name.
|
||||
|
||||
Returns:
|
||||
A list of potential character name strings.
|
||||
"""
|
||||
if not isinstance(text, str) or not text.strip():
|
||||
return []
|
||||
if min_occurrences < 1:
|
||||
min_occurrences = 1 # Ensure at least one occurrence is required
|
||||
|
||||
# Find words starting with an uppercase letter, potentially followed by lowercase
|
||||
# Allows for single-letter names like 'X' but focuses on typical Name structure
|
||||
capitalized_words = re.findall(r'\b[A-Z][a-zA-Z]*\b', text)
|
||||
|
||||
# Count occurrences, excluding common words
|
||||
word_counts: Dict[str, int] = {}
|
||||
for word in capitalized_words:
|
||||
if word not in COMMON_START_WORDS:
|
||||
word_counts[word] = word_counts.get(word, 0) + 1
|
||||
|
||||
# Filter for words that meet the minimum occurrence threshold
|
||||
potential_names = [
|
||||
word for word, count in word_counts.items() if count >= min_occurrences
|
||||
]
|
||||
|
||||
# Sort for consistency (optional)
|
||||
potential_names.sort()
|
||||
|
||||
return potential_names
|
||||
|
||||
|
||||
def extract_setting_details(text: str) -> List[str]:
|
||||
"""
|
||||
Attempts to extract potential setting details using simple regex patterns.
|
||||
|
||||
Note: This is a very basic heuristic looking for common prepositional
|
||||
phrases (e.g., "in the forest", "at the castle"). It is highly limited
|
||||
and likely to miss many setting details or extract irrelevant phrases.
|
||||
|
||||
Args:
|
||||
text: The story text content.
|
||||
|
||||
Returns:
|
||||
A list of potential setting phrases found.
|
||||
"""
|
||||
if not isinstance(text, str) or not text.strip():
|
||||
return []
|
||||
|
||||
# Patterns looking for prepositions followed by nouns/adjectives
|
||||
# Making patterns slightly more general:
|
||||
# (\b\w+\b) captures single words
|
||||
# (\b\w+\s+\w+\b) captures two-word phrases
|
||||
# (\b[A-Z]\w*\b) captures capitalized words (potential proper nouns)
|
||||
setting_patterns = [
|
||||
r'\b(?:in|on|at|near|beside|inside|outside|under|over|through)\s+(?:the|a|an)\s+((?:[A-Z]\w*|\w+)(?:\s+\w+){0,2})\b', # e.g., in the old house
|
||||
r'\b(?:in|on|at)\s+((?:[A-Z]\w+)(?:\s+[A-Z]\w+)*)\b', # e.g., in New York City
|
||||
r'\b(?:during|before|after)\s+(?:the|a|an)\s+(\w+(?:\s+\w+){0,2})\b', # e.g., during the storm
|
||||
]
|
||||
|
||||
settings_found = set() # Use a set to avoid duplicates
|
||||
for pattern in setting_patterns:
|
||||
try:
|
||||
matches = re.findall(pattern, text, re.IGNORECASE) # Ignore case
|
||||
for match in matches:
|
||||
# If match is tuple due to multiple capture groups, join them?
|
||||
# For these patterns, it should be single strings.
|
||||
if isinstance(match, str):
|
||||
phrase = match.strip()
|
||||
if phrase and len(phrase.split()) <= 5: # Limit phrase length
|
||||
settings_found.add(phrase)
|
||||
except re.error as e:
|
||||
logger.warning(f"Regex error in extract_setting_details: {e} with pattern: {pattern}")
|
||||
|
||||
|
||||
# Convert set back to list and sort for consistency
|
||||
sorted_settings = sorted(list(settings_found))
|
||||
return sorted_settings
|
||||
|
||||
|
||||
# --- Image Operations ---
|
||||
|
||||
def get_image_dimensions(image_path: Union[str, Path]) -> Optional[Tuple[int, int]]:
|
||||
"""
|
||||
Gets the (width, height) dimensions of an image file using Pillow.
|
||||
|
||||
Args:
|
||||
image_path: The path to the image file (string or Path object).
|
||||
|
||||
Returns:
|
||||
A tuple (width, height) if successful, or None if the file is not
|
||||
a valid image, Pillow is not installed, or an error occurs.
|
||||
"""
|
||||
if not _PIL_AVAILABLE:
|
||||
logger.warning("Pillow (PIL) library not installed. Cannot get image dimensions.")
|
||||
return None
|
||||
|
||||
img_path = Path(image_path)
|
||||
if not img_path.is_file():
|
||||
logger.error(f"Image file not found or is not a file: {image_path}")
|
||||
return None
|
||||
|
||||
try:
|
||||
with Image.open(img_path) as img:
|
||||
width, height = img.size
|
||||
logger.debug(f"Dimensions for {image_path}: {width}x{height}")
|
||||
return width, height
|
||||
except FileNotFoundError:
|
||||
logger.error(f"Image file not found at path: {image_path}")
|
||||
return None
|
||||
except UnidentifiedImageError: # Specific Pillow error for invalid images
|
||||
logger.error(f"Could not identify image file (invalid format or corrupted): {image_path}")
|
||||
return None
|
||||
except Exception as e:
|
||||
logger.error(f"Error getting dimensions for image {image_path}: {e}", exc_info=True)
|
||||
return None
|
||||
31
ToBeMigrated/ai_writers/ai_story_video_generator/README.md
Normal file
31
ToBeMigrated/ai_writers/ai_story_video_generator/README.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AI Story Video Generator
|
||||
|
||||
This module allows users to generate animated story videos using AI. It leverages Google's Gemini model to create stories and generate images for each scene, then combines them into a video.
|
||||
|
||||
## Features
|
||||
|
||||
- Generate complete stories based on user prompts
|
||||
- Create scene-by-scene storyboards
|
||||
- Generate images for each scene using Gemini
|
||||
- Compile images into an animated video
|
||||
- Add background music and text overlays
|
||||
- Export videos in MP4 format
|
||||
|
||||
## How It Works
|
||||
|
||||
1. User provides a story prompt and preferences
|
||||
2. AI generates a complete story with multiple scenes
|
||||
3. For each scene, an image is generated
|
||||
4. Images are compiled into a video with transitions
|
||||
5. Optional background music and text overlays are added
|
||||
6. The final video is available for download
|
||||
|
||||
## Requirements
|
||||
|
||||
- Google Gemini API key
|
||||
- FFmpeg for video processing
|
||||
- Python libraries: moviepy, pillow, requests
|
||||
|
||||
## Usage
|
||||
|
||||
Access this tool through the Streamlit interface by selecting "AI Story Video Generator" from the main menu.
|
||||
@@ -0,0 +1,4 @@
|
||||
# AI Story Video Generator module
|
||||
from .story_video_generator import write_story_video_generator
|
||||
|
||||
__all__ = ["write_story_video_generator"]
|
||||
File diff suppressed because it is too large
Load Diff
64
ToBeMigrated/ai_writers/ai_story_video_generator/utils.py
Normal file
64
ToBeMigrated/ai_writers/ai_story_video_generator/utils.py
Normal file
@@ -0,0 +1,64 @@
|
||||
"""
|
||||
Utility functions for the AI Story Video Generator.
|
||||
"""
|
||||
|
||||
import os
|
||||
import tempfile
|
||||
import uuid
|
||||
from pathlib import Path
|
||||
from typing import Optional
|
||||
|
||||
# Constants
|
||||
TEMP_DIR = Path(tempfile.gettempdir()) / "alwrity_story_generator"
|
||||
|
||||
def ensure_temp_dir() -> Path:
|
||||
"""Ensure the temporary directory exists and return its path."""
|
||||
os.makedirs(TEMP_DIR, exist_ok=True)
|
||||
return TEMP_DIR
|
||||
|
||||
def get_temp_filepath(prefix: str, extension: str) -> str:
|
||||
"""Generate a temporary file path with the given prefix and extension."""
|
||||
temp_dir = ensure_temp_dir()
|
||||
return str(temp_dir / f"{prefix}_{uuid.uuid4()}.{extension}")
|
||||
|
||||
def clean_temp_files(older_than_hours: int = 24) -> int:
|
||||
"""
|
||||
Clean temporary files older than the specified number of hours.
|
||||
|
||||
Args:
|
||||
older_than_hours: Remove files older than this many hours
|
||||
|
||||
Returns:
|
||||
Number of files removed
|
||||
"""
|
||||
import time
|
||||
from datetime import datetime, timedelta
|
||||
|
||||
temp_dir = ensure_temp_dir()
|
||||
cutoff_time = time.time() - (older_than_hours * 3600)
|
||||
count = 0
|
||||
|
||||
for file_path in temp_dir.glob("*"):
|
||||
if file_path.is_file() and file_path.stat().st_mtime < cutoff_time:
|
||||
try:
|
||||
file_path.unlink()
|
||||
count += 1
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
return count
|
||||
|
||||
def format_duration(seconds: float) -> str:
|
||||
"""Format seconds into a MM:SS string."""
|
||||
minutes = int(seconds // 60)
|
||||
remaining_seconds = int(seconds % 60)
|
||||
return f"{minutes}:{remaining_seconds:02d}"
|
||||
|
||||
def sanitize_filename(filename: str) -> str:
|
||||
"""Sanitize a string to be used as a filename."""
|
||||
import re
|
||||
# Remove invalid characters
|
||||
sanitized = re.sub(r'[^\w\s-]', '', filename)
|
||||
# Replace spaces with underscores
|
||||
sanitized = sanitized.strip().replace(' ', '_')
|
||||
return sanitized
|
||||
103
ToBeMigrated/ai_writers/ai_story_writer/README.md
Normal file
103
ToBeMigrated/ai_writers/ai_story_writer/README.md
Normal file
@@ -0,0 +1,103 @@
|
||||
# AI Story Generator App
|
||||
|
||||
In the age of AI, creativity and technology are intertwining in ways that are transforming how we tell stories. Imagine having the power to craft a captivating narrative tailored to your exact specifications with just a few clicks. Whether you're an aspiring writer, a seasoned novelist, or just someone who loves a good story, our new AI-powered story writing app is here to make storytelling easier and more engaging than ever before.
|
||||
|
||||
## Why an AI Story Writing App?
|
||||
|
||||
Storytelling has always been a cherished art form, but not everyone finds it easy to start from scratch. With the AI Story Generator App, you can create detailed and personalized stories by simply providing some key inputs. Our app uses advanced AI to turn your ideas into compelling narratives, helping you overcome writer's block and unleashing your creative potential.
|
||||
|
||||
## Features of the AI Story Generator App
|
||||
|
||||
### Genre
|
||||
Choose from a variety of genres such as Fantasy, Sci-Fi, Mystery, Romance, and Horror to set the tone for your story.
|
||||
|
||||
### Story Setting
|
||||
Provide a detailed setting for your story, including location and time period.
|
||||
|
||||
For example:
|
||||
A bustling futuristic city with towering skyscrapers and flying cars, set in the year 2150. The city is known for its technological advancements but has a dark underbelly of crime and corruption.
|
||||
|
||||
|
||||
### Main Characters
|
||||
Input the names, descriptions, and roles of your main characters.
|
||||
|
||||
For example:
|
||||
Character Names: John, Xishan, Amol
|
||||
Character Descriptions: John is a tall, muscular man with a kind heart. Xishan is a clever and resourceful woman. Amol is a mischievous and energetic young boy.
|
||||
Character Roles: John - Hero, Xishan - Sidekick, Amol - Supporting Character
|
||||
|
||||
|
||||
### Plot Elements
|
||||
Outline the key plot elements including the story theme, key events, and main conflict.
|
||||
|
||||
For example:
|
||||
Story Theme: Love conquers all, The hero's journey, Good vs. evil
|
||||
|
||||
Key Events or Plot Points:
|
||||
|
||||
The hero meets the villain
|
||||
The hero faces a challenge
|
||||
The hero overcomes the conflict
|
||||
Main Conflict or Problem:
|
||||
The hero must save the world from a powerful enemy, The hero must overcome a personal obstacle to achieve their goal.
|
||||
|
||||
|
||||
### Tone and Style
|
||||
Choose the writing style, tone, and narrative point of view for your story.
|
||||
|
||||
For example:
|
||||
Writing Style: Formal, Casual, Poetic, Humorous
|
||||
Story Tone: Dark
|
||||
|
||||
### Perspective
|
||||
Choose the narrative point of view from which the story is told (e.g., first person, third person limited, third person omniscient).
|
||||
|
||||
### Target Audience
|
||||
Specify the intended audience age group (Children, Young Adults, Adults) and set a content rating (G, PG, PG-13, R) for appropriateness.
|
||||
|
||||
### Ending Preference
|
||||
Select the type of ending you prefer for the story (e.g., happy, tragic, cliffhanger, twist).
|
||||
|
||||
## How to Use
|
||||
|
||||
Choose Genre: Select the genre that best fits your story idea.
|
||||
Set Story Setting: Describe the setting and time period where your story unfolds.
|
||||
Define Characters: Provide names, descriptions, and roles for your main characters.
|
||||
Outline Plot Elements: Detail the story's theme, key events, and main conflict.
|
||||
Select Tone and Style: Choose the writing style and tone that align with your story's mood.
|
||||
Specify Perspective: Decide on the narrative point of view.
|
||||
Target Audience: Specify the age group and content rating.
|
||||
Choose Ending: Select the preferred type of story conclusion.
|
||||
Generate Story: Click the "Generate Story" button to receive a customized story prompt based on your inputs.
|
||||
|
||||
|
||||
### Example Prompt
|
||||
|
||||
**Genre:** Fantasy
|
||||
**Setting:** A mystical forest in a medieval realm, where magic thrives and mythical creatures roam freely.
|
||||
**Characters:**
|
||||
- Name: Elara
|
||||
Description: Elara is a young elf with a mischievous glint in her emerald eyes, known for her ability to wield powerful spells.
|
||||
Role: Protagonist
|
||||
- Name: Thorne
|
||||
Description: Thorne is a gruff dwarf with a heart of gold, skilled in forging enchanted weapons.
|
||||
Role: Sidekick
|
||||
- Name: Malachai
|
||||
Description: Malachai is a cunning dragon with shimmering scales of azure, whose allegiance is uncertain.
|
||||
Role: Antagonist
|
||||
|
||||
**Plot Elements:**
|
||||
- Theme: The power of friendship and bravery in the face of adversity.
|
||||
- Key Events: Elara discovers an ancient prophecy that foretells a looming darkness threatening the realm. Thorne crafts a legendary sword to aid in their quest. Malachai challenges Elara's resolve, forcing her to make a difficult choice.
|
||||
- Conflict: Elara must gather allies and confront the dark sorcerer who seeks to plunge the realm into eternal shadow.
|
||||
|
||||
**Writing Style:** Poetic
|
||||
**Tone:** Whimsical
|
||||
**Point of View:** Third Person Limited
|
||||
|
||||
**Audience:** Young Adults, **Content Rating:** PG
|
||||
**Ending:** Happy
|
||||
|
||||
|
||||
|
||||
|
||||
238
ToBeMigrated/ai_writers/ai_story_writer/ai_story_generator.py
Normal file
238
ToBeMigrated/ai_writers/ai_story_writer/ai_story_generator.py
Normal file
@@ -0,0 +1,238 @@
|
||||
#####################################################
|
||||
#
|
||||
# google-gemini-cookbook - Story_Writing_with_Prompt_Chaining
|
||||
#
|
||||
#####################################################
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
import streamlit as st
|
||||
from loguru import logger
|
||||
import sys
|
||||
|
||||
from ...gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
|
||||
|
||||
def generate_with_retry(prompt, system_prompt=None):
|
||||
"""
|
||||
Generates content using the llm_text_gen function with retry handling for errors.
|
||||
|
||||
Parameters:
|
||||
prompt (str): The prompt to generate content from.
|
||||
system_prompt (str, optional): Custom system prompt to use instead of the default one.
|
||||
|
||||
Returns:
|
||||
str: The generated content.
|
||||
"""
|
||||
try:
|
||||
# Use llm_text_gen instead of directly calling the model
|
||||
return llm_text_gen(prompt, system_prompt)
|
||||
except Exception as e:
|
||||
logger.error(f"Error generating content: {e}")
|
||||
return ""
|
||||
|
||||
|
||||
def ai_story(persona, story_setting, character_input,
|
||||
plot_elements, writing_style, story_tone, narrative_pov,
|
||||
audience_age_group, content_rating, ending_preference):
|
||||
"""
|
||||
Write a story using prompt chaining and iterative generation.
|
||||
|
||||
Parameters:
|
||||
persona (str): The persona statement for the author.
|
||||
story_setting (str): The setting of the story.
|
||||
character_input (str): The characters in the story.
|
||||
plot_elements (str): The plot elements of the story.
|
||||
writing_style (str): The writing style of the story.
|
||||
story_tone (str): The tone of the story.
|
||||
narrative_pov (str): The narrative point of view.
|
||||
audience_age_group (str): The target audience age group.
|
||||
content_rating (str): The content rating of the story.
|
||||
ending_preference (str): The preferred ending of the story.
|
||||
"""
|
||||
st.info(f"""
|
||||
You have chosen to create a story set in **{story_setting}**.
|
||||
The main characters are: **{character_input}**.
|
||||
The plot will revolve around the theme of **{plot_elements}**.
|
||||
The story will be written in a **{writing_style}** style with a **{story_tone}** tone, from a **{narrative_pov}** perspective.
|
||||
It is intended for a **{audience_age_group}** audience with a **{content_rating}** rating.
|
||||
You prefer the story to have a **{ending_preference}** ending.
|
||||
""")
|
||||
try:
|
||||
persona = f"""{persona}
|
||||
Write a story with the following details:
|
||||
|
||||
**The stroy Setting is:**
|
||||
{story_setting}
|
||||
|
||||
**The Characters of the story are:**
|
||||
{character_input}
|
||||
|
||||
**Plot Elements of the story:**
|
||||
{plot_elements}
|
||||
|
||||
**Story Writing Style:**
|
||||
{writing_style}
|
||||
|
||||
**The story Tone is:**
|
||||
{story_tone}
|
||||
|
||||
**Write story from the Point of View of:**
|
||||
{narrative_pov}
|
||||
|
||||
**Target Audience of the story:**
|
||||
{audience_age_group}, **Content Rating:** {content_rating}
|
||||
|
||||
**Story Ending:**
|
||||
{ending_preference}
|
||||
|
||||
Make sure the story is engaging and tailored to the specified audience and content rating.
|
||||
Ensure the ending aligns with the preference indicated.
|
||||
|
||||
"""
|
||||
# Define persona and writing guidelines
|
||||
guidelines = f'''\
|
||||
Writing Guidelines:
|
||||
|
||||
Delve deeper. Lose yourself in the world you're building. Unleash vivid
|
||||
descriptions to paint the scenes in your reader's mind.
|
||||
Develop your characters — let their motivations, fears, and complexities unfold naturally.
|
||||
Weave in the threads of your outline, but don't feel constrained by it.
|
||||
Allow your story to surprise you as you write. Use rich imagery, sensory details, and
|
||||
evocative language to bring the setting, characters, and events to life.
|
||||
Introduce elements subtly that can blossom into complex subplots, relationships,
|
||||
or worldbuilding details later in the story.
|
||||
Keep things intriguing but not fully resolved.
|
||||
Avoid boxing the story into a corner too early.
|
||||
Plant the seeds of subplots or potential character arc shifts that can be expanded later.
|
||||
|
||||
Remember, your main goal is to write as much as you can. If you get through
|
||||
the story too fast, that is bad. Expand, never summarize.
|
||||
'''
|
||||
|
||||
# Generate prompts
|
||||
premise_prompt = f'''\
|
||||
{persona}
|
||||
|
||||
Write a single sentence premise for a {story_setting} story featuring {character_input}.
|
||||
'''
|
||||
|
||||
outline_prompt = f'''\
|
||||
{persona}
|
||||
|
||||
You have a gripping premise in mind:
|
||||
|
||||
{{premise}}
|
||||
|
||||
Write an outline for the plot of your story.
|
||||
'''
|
||||
|
||||
starting_prompt = f'''\
|
||||
{persona}
|
||||
|
||||
You have a gripping premise in mind:
|
||||
|
||||
{{premise}}
|
||||
|
||||
Your imagination has crafted a rich narrative outline:
|
||||
|
||||
{{outline}}
|
||||
|
||||
First, silently review the outline and the premise. Consider how to start the
|
||||
story.
|
||||
|
||||
Start to write the very beginning of the story. You are not expected to finish
|
||||
the whole story now. Your writing should be detailed enough that you are only
|
||||
scratching the surface of the first bullet of your outline. Try to write AT
|
||||
MINIMUM 4000 WORDS.
|
||||
|
||||
{guidelines}
|
||||
'''
|
||||
|
||||
continuation_prompt = f'''\
|
||||
{persona}
|
||||
|
||||
You have a gripping premise in mind:
|
||||
|
||||
{{premise}}
|
||||
|
||||
Your imagination has crafted a rich narrative outline:
|
||||
|
||||
{{outline}}
|
||||
|
||||
You've begun to immerse yourself in this world, and the words are flowing.
|
||||
Here's what you've written so far:
|
||||
|
||||
{{story_text}}
|
||||
|
||||
=====
|
||||
|
||||
First, silently review the outline and story so far. Identify what the single
|
||||
next part of your outline you should write.
|
||||
|
||||
Your task is to continue where you left off and write the next part of the story.
|
||||
You are not expected to finish the whole story now. Your writing should be
|
||||
detailed enough that you are only scratching the surface of the next part of
|
||||
your outline. Try to write AT MINIMUM 2000 WORDS. However, only once the story
|
||||
is COMPLETELY finished, write IAMDONE. Remember, do NOT write a whole chapter
|
||||
right now.
|
||||
|
||||
{guidelines}
|
||||
'''
|
||||
|
||||
# Generate prompts
|
||||
try:
|
||||
premise = generate_with_retry(premise_prompt)
|
||||
st.info(f"The premise of the story is: {premise}")
|
||||
except Exception as err:
|
||||
st.error(f"Premise Generation Error: {err}")
|
||||
return
|
||||
|
||||
outline = generate_with_retry(outline_prompt.format(premise=premise))
|
||||
with st.expander("Click to Checkout the outline, writing still in progress.."):
|
||||
st.markdown(f"The Outline of the story is: {outline}\n\n")
|
||||
|
||||
if not outline:
|
||||
st.error("Failed to generate outline. Exiting...")
|
||||
return
|
||||
|
||||
# Generate starting draft
|
||||
try:
|
||||
starting_draft = generate_with_retry(
|
||||
starting_prompt.format(premise=premise, outline=outline))
|
||||
except Exception as err:
|
||||
st.error(f"Failed to Generate Story draft: {err}")
|
||||
return
|
||||
|
||||
try:
|
||||
draft = starting_draft
|
||||
continuation = generate_with_retry(
|
||||
continuation_prompt.format(premise=premise, outline=outline, story_text=draft))
|
||||
except Exception as err:
|
||||
st.error(f"Failed to write the initial draft: {err}")
|
||||
|
||||
# Add the continuation to the initial draft, keep building the story until we see 'IAMDONE'
|
||||
try:
|
||||
draft += '\n\n' + continuation
|
||||
except Exception as err:
|
||||
st.error(f"Failed as: {err} and {continuation}")
|
||||
|
||||
with st.status("Story Writing in Progress..", expanded=True) as status:
|
||||
status.update(label=f"Writing in progress... Current draft length: {len(draft)} characters")
|
||||
while 'IAMDONE' not in continuation:
|
||||
try:
|
||||
status.update(label=f"Writing in progress... Current draft length: {len(draft)} characters")
|
||||
continuation = generate_with_retry(
|
||||
continuation_prompt.format(premise=premise, outline=outline, story_text=draft))
|
||||
draft += '\n\n' + continuation
|
||||
except Exception as err:
|
||||
st.error(f"Failed to continually write the story: {err}")
|
||||
return
|
||||
|
||||
# Remove 'IAMDONE' and print the final story
|
||||
final = draft.replace('IAMDONE', '').strip()
|
||||
return(final)
|
||||
|
||||
except Exception as e:
|
||||
st.error(f"Main Story writing: An error occurred: {e}")
|
||||
return ""
|
||||
134
ToBeMigrated/ai_writers/ai_story_writer/story_writer.py
Normal file
134
ToBeMigrated/ai_writers/ai_story_writer/story_writer.py
Normal file
@@ -0,0 +1,134 @@
|
||||
import time
|
||||
import os
|
||||
import json
|
||||
import streamlit as st
|
||||
|
||||
from .ai_story_generator import ai_story
|
||||
|
||||
|
||||
def story_input_section():
|
||||
st.title("🧕 Alwrity - AI Story Writer")
|
||||
personas = [
|
||||
("Award-Winning Science Fiction Author", "👽 Award-Winning Science Fiction Author"),
|
||||
("Historical Fiction Author", "🏺 Historical Fiction Author"),
|
||||
("Fantasy World Builder", "🧙 Fantasy World Builder"),
|
||||
("Mystery Novelist", "🕵️ Mystery Novelist"),
|
||||
("Romantic Poet", "💌 Romantic Poet"),
|
||||
("Thriller Writer", "🔪 Thriller Writer"),
|
||||
("Children's Book Author", "📚 Children's Book Author"),
|
||||
("Satirical Humorist", "😂 Satirical Humorist"),
|
||||
("Biographical Writer", "📜 Biographical Writer"),
|
||||
("Dystopian Visionary", "🌆 Dystopian Visionary"),
|
||||
("Magical Realism Author", "🪄 Magical Realism Author")
|
||||
]
|
||||
|
||||
selected_persona_name = st.selectbox(
|
||||
"Select Your Story Writing Persona Or Book Genre",
|
||||
options=[persona[0] for persona in personas]
|
||||
)
|
||||
|
||||
persona_descriptions = {
|
||||
"Award-Winning Science Fiction Author": "You are an award-winning science fiction author with a penchant for expansive, intricately woven stories. Your ultimate goal is to write the next award-winning sci-fi novel.",
|
||||
"Historical Fiction Author": "You are a seasoned historical fiction author, meticulously researching past eras to weave captivating narratives. Your goal is to transport readers to different times and places through your vivid storytelling.",
|
||||
"Fantasy World Builder": "You are a world-building enthusiast, crafting intricate realms filled with magic, mythical creatures, and epic quests. Your ambition is to create the next immersive fantasy saga that captivates readers' imaginations.",
|
||||
"Mystery Novelist": "You are a master of suspense and intrigue, intricately plotting out mysteries with unexpected twists and turns. Your aim is to keep readers on the edge of their seats, eagerly turning pages to unravel the truth.",
|
||||
"Romantic Poet": "You are a romantic at heart, composing verses that capture the essence of love, longing, and human connections. Your dream is to write the next timeless love story that leaves readers swooning.",
|
||||
"Thriller Writer": "You are a thrill-seeker, crafting adrenaline-pumping tales of danger, suspense, and high-stakes action. Your mission is to keep readers hooked from start to finish with heart-pounding thrills and unexpected twists.",
|
||||
"Children's Book Author": "You are a storyteller for the young and young at heart, creating whimsical worlds and lovable characters that inspire imagination and wonder. Your goal is to spark joy and curiosity in young readers with enchanting tales.",
|
||||
"Satirical Humorist": "You are a keen observer of society, using humor and wit to satirize the absurdities of everyday life. Your aim is to entertain and provoke thought, delivering biting social commentary through clever and humorous storytelling.",
|
||||
"Biographical Writer": "You are a chronicler of lives, delving into the stories of real people and events to illuminate the human experience. Your passion is to bring history to life through richly detailed biographies that resonate with readers.",
|
||||
"Dystopian Visionary": "You are a visionary writer, exploring dark and dystopian futures that reflect contemporary fears and anxieties. Your vision is to challenge societal norms and provoke reflection on the path humanity is heading.",
|
||||
"Magical Realism Author": "You are a purveyor of magical realism, blending the ordinary with the extraordinary to create enchanting and thought-provoking tales. Your goal is to blur the lines between reality and fantasy, leaving readers enchanted and introspective."
|
||||
}
|
||||
|
||||
# Story Setting
|
||||
st.subheader("🌍 Story Setting")
|
||||
story_setting = st.text_area(
|
||||
label="**Story Setting** (e.g., medieval kingdom in the past, futuristic city in the future, haunted house in the present):",
|
||||
placeholder="""Enter settings for your story, like Location (e.g., medieval kingdom, futuristic city, haunted house),
|
||||
Time period in which your story is set (e.g: Past, Present, Future)
|
||||
Example: 'A bustling futuristic city with towering skyscrapers and flying cars, set in the year 2150.
|
||||
The city is known for its technological advancements but has a dark underbelly of crime and corruption.'""",
|
||||
help="Describe the main location and time period where the story will unfold in a detailed manner."
|
||||
)
|
||||
|
||||
# Main Characters
|
||||
st.subheader("👥 Main Characters")
|
||||
character_input = st.text_area(
|
||||
label="**Character Information** (Names, Descriptions, Roles)",
|
||||
placeholder="""Example:
|
||||
Character Names: John, Xishan, Amol
|
||||
Character Descriptions: John is a tall, muscular man with a kind heart. Xishan is a clever and resourceful woman. Amol is a mischievous and energetic young boy.
|
||||
Character Roles: John - Hero, Xishan - Sidekick, Amol - Supporting Character""",
|
||||
help="Enter character information as specified in the placeholder."
|
||||
)
|
||||
|
||||
# Plot Elements
|
||||
st.subheader("🗺️ Plot Elements")
|
||||
plot_elements = st.text_area(
|
||||
"**Plot Elements** - (Theme, Key Events & Main Conflict)",
|
||||
placeholder="""Example:
|
||||
Story Theme: Love conquers all, The hero's journey, Good vs. evil.
|
||||
Key Events: The hero meets the villain, The hero faces a challenge, The hero overcomes the conflict.
|
||||
Main Conflict: The hero must save the world from a powerful enemy, The hero must overcome a personal obstacle to achieve their goal.""",
|
||||
help="Enter plot elements as specified in the placeholder."
|
||||
)
|
||||
|
||||
# Tone and Style
|
||||
st.subheader("🎨 Tone and Style")
|
||||
col1, col2, col3 = st.columns(3)
|
||||
with col1:
|
||||
writing_style = st.selectbox(
|
||||
"**Writing Style:**",
|
||||
["🧐 Formal", "😎 Casual", "🎼 Poetic", "😂 Humorous"],
|
||||
help="Choose the writing style that fits your story."
|
||||
)
|
||||
with col2:
|
||||
story_tone = st.selectbox(
|
||||
"**Story Tone:**",
|
||||
["🌑 Dark", "☀️ Uplifting", "⏳ Suspenseful", "🎈 Whimsical"],
|
||||
help="Select the overall tone or mood of the story."
|
||||
)
|
||||
with col3:
|
||||
narrative_pov = st.selectbox(
|
||||
"**Narrative Point of View:**",
|
||||
["👤 First Person", "👥 Third Person Limited", "👁️ Third Person Omniscient"],
|
||||
help="Choose the point of view from which the story is told."
|
||||
)
|
||||
|
||||
# Target Audience
|
||||
st.subheader("👨👩👧👦 Target Audience")
|
||||
col1, col2, col3 = st.columns(3)
|
||||
with col1:
|
||||
audience_age_group = st.selectbox(
|
||||
"**Audience Age Group:**",
|
||||
["🧒 Children", "👨🎓 Young Adults", "🧑🦳 Adults"],
|
||||
help="Choose the intended audience age group."
|
||||
)
|
||||
with col2:
|
||||
content_rating = st.selectbox(
|
||||
"**Content Rating:**",
|
||||
["🟢 G", "🟡 PG", "🔵 PG-13", "🔴 R"],
|
||||
help="Select a content rating for appropriateness."
|
||||
)
|
||||
with col3:
|
||||
ending_preference = st.selectbox(
|
||||
"Story Conclusion:",
|
||||
["😊 Happy", "😢 Tragic", "❓ Cliffhanger", "🔀 Twist"],
|
||||
help="Choose the type of ending you prefer for the story."
|
||||
)
|
||||
|
||||
if st.button('AI, Write a Story..'):
|
||||
if character_input.strip():
|
||||
with st.spinner("Generating Story...💥💥"):
|
||||
story_content = ai_story(persona_descriptions[selected_persona_name],
|
||||
story_setting, character_input, plot_elements, writing_style,
|
||||
story_tone, narrative_pov, audience_age_group, content_rating,
|
||||
ending_preference)
|
||||
if story_content:
|
||||
st.subheader('**🧕 Your Awesome Story:**')
|
||||
st.markdown(story_content)
|
||||
else:
|
||||
st.error("💥 **Failed to generate Story. Please try again!**")
|
||||
else:
|
||||
st.error("Describe the story you have in your mind.. !")
|
||||
220
ToBeMigrated/ai_writers/ai_writer_dashboard.py
Normal file
220
ToBeMigrated/ai_writers/ai_writer_dashboard.py
Normal file
@@ -0,0 +1,220 @@
|
||||
import streamlit as st
|
||||
from lib.utils.alwrity_utils import (essay_writer, ai_news_writer, ai_finance_ta_writer)
|
||||
|
||||
from lib.ai_writers.ai_story_writer.story_writer import story_input_section
|
||||
from lib.ai_writers.ai_product_description_writer import write_ai_prod_desc
|
||||
from lib.ai_writers.ai_copywriter.copywriter_dashboard import copywriter_dashboard
|
||||
from lib.ai_writers.linkedin_writer import LinkedInAIWriter
|
||||
from lib.ai_writers.blog_rewriter_updater.ai_blog_rewriter import write_blog_rewriter
|
||||
from lib.ai_writers.ai_blog_faqs_writer.faqs_ui import main as faqs_generator
|
||||
from lib.ai_writers.ai_blog_writer.ai_blog_generator import ai_blog_writer_page
|
||||
from lib.ai_writers.ai_outline_writer.outline_ui import main as outline_generator
|
||||
from lib.alwrity_ui.dashboard_styles import apply_dashboard_style, render_dashboard_header, render_category_header, render_card
|
||||
from loguru import logger
|
||||
|
||||
# Try to import AI Content Performance Predictor (AI-first approach)
|
||||
try:
|
||||
from lib.content_performance_predictor.ai_performance_predictor import render_ai_predictor_ui as render_content_performance_predictor
|
||||
AI_PREDICTOR_AVAILABLE = True
|
||||
logger.info("AI Content Performance Predictor loaded successfully")
|
||||
except ImportError:
|
||||
logger.warning("AI Content Performance Predictor not available")
|
||||
render_content_performance_predictor = None
|
||||
AI_PREDICTOR_AVAILABLE = False
|
||||
|
||||
# Try to import Bootstrap AI Competitive Suite
|
||||
try:
|
||||
from lib.ai_competitive_suite.bootstrap_ai_suite import render_bootstrap_ai_suite
|
||||
BOOTSTRAP_SUITE_AVAILABLE = True
|
||||
logger.info("Bootstrap AI Competitive Suite loaded successfully")
|
||||
except ImportError:
|
||||
logger.warning("Bootstrap AI Competitive Suite not available")
|
||||
render_bootstrap_ai_suite = None
|
||||
BOOTSTRAP_SUITE_AVAILABLE = False
|
||||
|
||||
def list_ai_writers():
|
||||
"""Return a list of available AI writers with their metadata (no UI rendering)."""
|
||||
writers = []
|
||||
|
||||
# Add Content Performance Predictor if available
|
||||
if render_content_performance_predictor:
|
||||
# AI-first approach description
|
||||
if AI_PREDICTOR_AVAILABLE:
|
||||
description = "🎯 AI-powered content performance prediction with competitive intelligence - perfect for solo entrepreneurs"
|
||||
name = "AI Content Performance Predictor"
|
||||
else:
|
||||
description = "Predict content success before publishing with AI-powered performance analysis"
|
||||
name = "Content Performance Predictor"
|
||||
|
||||
writers.append({
|
||||
"name": name,
|
||||
"icon": "🎯",
|
||||
"description": description,
|
||||
"category": "⭐ Featured",
|
||||
"function": render_content_performance_predictor,
|
||||
"path": "performance_predictor",
|
||||
"featured": True
|
||||
})
|
||||
|
||||
# Add Bootstrap AI Competitive Suite if available
|
||||
if render_bootstrap_ai_suite:
|
||||
writers.append({
|
||||
"name": "Bootstrap AI Competitive Suite",
|
||||
"icon": "🚀",
|
||||
"description": "🥷 Complete AI-powered competitive toolkit: content performance prediction + competitive intelligence for solo entrepreneurs",
|
||||
"category": "⭐ Featured",
|
||||
"function": render_bootstrap_ai_suite,
|
||||
"path": "bootstrap_ai_suite",
|
||||
"featured": True
|
||||
})
|
||||
|
||||
# Add existing writers
|
||||
writers.extend([
|
||||
{
|
||||
"name": "AI Blog Writer",
|
||||
"icon": "📝",
|
||||
"description": "Generate comprehensive blog posts from keywords, URLs, or uploaded content",
|
||||
"category": "Content Creation",
|
||||
"function": ai_blog_writer_page,
|
||||
"path": "ai_blog_writer"
|
||||
},
|
||||
{
|
||||
"name": "AI Blog Rewriter",
|
||||
"icon": "🔄",
|
||||
"description": "Rewrite and update existing blog content with improved quality and SEO optimization",
|
||||
"category": "Content Creation",
|
||||
"function": write_blog_rewriter,
|
||||
"path": "blog_rewriter"
|
||||
},
|
||||
{
|
||||
"name": "Story Writer",
|
||||
"icon": "📚",
|
||||
"description": "Create engaging stories and narratives with AI assistance",
|
||||
"category": "Creative Writing",
|
||||
"function": story_input_section,
|
||||
"path": "story_writer"
|
||||
},
|
||||
{
|
||||
"name": "Essay writer",
|
||||
"icon": "✍️",
|
||||
"description": "Generate well-structured essays on any topic",
|
||||
"category": "Academic",
|
||||
"function": essay_writer,
|
||||
"path": "essay_writer"
|
||||
},
|
||||
{
|
||||
"name": "Write News reports",
|
||||
"icon": "📰",
|
||||
"description": "Create professional news articles and reports",
|
||||
"category": "Journalism",
|
||||
"function": ai_news_writer,
|
||||
"path": "news_writer"
|
||||
},
|
||||
{
|
||||
"name": "Write Financial TA report",
|
||||
"icon": "📊",
|
||||
"description": "Generate technical analysis reports for financial markets",
|
||||
"category": "Finance",
|
||||
"function": ai_finance_ta_writer,
|
||||
"path": "financial_writer"
|
||||
},
|
||||
{
|
||||
"name": "AI Product Description Writer",
|
||||
"icon": "🛍️",
|
||||
"description": "Create compelling product descriptions that drive sales",
|
||||
"category": "E-commerce",
|
||||
"function": write_ai_prod_desc,
|
||||
"path": "product_writer"
|
||||
},
|
||||
{
|
||||
"name": "AI Copywriter",
|
||||
"icon": "✒️",
|
||||
"description": "Generate persuasive copy for marketing and advertising",
|
||||
"category": "Marketing",
|
||||
"function": copywriter_dashboard,
|
||||
"path": "copywriter"
|
||||
},
|
||||
{
|
||||
"name": "LinkedIn AI Writer",
|
||||
"icon": "💼",
|
||||
"description": "Create professional LinkedIn content that engages your network",
|
||||
"category": "Professional",
|
||||
"function": lambda: LinkedInAIWriter().run(),
|
||||
"path": "linkedin_writer"
|
||||
},
|
||||
{
|
||||
"name": "FAQ Generator",
|
||||
"icon": "❓",
|
||||
"description": "Generate comprehensive, well-researched FAQs from any content source with customizable options",
|
||||
"category": "Content Creation",
|
||||
"function": faqs_generator,
|
||||
"path": "faqs_generator"
|
||||
},
|
||||
{
|
||||
"name": "Blog Outline Generator",
|
||||
"icon": "📋",
|
||||
"description": "Create detailed blog outlines with AI-powered content generation and image integration",
|
||||
"category": "Content Creation",
|
||||
"function": outline_generator,
|
||||
"path": "outline_generator"
|
||||
}
|
||||
])
|
||||
|
||||
return writers
|
||||
|
||||
def get_ai_writers():
|
||||
"""Main function to display AI writers dashboard with premium glassmorphic design."""
|
||||
logger.info("Starting AI Writers Dashboard")
|
||||
|
||||
# Apply common dashboard styling
|
||||
apply_dashboard_style()
|
||||
|
||||
# Render dashboard header
|
||||
render_dashboard_header(
|
||||
"🤖 AI Content Writers",
|
||||
"Choose from our collection of specialized AI writers, each designed for specific content types and industries. Create engaging, high-quality content with just a few clicks."
|
||||
)
|
||||
|
||||
writers = list_ai_writers()
|
||||
logger.info(f"Found {len(writers)} AI writers")
|
||||
|
||||
# Group writers by category for better organization
|
||||
categories = {}
|
||||
for writer in writers:
|
||||
category = writer["category"]
|
||||
if category not in categories:
|
||||
categories[category] = []
|
||||
categories[category].append(writer)
|
||||
|
||||
# Render writers by category with common cards
|
||||
for category_name, category_writers in categories.items():
|
||||
render_category_header(category_name)
|
||||
|
||||
# Create columns for this category
|
||||
cols = st.columns(min(len(category_writers), 3))
|
||||
|
||||
for idx, writer in enumerate(category_writers):
|
||||
with cols[idx % 3]:
|
||||
# Use the common card renderer
|
||||
if render_card(
|
||||
icon=writer['icon'],
|
||||
title=writer['name'],
|
||||
description=writer['description'],
|
||||
category=writer['category'],
|
||||
key_suffix=f"{writer['path']}_{category_name}",
|
||||
help_text=f"Launch {writer['name']} - {writer['description']}"
|
||||
):
|
||||
logger.info(f"Selected writer: {writer['name']} with path: {writer['path']}")
|
||||
st.session_state.selected_writer = writer
|
||||
st.query_params["writer"] = writer['path']
|
||||
logger.info(f"Updated query params with writer: {writer['path']}")
|
||||
st.rerun()
|
||||
|
||||
# Add spacing between categories
|
||||
st.markdown('<div class="category-spacer"></div>', unsafe_allow_html=True)
|
||||
|
||||
logger.info("Finished rendering AI Writers Dashboard")
|
||||
|
||||
return writers
|
||||
|
||||
# Remove the old ai_writers function since it's now integrated into get_ai_writers
|
||||
0
ToBeMigrated/ai_writers/data_img_slides_analyst.py
Normal file
0
ToBeMigrated/ai_writers/data_img_slides_analyst.py
Normal file
50
ToBeMigrated/ai_writers/gpt_blog_sections.py
Normal file
50
ToBeMigrated/ai_writers/gpt_blog_sections.py
Normal file
@@ -0,0 +1,50 @@
|
||||
import sys
|
||||
import os
|
||||
import json
|
||||
|
||||
from ..gpt_providers.text_generation.openai_text_gen import openai_text_generation
|
||||
from ..gpt_providers.text_generation.gemini_pro_text import gemini_text_generation
|
||||
|
||||
from loguru import logger
|
||||
logger.remove()
|
||||
logger.add(sys.stdout,
|
||||
colorize=True,
|
||||
format="<level>{level}</level>|<green>{file}:{line}:{function}</green>| {message}"
|
||||
)
|
||||
|
||||
|
||||
# FIXME: Provide num_blogs, num_faqs as inputs.
|
||||
def get_blog_sections_from_websearch(search_keyword, search_results):
|
||||
"""Combine the given online research and gpt blog content"""
|
||||
gpt_providers = os.environ["GPT_PROVIDER"]
|
||||
prompt = f"""
|
||||
As a SEO expert and content writer, I will provide you with a search keyword and its google search result.
|
||||
Your task is to write a blog title and 5 blog sub titles, from the given google search result.
|
||||
The subtitles should be less than 40 characters and click worthy.
|
||||
Do not explain, describe your response. Respond in json format, always name the key as 'blogSections'.
|
||||
|
||||
Web Research Keyword: "{search_keyword}"
|
||||
Google search Result: "{search_results}"
|
||||
"""
|
||||
|
||||
if 'gemini' in gpt_providers:
|
||||
try:
|
||||
response = gemini_text_response(prompt)
|
||||
if '```' in response and '\n' in response:
|
||||
response = response.strip().split('\n')
|
||||
# Remove the first and last lines
|
||||
response = '\n'.join(response[1:-1])
|
||||
response = json.loads(response)
|
||||
return response
|
||||
except Exception as err:
|
||||
logger.error(f"Failed to get response from gemini: {err}")
|
||||
logger.error(f"Gemini Error: {response.prompt_feedback}")
|
||||
raise err
|
||||
elif 'openai' in gpt_providers:
|
||||
try:
|
||||
logger.info("Calling OpenAI LLM.")
|
||||
response = openai_chatgpt(prompt)
|
||||
return response
|
||||
except Exception as err:
|
||||
logger.error(f"Failed to get response from Openai: {err}")
|
||||
raise err
|
||||
109
ToBeMigrated/ai_writers/image_ai_writer.py
Normal file
109
ToBeMigrated/ai_writers/image_ai_writer.py
Normal file
@@ -0,0 +1,109 @@
|
||||
import sys
|
||||
import os
|
||||
|
||||
from textwrap import dedent
|
||||
import json
|
||||
import asyncio
|
||||
from pathlib import Path
|
||||
from datetime import datetime
|
||||
import streamlit as st
|
||||
|
||||
from dotenv import load_dotenv
|
||||
load_dotenv(Path('../../.env'))
|
||||
from loguru import logger
|
||||
logger.remove()
|
||||
logger.add(sys.stdout,
|
||||
colorize=True,
|
||||
format="<level>{level}</level>|<green>{file}:{line}:{function}</green>| {message}"
|
||||
)
|
||||
|
||||
from ..ai_web_researcher.firecrawl_web_crawler import scrape_url
|
||||
from ..blog_metadata.get_blog_metadata import blog_metadata
|
||||
from ..blog_postprocessing.save_blog_to_file import save_blog_to_file
|
||||
from ..gpt_providers.text_to_image_generation.main_generate_image_from_prompt import generate_image
|
||||
from ..gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
from ..gpt_providers.image_to_text_gen.gemini_image_describe import describe_image, analyze_image_with_prompt
|
||||
|
||||
|
||||
def blog_from_image(prompt, uploaded_img):
|
||||
"""
|
||||
This function will take a blog Topic to first generate sections for it
|
||||
and then generate content for each section.
|
||||
"""
|
||||
# Use to store the blog in a string, to save in a *.md file.
|
||||
blog_markdown_str = None
|
||||
logger.info(f"Researching and Writing Blog on {uploaded_img} and {prompt}")
|
||||
# FIXME: Implement support for Openai.
|
||||
if not os.getenv("GEMINI_API_KEY"):
|
||||
st.error("Only Gemini supported, Open Issue ticket on github for Openai, others.")
|
||||
st.stop()
|
||||
|
||||
with st.status("Started Writing from Image..", expanded=True) as status:
|
||||
st.empty()
|
||||
status.update(label=f"Researching and Writing Blog on given Image")
|
||||
try:
|
||||
blog_markdown_str = write_blog_from_image(prompt, uploaded_img)
|
||||
except Exception as err:
|
||||
st.error(f"Failed to write blog from Image - Error: {err}")
|
||||
logger.error(f"Failed to write blog from image: {err}")
|
||||
st.stop()
|
||||
status.update(label="Successfully wrote blog from image.", expanded=False, state="complete")
|
||||
|
||||
try:
|
||||
status.update(label="🙎 Generating - Title, Meta Description, Tags, Categories for the content.")
|
||||
blog_title, blog_meta_desc, blog_tags, blog_categories = asyncio.run(blog_metadata(blog_markdown_str))
|
||||
except Exception as err:
|
||||
st.error(f"Failed to get blog metadata: {err}")
|
||||
|
||||
try:
|
||||
status.update(label="🙎 Generating Image for the new blog.")
|
||||
generated_image_filepath = generate_image(f"{blog_title} + ' ' + {blog_meta_desc}")
|
||||
except Exception as err:
|
||||
st.warning(f"Failed in Image generation: {err}")
|
||||
|
||||
saved_blog_to_file = save_blog_to_file(blog_markdown_str, blog_title, blog_meta_desc,
|
||||
blog_tags, blog_categories, generated_image_filepath)
|
||||
status.update(label=f"Saved the content in this file: {saved_blog_to_file}")
|
||||
logger.info(f"\n\n --------- Finished writing Blog -------------- \n")
|
||||
st.image(generated_image_filepath, caption=blog_title)
|
||||
st.markdown(f"{blog_markdown_str}")
|
||||
status.update(label=f"Finished, Review & Use your Original Content Below: {saved_blog_to_file}", state="complete")
|
||||
|
||||
# Clean up the temporary file after processing (optional)
|
||||
os.remove(uploaded_img)
|
||||
|
||||
|
||||
def write_blog_from_image(prompt, uploaded_img):
|
||||
"""Combine the given online research and GPT blog content"""
|
||||
try:
|
||||
config_path = Path(os.environ["ALWRITY_CONFIG"])
|
||||
with open(config_path, 'r', encoding='utf-8') as file:
|
||||
config = json.load(file)
|
||||
except Exception as err:
|
||||
logger.error(f"Error: Failed to read values from config: {err}")
|
||||
exit(1)
|
||||
|
||||
blog_characteristics = config['Blog Content Characteristics']
|
||||
|
||||
if not prompt:
|
||||
prompt = f"""
|
||||
As expert Creative Content writer, analyse the given image carefully.
|
||||
I want you to write a detailed {blog_characteristics['Blog Type']} blog post including 5 FAQs.
|
||||
|
||||
Below are the guidelines to follow:
|
||||
1). You must respond in {blog_characteristics['Blog Language']} language.
|
||||
2). Tone and Brand Alignment: Adjust your tone, voice, personality for {blog_characteristics['Blog Tone']} audience.
|
||||
3). Make sure your response content length is of {blog_characteristics['Blog Length']} words.
|
||||
"""
|
||||
logger.info("Generating blog and FAQs from image analysis.")
|
||||
|
||||
try:
|
||||
# Use the gemini_image_describe function to analyze the image with the custom prompt
|
||||
response = analyze_image_with_prompt(uploaded_img, prompt)
|
||||
if not response:
|
||||
logger.error("Failed to get response from image analysis")
|
||||
return "Failed to generate content from image."
|
||||
return response
|
||||
except Exception as err:
|
||||
logger.error(f"Exit: Failed to get response from image analysis: {err}")
|
||||
exit(1)
|
||||
143
ToBeMigrated/ai_writers/speech_to_blog/main_audio_to_blog.py
Normal file
143
ToBeMigrated/ai_writers/speech_to_blog/main_audio_to_blog.py
Normal file
@@ -0,0 +1,143 @@
|
||||
import os
|
||||
import datetime #I wish
|
||||
import sys
|
||||
from textwrap import dedent
|
||||
from tqdm import tqdm, trange
|
||||
import time
|
||||
|
||||
from pytubefix import YouTube
|
||||
import tempfile
|
||||
from html2image import Html2Image
|
||||
|
||||
from loguru import logger
|
||||
logger.remove()
|
||||
logger.add(sys.stdout,
|
||||
colorize=True,
|
||||
format="<level>{level}</level>|<green>{file}:{line}:{function}</green>| {message}"
|
||||
)
|
||||
|
||||
from ...ai_web_researcher.gpt_online_researcher import do_google_serp_search
|
||||
from ..ai_blog_writer.blog_from_google_serp import blog_with_research
|
||||
from ...blog_metadata.get_blog_metadata import blog_metadata
|
||||
from ...blog_postprocessing.save_blog_to_file import save_blog_to_file
|
||||
from ...gpt_providers.audio_to_text_generation.stt_audio_blog import speech_to_text
|
||||
from ...gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
|
||||
|
||||
def youtube_to_blog(video_url):
|
||||
"""Function to transcribe a given youtube url """
|
||||
try:
|
||||
# Starting the speech-to-text process
|
||||
logger.info("Starting with Speech to Text.")
|
||||
audio_text, audio_title = speech_to_text(video_url)
|
||||
except Exception as e:
|
||||
logger.error(f"Error in speech_to_text: {e}")
|
||||
sys.exit(1) # Exit the program due to error in speech_to_text
|
||||
|
||||
try:
|
||||
# Summarizing the content of the YouTube video
|
||||
audio_blog_content = summarize_youtube_video(audio_text)
|
||||
logger.info("Successfully converted given URL to blog article.")
|
||||
return audio_blog_content, audio_title
|
||||
except Exception as e:
|
||||
logger.error(f"Error in summarize_youtube_video: {e}")
|
||||
return False
|
||||
|
||||
|
||||
def summarize_youtube_video(user_content):
|
||||
"""Generates a summary of a YouTube video using OpenAI GPT-3 and displays a progress bar.
|
||||
Args:
|
||||
video_link: The URL of the YouTube video to summarize.
|
||||
Returns:
|
||||
A string containing the summary of the video.
|
||||
"""
|
||||
|
||||
logger.info("Start summarize_youtube_video..")
|
||||
prompt = f"""
|
||||
You are an expert copywriter specializing in digital content writing. I will provide you with a transcript.
|
||||
Your task is to transform a given transcript into a well-structured and informative blog article.
|
||||
Please follow the below objectives:
|
||||
|
||||
1. Master the Transcript: Understand main ideas, key points, and the core message.
|
||||
2. Sentence Structure: Rephrase while preserving logical flow and coherence. Dont quote anyone from video.
|
||||
3. Note: Check if the transcript is about programming, then include code examples and snippets in your article.
|
||||
4. Write Unique Content: Avoid direct copying; rewrite in your own words.
|
||||
5. REMEMBER to avoid direct quoting and maintain uniqueness.
|
||||
6. Proofread: Check for grammar, spelling, and punctuation errors.
|
||||
7. Use Creative and Human-like Style: Incorporate contractions, idioms, transitional phrases, interjections, and colloquialisms. 8. Avoid repetitive phrases and unnatural sentence structures.
|
||||
9. Ensure Uniqueness: Guarantee the article is plagiarism-free.
|
||||
10. Punctuation: Use appropriate question marks at the end of questions.
|
||||
11. Pass AI Detection Tools: Create content that easily passes AI plagiarism detection tools.
|
||||
12. Rephrase words like 'video, youtube, channel' with 'article, blog' and such suitable words.
|
||||
|
||||
Follow the above guidelines to create a well-optimized, unique, and informative article,
|
||||
that will rank well in search engine results and engage readers effectively.
|
||||
Follow above guidelines to craft a blog content from the following transcript:\n{user_content}
|
||||
"""
|
||||
try:
|
||||
response = llm_text_gen(prompt)
|
||||
return response
|
||||
except Exception as err:
|
||||
logger.error(f"Failed to summarize_youtube_video: {err}")
|
||||
exit(1)
|
||||
|
||||
|
||||
def generate_audio_blog(audio_input):
|
||||
"""Takes a list of youtube videos and generates blog for each one of them.
|
||||
"""
|
||||
# Use to store the blog in a string, to save in a *.md file.
|
||||
blog_markdown_str = ""
|
||||
try:
|
||||
logger.info(f"Starting to write blog on URL: {audio_input}")
|
||||
yt_blog, yt_title = youtube_to_blog(audio_input)
|
||||
except Exception as e:
|
||||
logger.error(f"Error in youtube_to_blog: {e}")
|
||||
sys.exit(1)
|
||||
|
||||
try:
|
||||
logger.info("Starting with online research for URL title.")
|
||||
research_report = do_google_serp_search(yt_title)
|
||||
print(research_report)
|
||||
except Exception as e:
|
||||
logger.error(f"Error in do_online_research: {e}")
|
||||
sys.exit(1)
|
||||
|
||||
try:
|
||||
# Note: Check if the order of input matters for your function
|
||||
logger.info("Preparing a blog content from audio script and online research content...")
|
||||
blog_markdown_str = blog_with_research(research_report, yt_blog)
|
||||
except Exception as e:
|
||||
logger.error(f"Error in blog_with_research: {e}")
|
||||
sys.exit(1)
|
||||
|
||||
try:
|
||||
import asyncio
|
||||
# blog_metadata now returns 6 values: title, desc, tags, categories, hashtags, slug
|
||||
blog_title, blog_meta_desc, blog_tags, blog_categories, blog_hashtags, blog_slug = asyncio.run(blog_metadata(blog_markdown_str))
|
||||
except Exception as err:
|
||||
logger.error(f"Failed to generate blog metadata: {err}")
|
||||
# Set defaults in case of failure
|
||||
blog_title = "Blog Article"
|
||||
blog_meta_desc = "An informative blog post"
|
||||
blog_tags = "content, blog"
|
||||
blog_categories = "General, Information"
|
||||
blog_hashtags = "#content #blog"
|
||||
blog_slug = "blog-article"
|
||||
|
||||
try:
|
||||
# TBD: Save the blog content as a .md file. Markdown or HTML ?
|
||||
# Initialize generated_image_filepath to None since it's not generated in this function
|
||||
generated_image_filepath = None
|
||||
save_blog_to_file(blog_markdown_str, blog_title, blog_meta_desc, blog_tags, blog_categories, generated_image_filepath)
|
||||
except Exception as err:
|
||||
logger.error(f"Failed to save final blog in a file: {err}")
|
||||
|
||||
blog_frontmatter = dedent(f"""\n\n\n\
|
||||
---
|
||||
title: {blog_title}
|
||||
categories: [{blog_categories}]
|
||||
tags: [{blog_tags}]
|
||||
Meta description: {blog_meta_desc.replace(":", "-")}
|
||||
---\n\n""")
|
||||
logger.info(f"{blog_frontmatter}{blog_markdown_str}")
|
||||
logger.info(f"\n\n ################ Finished writing Blog for : {audio_input} #################### \n")
|
||||
165
ToBeMigrated/ai_writers/twitter_writers/README.md
Normal file
165
ToBeMigrated/ai_writers/twitter_writers/README.md
Normal file
@@ -0,0 +1,165 @@
|
||||
# Twitter AI Writer Module
|
||||
|
||||
A comprehensive suite of AI-powered tools for Twitter/X content marketing and management.
|
||||
|
||||
## Features
|
||||
|
||||
### 1. Tweet Generation & Optimization
|
||||
- **Smart Tweet Generator**
|
||||
- Multiple tweet variations based on input parameters
|
||||
- Character count optimization
|
||||
- Hashtag suggestions and placement
|
||||
- Emoji usage recommendations
|
||||
- Thread creation capabilities
|
||||
|
||||
- **Tweet Performance Predictor**
|
||||
- Engagement rate estimation
|
||||
- Best time to post suggestions
|
||||
- Audience reach predictions
|
||||
- Viral potential scoring
|
||||
|
||||
### 2. Content Strategy Tools
|
||||
- **Content Calendar Generator**
|
||||
- Weekly/monthly content planning
|
||||
- Theme-based content scheduling
|
||||
- Event and holiday integration
|
||||
- Content mix recommendations
|
||||
|
||||
- **Hashtag Strategy Manager**
|
||||
- Trending hashtag research
|
||||
- Custom hashtag creation
|
||||
- Hashtag performance tracking
|
||||
- Competitor hashtag analysis
|
||||
|
||||
### 3. Visual Content Creation
|
||||
- **Image Generator**
|
||||
- Tweet card creation
|
||||
- Infographic templates
|
||||
- Quote card designs
|
||||
- Brand-consistent visuals
|
||||
|
||||
- **Video Content Assistant**
|
||||
- Video script generation
|
||||
- Storyboard creation
|
||||
- Caption optimization
|
||||
- Thumbnail design suggestions
|
||||
|
||||
### 4. Engagement & Community Management
|
||||
- **Reply Generator**
|
||||
- Context-aware responses
|
||||
- Tone matching
|
||||
- Crisis management templates
|
||||
- Customer service responses
|
||||
|
||||
- **Community Engagement Tools**
|
||||
- Poll creation
|
||||
- Q&A session planning
|
||||
- Community highlight suggestions
|
||||
- User-generated content prompts
|
||||
|
||||
### 5. Analytics & Optimization
|
||||
- **Performance Analytics**
|
||||
- Tweet performance tracking
|
||||
- Engagement metrics analysis
|
||||
- Audience growth monitoring
|
||||
- Content effectiveness scoring
|
||||
|
||||
- **A/B Testing Assistant**
|
||||
- Tweet variation testing
|
||||
- Headline optimization
|
||||
- CTA effectiveness analysis
|
||||
- Best performing content identification
|
||||
|
||||
### 6. Research & Intelligence
|
||||
- **Market Research Tools**
|
||||
- Competitor analysis
|
||||
- Industry trend tracking
|
||||
- Audience sentiment analysis
|
||||
- Content gap identification
|
||||
|
||||
- **Content Inspiration**
|
||||
- Trending topic suggestions
|
||||
- Content idea generation
|
||||
- Viral content analysis
|
||||
- Industry-specific insights
|
||||
|
||||
## Best Practices Integration
|
||||
|
||||
### Tweet Optimization
|
||||
- Optimal character count (240-280)
|
||||
- Strategic hashtag placement
|
||||
- Effective use of mentions and links
|
||||
- Engaging call-to-actions
|
||||
- Visual content optimization
|
||||
|
||||
### Content Strategy
|
||||
- Consistent brand voice
|
||||
- Regular posting schedule
|
||||
- Content variety maintenance
|
||||
- Engagement-driven approach
|
||||
- Community building focus
|
||||
|
||||
### Visual Content
|
||||
- Image size optimization
|
||||
- Brand color consistency
|
||||
- Text overlay best practices
|
||||
- Mobile-friendly design
|
||||
- Visual hierarchy principles
|
||||
|
||||
### Engagement
|
||||
- Response time optimization
|
||||
- Community management guidelines
|
||||
- Crisis communication protocols
|
||||
- User interaction best practices
|
||||
- Content moderation assistance
|
||||
|
||||
## Technical Integration
|
||||
|
||||
### API Integration
|
||||
- Twitter API v2 support
|
||||
- Rate limit management
|
||||
- Error handling
|
||||
- Data synchronization
|
||||
|
||||
### Performance Optimization
|
||||
- Caching mechanisms
|
||||
- Batch processing
|
||||
- Resource optimization
|
||||
- Response time improvement
|
||||
|
||||
## Security & Compliance
|
||||
|
||||
### Data Protection
|
||||
- User data encryption
|
||||
- Secure API key management
|
||||
- Privacy compliance
|
||||
- Data retention policies
|
||||
|
||||
### Content Guidelines
|
||||
- Platform policy compliance
|
||||
- Copyright protection
|
||||
- Brand safety measures
|
||||
- Content moderation rules
|
||||
|
||||
## Coming Soon
|
||||
- Advanced thread generator
|
||||
- AI-powered image editor
|
||||
- Real-time trend analyzer
|
||||
- Automated content scheduler
|
||||
- Advanced analytics dashboard
|
||||
- Multi-account management
|
||||
- Custom AI model training
|
||||
- Integration with other social platforms
|
||||
|
||||
## Usage Guidelines
|
||||
1. Ensure API keys are properly configured
|
||||
2. Follow Twitter's terms of service
|
||||
3. Maintain brand voice consistency
|
||||
4. Regular content calendar updates
|
||||
5. Monitor performance metrics
|
||||
6. Engage with community regularly
|
||||
7. Update content strategy based on analytics
|
||||
8. Follow security best practices
|
||||
|
||||
## Support
|
||||
For technical support or feature requests, please contact the development team or raise an issue in the repository. https://github.com/AJaySi/AI-Writer/issues
|
||||
9
ToBeMigrated/ai_writers/twitter_writers/__init__.py
Normal file
9
ToBeMigrated/ai_writers/twitter_writers/__init__.py
Normal file
@@ -0,0 +1,9 @@
|
||||
"""
|
||||
Twitter AI Writer Module
|
||||
|
||||
A comprehensive suite of AI-powered tools for Twitter/X content marketing and management.
|
||||
"""
|
||||
|
||||
from .twitter_dashboard import run_dashboard
|
||||
|
||||
__all__ = ['run_dashboard']
|
||||
@@ -0,0 +1,163 @@
|
||||
Here’s an improved and enhanced version of your README. I've structured it for clarity, conciseness, and professionalism, while also making it more engaging and user-friendly.
|
||||
|
||||
---
|
||||
|
||||
# 🐦 Smart Tweet Generator
|
||||
|
||||
**Create tweets that stand out!** The Smart Tweet Generator is a cutting-edge AI-powered tool designed to craft optimized, engaging tweets that maximize your audience reach and engagement.
|
||||
|
||||
---
|
||||
|
||||
## ✨ Key Features
|
||||
|
||||
### 1. **Multi-Variation Tweet Generation**
|
||||
- Generate 1–5 tweet variations from a single prompt.
|
||||
- Each variation tailored to different engagement styles.
|
||||
- Consistent tone and messaging across all versions.
|
||||
|
||||
### 2. **Real-Time Character Optimization**
|
||||
- Live character count tracking, including emoji support.
|
||||
- Visual indicators to maintain the ideal tweet length.
|
||||
- Alerts when nearing Twitter's 280-character limit.
|
||||
|
||||
### 3. **Intelligent Hashtag Management**
|
||||
- Auto-extract hashtags from generated tweets.
|
||||
- Topic-based, AI-suggested hashtags to enhance discoverability.
|
||||
- Recommendations for optimal hashtag count and placement.
|
||||
|
||||
### 4. **Emoji Suggestions That Fit**
|
||||
- Context-sensitive and tone-appropriate emoji suggestions.
|
||||
- Categories include:
|
||||
- **Humorous**: 😄 😂 😉
|
||||
- **Informative**: 📊 🔍 💡
|
||||
- **Inspirational**: ✨ 🌟 🔥
|
||||
- **Serious**: 🤔 📢 🔔
|
||||
- **Casual**: 👋 👍 🤗
|
||||
|
||||
### 5. **Performance Prediction**
|
||||
- Engagement score (0-100%) based on AI analysis.
|
||||
- Metrics analyzed include:
|
||||
- Character count optimization.
|
||||
- Hashtag effectiveness.
|
||||
- Emoji usage.
|
||||
- Audience relevance.
|
||||
- Categories:
|
||||
- **Excellent** (80–100%)
|
||||
- **Good** (60–79%)
|
||||
- **Fair** (40–59%)
|
||||
- **Needs Improvement** (0–39%)
|
||||
|
||||
### 6. **Actionable Improvement Suggestions**
|
||||
- Real-time feedback on tweet quality.
|
||||
- Tailored recommendations to boost performance.
|
||||
- Built-in best practices guidance for effective tweeting.
|
||||
|
||||
---
|
||||
|
||||
## 🎯 How to Use
|
||||
|
||||
### Step 1: **Enter Basic Information**
|
||||
- Add your tweet topic or hook.
|
||||
- Define the target audience.
|
||||
- Choose the desired tone and tweet length.
|
||||
- Optionally, include a call-to-action (CTA).
|
||||
|
||||
### Step 2: **Customize Advanced Options**
|
||||
- Select the number of tweet variations (1–5).
|
||||
- Input keywords or hashtags.
|
||||
- Choose emoji preferences.
|
||||
- Add @mentions or placeholders for links.
|
||||
|
||||
### Step 3: **Generate and Refine**
|
||||
- Click **Generate Tweets** to create variations.
|
||||
- Review performance metrics and apply improvement suggestions.
|
||||
- Copy, save, or export your favorite version.
|
||||
|
||||
---
|
||||
|
||||
## 📊 Performance Metrics
|
||||
|
||||
**Your tweets are analyzed based on:**
|
||||
|
||||
1. **Character Count**
|
||||
- Optimal: 100–200 characters.
|
||||
- Short: <100 characters.
|
||||
- Long: >200 characters.
|
||||
|
||||
2. **Hashtag Usage**
|
||||
- Optimal: 1–3 hashtags.
|
||||
- Too few: 0 hashtags.
|
||||
- Too many: >3 hashtags.
|
||||
|
||||
3. **Engagement Triggers**
|
||||
- Questions, CTAs, or interactive elements.
|
||||
|
||||
4. **Emoji Optimization**
|
||||
- Ideal: 1–3 emojis.
|
||||
- Too few: 0 emojis.
|
||||
- Too many: >3 emojis.
|
||||
|
||||
5. **Audience Relevance**
|
||||
- Alignment with keywords, tone, and context.
|
||||
|
||||
---
|
||||
|
||||
## 💡 Best Practices
|
||||
|
||||
1. **Craft Attention-Grabbing Hooks**
|
||||
- Start with bold statements or thought-provoking questions.
|
||||
- Use stats or facts to capture attention.
|
||||
|
||||
2. **Align Tone with Audience**
|
||||
- Maintain consistency with your brand voice.
|
||||
- Adapt tone to audience preferences (e.g., formal, casual).
|
||||
|
||||
3. **Strategic Hashtag Usage**
|
||||
- Use trending and relevant hashtags.
|
||||
- Limit to 1–3 for optimal engagement.
|
||||
|
||||
4. **Effective Emoji Usage**
|
||||
- Enhance meaning and context with emojis.
|
||||
- Match the tone and avoid overuse.
|
||||
|
||||
5. **Clear Calls-to-Action**
|
||||
- Encourage action with clarity and urgency.
|
||||
- Use action verbs like "Discover," "Join," or "Explore."
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Export Options
|
||||
|
||||
- Copy individual tweets.
|
||||
- Export all variations as a JSON file.
|
||||
- Save performance metrics and recommendations.
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Technical Details
|
||||
|
||||
- **Built with:** Streamlit for an intuitive user interface.
|
||||
- **AI-powered:** Advanced natural language models for tweet generation.
|
||||
- **Real-time:** Instant feedback and suggestions.
|
||||
- **Cross-platform compatibility:** Works seamlessly across devices.
|
||||
|
||||
---
|
||||
|
||||
## 📝 Notes
|
||||
|
||||
- Tweets are optimized for Twitter’s 280-character limit.
|
||||
- Performance predictions are derived from AI insights and engagement patterns.
|
||||
- Suggestions adapt to your audience, ensuring relevancy.
|
||||
- Regular updates keep the tool current with Twitter trends.
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Support
|
||||
|
||||
Have questions or feature requests? Reach out to our support team or submit an issue on our GitHub repository.
|
||||
|
||||
---
|
||||
|
||||
*Last updated: Yesterday*
|
||||
|
||||
---
|
||||
@@ -0,0 +1,9 @@
|
||||
"""
|
||||
Twitter Tweet Generator Module
|
||||
|
||||
A comprehensive suite of tools for generating and optimizing tweets.
|
||||
"""
|
||||
|
||||
from .smart_tweet_generator import smart_tweet_generator
|
||||
|
||||
__all__ = ['smart_tweet_generator']
|
||||
File diff suppressed because it is too large
Load Diff
729
ToBeMigrated/ai_writers/twitter_writers/twitter_dashboard.py
Normal file
729
ToBeMigrated/ai_writers/twitter_writers/twitter_dashboard.py
Normal file
@@ -0,0 +1,729 @@
|
||||
"""
|
||||
Enhanced Twitter Dashboard with modern UI components and improved user experience.
|
||||
"""
|
||||
|
||||
import streamlit as st
|
||||
from typing import Dict, List, Optional, Any
|
||||
import json
|
||||
from datetime import datetime, timedelta
|
||||
import plotly.express as px
|
||||
import plotly.graph_objects as go
|
||||
from plotly.subplots import make_subplots
|
||||
import pandas as pd
|
||||
import numpy as np
|
||||
|
||||
from .tweet_generator import smart_tweet_generator
|
||||
from .twitter_streamlit_ui import (
|
||||
TwitterDashboard,
|
||||
FeatureCard,
|
||||
TweetCard,
|
||||
TweetForm,
|
||||
SettingsForm,
|
||||
Sidebar,
|
||||
Header,
|
||||
Tabs,
|
||||
Breadcrumbs,
|
||||
Theme,
|
||||
save_to_session,
|
||||
get_from_session,
|
||||
clear_session,
|
||||
show_success_message,
|
||||
show_error_message,
|
||||
show_info_message,
|
||||
show_warning_message
|
||||
)
|
||||
|
||||
def apply_modern_styling():
|
||||
"""Apply modern CSS styling to the dashboard."""
|
||||
st.markdown("""
|
||||
<style>
|
||||
/* Import Google Fonts */
|
||||
@import url('https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&display=swap');
|
||||
|
||||
/* Global Styles */
|
||||
.stApp {
|
||||
font-family: 'Inter', -apple-system, BlinkMacSystemFont, sans-serif;
|
||||
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
|
||||
min-height: 100vh;
|
||||
}
|
||||
|
||||
/* Main Container */
|
||||
.main-container {
|
||||
background: rgba(255, 255, 255, 0.95);
|
||||
backdrop-filter: blur(20px);
|
||||
border-radius: 20px;
|
||||
padding: 2rem;
|
||||
margin: 1rem;
|
||||
box-shadow: 0 20px 40px rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
|
||||
/* Header Styles */
|
||||
.dashboard-header {
|
||||
text-align: center;
|
||||
margin-bottom: 2rem;
|
||||
padding: 2rem 0;
|
||||
background: linear-gradient(135deg, #1DA1F2, #0C85D0);
|
||||
border-radius: 16px;
|
||||
color: white;
|
||||
box-shadow: 0 10px 30px rgba(29, 161, 242, 0.3);
|
||||
}
|
||||
|
||||
.dashboard-title {
|
||||
font-size: 2.5rem;
|
||||
font-weight: 700;
|
||||
margin: 0;
|
||||
text-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
|
||||
.dashboard-subtitle {
|
||||
font-size: 1.1rem;
|
||||
opacity: 0.9;
|
||||
margin-top: 0.5rem;
|
||||
font-weight: 400;
|
||||
}
|
||||
|
||||
/* Feature Cards */
|
||||
.feature-card {
|
||||
background: white;
|
||||
border-radius: 16px;
|
||||
padding: 1.5rem;
|
||||
margin-bottom: 1rem;
|
||||
box-shadow: 0 8px 25px rgba(0, 0, 0, 0.08);
|
||||
border: 1px solid rgba(0, 0, 0, 0.05);
|
||||
transition: all 0.3s ease;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.feature-card:hover {
|
||||
transform: translateY(-5px);
|
||||
box-shadow: 0 15px 35px rgba(0, 0, 0, 0.15);
|
||||
}
|
||||
|
||||
.feature-icon {
|
||||
font-size: 2.5rem;
|
||||
margin-bottom: 1rem;
|
||||
display: block;
|
||||
}
|
||||
|
||||
.feature-title {
|
||||
font-size: 1.25rem;
|
||||
font-weight: 600;
|
||||
color: #2D3748;
|
||||
margin-bottom: 0.5rem;
|
||||
}
|
||||
|
||||
.feature-description {
|
||||
color: #718096;
|
||||
font-size: 0.95rem;
|
||||
line-height: 1.5;
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
|
||||
.feature-status {
|
||||
display: inline-block;
|
||||
padding: 0.25rem 0.75rem;
|
||||
border-radius: 20px;
|
||||
font-size: 0.8rem;
|
||||
font-weight: 500;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.5px;
|
||||
}
|
||||
|
||||
.status-active {
|
||||
background: linear-gradient(135deg, #48BB78, #38A169);
|
||||
color: white;
|
||||
}
|
||||
|
||||
.status-coming-soon {
|
||||
background: linear-gradient(135deg, #ED8936, #DD6B20);
|
||||
color: white;
|
||||
}
|
||||
|
||||
/* Metrics Cards */
|
||||
.metric-card {
|
||||
background: white;
|
||||
border-radius: 12px;
|
||||
padding: 1.5rem;
|
||||
text-align: center;
|
||||
box-shadow: 0 4px 15px rgba(0, 0, 0, 0.08);
|
||||
border-left: 4px solid #1DA1F2;
|
||||
}
|
||||
|
||||
.metric-value {
|
||||
font-size: 2rem;
|
||||
font-weight: 700;
|
||||
color: #2D3748;
|
||||
margin-bottom: 0.5rem;
|
||||
}
|
||||
|
||||
.metric-label {
|
||||
color: #718096;
|
||||
font-size: 0.9rem;
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
/* Buttons */
|
||||
.stButton > button {
|
||||
background: linear-gradient(135deg, #1DA1F2, #0C85D0);
|
||||
color: white;
|
||||
border: none;
|
||||
border-radius: 10px;
|
||||
padding: 0.75rem 1.5rem;
|
||||
font-weight: 600;
|
||||
font-size: 0.95rem;
|
||||
transition: all 0.3s ease;
|
||||
box-shadow: 0 4px 15px rgba(29, 161, 242, 0.3);
|
||||
}
|
||||
|
||||
.stButton > button:hover {
|
||||
transform: translateY(-2px);
|
||||
box-shadow: 0 8px 25px rgba(29, 161, 242, 0.4);
|
||||
}
|
||||
|
||||
/* Tabs */
|
||||
.stTabs [data-baseweb="tab-list"] {
|
||||
gap: 0.5rem;
|
||||
background: rgba(255, 255, 255, 0.1);
|
||||
padding: 0.5rem;
|
||||
border-radius: 12px;
|
||||
backdrop-filter: blur(10px);
|
||||
}
|
||||
|
||||
.stTabs [data-baseweb="tab"] {
|
||||
background: transparent;
|
||||
border-radius: 8px;
|
||||
color: #4A5568;
|
||||
font-weight: 500;
|
||||
padding: 0.75rem 1.5rem;
|
||||
transition: all 0.3s ease;
|
||||
}
|
||||
|
||||
.stTabs [aria-selected="true"] {
|
||||
background: white;
|
||||
color: #1DA1F2;
|
||||
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
|
||||
/* Connection Status */
|
||||
.connection-status {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
padding: 1rem;
|
||||
border-radius: 12px;
|
||||
margin-bottom: 1.5rem;
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
.status-connected {
|
||||
background: linear-gradient(135deg, #C6F6D5, #9AE6B4);
|
||||
color: #22543D;
|
||||
border: 1px solid #9AE6B4;
|
||||
}
|
||||
|
||||
.status-disconnected {
|
||||
background: linear-gradient(135deg, #FED7D7, #FEB2B2);
|
||||
color: #742A2A;
|
||||
border: 1px solid #FEB2B2;
|
||||
}
|
||||
|
||||
/* Quick Actions */
|
||||
.quick-actions {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
|
||||
gap: 1rem;
|
||||
margin: 2rem 0;
|
||||
}
|
||||
|
||||
.quick-action-btn {
|
||||
background: white;
|
||||
border: 2px solid #E2E8F0;
|
||||
border-radius: 12px;
|
||||
padding: 1.5rem;
|
||||
text-align: center;
|
||||
transition: all 0.3s ease;
|
||||
cursor: pointer;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.quick-action-btn:hover {
|
||||
border-color: #1DA1F2;
|
||||
transform: translateY(-2px);
|
||||
box-shadow: 0 8px 25px rgba(29, 161, 242, 0.15);
|
||||
}
|
||||
|
||||
.quick-action-icon {
|
||||
font-size: 2rem;
|
||||
margin-bottom: 0.5rem;
|
||||
display: block;
|
||||
}
|
||||
|
||||
.quick-action-title {
|
||||
font-weight: 600;
|
||||
color: #2D3748;
|
||||
margin-bottom: 0.25rem;
|
||||
}
|
||||
|
||||
.quick-action-desc {
|
||||
font-size: 0.85rem;
|
||||
color: #718096;
|
||||
}
|
||||
|
||||
/* Analytics Charts */
|
||||
.chart-container {
|
||||
background: white;
|
||||
border-radius: 16px;
|
||||
padding: 1.5rem;
|
||||
margin: 1rem 0;
|
||||
box-shadow: 0 4px 15px rgba(0, 0, 0, 0.08);
|
||||
}
|
||||
|
||||
/* Responsive Design */
|
||||
@media (max-width: 768px) {
|
||||
.main-container {
|
||||
margin: 0.5rem;
|
||||
padding: 1rem;
|
||||
}
|
||||
|
||||
.dashboard-title {
|
||||
font-size: 2rem;
|
||||
}
|
||||
|
||||
.quick-actions {
|
||||
grid-template-columns: 1fr;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
""", unsafe_allow_html=True)
|
||||
|
||||
def render_connection_status():
|
||||
"""Render Twitter connection status with modern styling."""
|
||||
# Simulate connection status (replace with real authentication check)
|
||||
is_connected = get_from_session("twitter_connected", False)
|
||||
|
||||
if is_connected:
|
||||
user_info = get_from_session("twitter_user", {"name": "Demo User", "handle": "@demo_user"})
|
||||
st.markdown(f"""
|
||||
<div class="connection-status status-connected">
|
||||
<span style="font-size: 1.2rem;">✅</span>
|
||||
<div>
|
||||
<strong>Connected as {user_info['name']}</strong>
|
||||
<div style="font-size: 0.9rem; opacity: 0.8;">{user_info['handle']}</div>
|
||||
</div>
|
||||
</div>
|
||||
""", unsafe_allow_html=True)
|
||||
else:
|
||||
st.markdown("""
|
||||
<div class="connection-status status-disconnected">
|
||||
<span style="font-size: 1.2rem;">⚠️</span>
|
||||
<div>
|
||||
<strong>Twitter Not Connected</strong>
|
||||
<div style="font-size: 0.9rem; opacity: 0.8;">Connect your account to access all features</div>
|
||||
</div>
|
||||
</div>
|
||||
""", unsafe_allow_html=True)
|
||||
|
||||
if st.button("🔗 Connect Twitter Account", key="connect_twitter"):
|
||||
# Simulate connection (replace with real OAuth flow)
|
||||
save_to_session("twitter_connected", True)
|
||||
save_to_session("twitter_user", {"name": "Demo User", "handle": "@demo_user"})
|
||||
st.rerun()
|
||||
|
||||
def render_dashboard_header():
|
||||
"""Render the modern dashboard header."""
|
||||
st.markdown("""
|
||||
<div class="dashboard-header">
|
||||
<h1 class="dashboard-title">🐦 Twitter AI Dashboard</h1>
|
||||
<p class="dashboard-subtitle">Create, analyze, and optimize your Twitter content with AI-powered tools</p>
|
||||
</div>
|
||||
""", unsafe_allow_html=True)
|
||||
|
||||
def render_quick_actions():
|
||||
"""Render quick action buttons."""
|
||||
st.markdown("### 🚀 Quick Actions")
|
||||
|
||||
col1, col2, col3, col4 = st.columns(4)
|
||||
|
||||
with col1:
|
||||
if st.button("✍️ Create Tweet", use_container_width=True, key="quick_tweet"):
|
||||
st.session_state.current_page = "tweet_generator"
|
||||
st.rerun()
|
||||
|
||||
with col2:
|
||||
if st.button("📊 View Analytics", use_container_width=True, key="quick_analytics"):
|
||||
st.session_state.current_page = "analytics"
|
||||
st.rerun()
|
||||
|
||||
with col3:
|
||||
if st.button("📅 Content Calendar", use_container_width=True, key="quick_calendar"):
|
||||
show_info_message("Content Calendar feature coming soon!")
|
||||
|
||||
with col4:
|
||||
if st.button("⚙️ Settings", use_container_width=True, key="quick_settings"):
|
||||
st.session_state.current_page = "settings"
|
||||
st.rerun()
|
||||
|
||||
def render_metrics_overview():
|
||||
"""Render key metrics overview."""
|
||||
st.markdown("### 📈 Performance Overview")
|
||||
|
||||
# Generate sample metrics (replace with real data)
|
||||
col1, col2, col3, col4 = st.columns(4)
|
||||
|
||||
with col1:
|
||||
st.markdown("""
|
||||
<div class="metric-card">
|
||||
<div class="metric-value">1,234</div>
|
||||
<div class="metric-label">Total Tweets</div>
|
||||
</div>
|
||||
""", unsafe_allow_html=True)
|
||||
|
||||
with col2:
|
||||
st.markdown("""
|
||||
<div class="metric-card">
|
||||
<div class="metric-value">45.2K</div>
|
||||
<div class="metric-label">Total Engagement</div>
|
||||
</div>
|
||||
""", unsafe_allow_html=True)
|
||||
|
||||
with col3:
|
||||
st.markdown("""
|
||||
<div class="metric-card">
|
||||
<div class="metric-value">3.8%</div>
|
||||
<div class="metric-label">Engagement Rate</div>
|
||||
</div>
|
||||
""", unsafe_allow_html=True)
|
||||
|
||||
with col4:
|
||||
st.markdown("""
|
||||
<div class="metric-card">
|
||||
<div class="metric-value">12.5K</div>
|
||||
<div class="metric-label">Followers</div>
|
||||
</div>
|
||||
""", unsafe_allow_html=True)
|
||||
|
||||
def render_engagement_chart():
|
||||
"""Render engagement trends chart."""
|
||||
st.markdown("### 📊 Engagement Trends")
|
||||
|
||||
# Generate sample data (replace with real Twitter data)
|
||||
dates = pd.date_range(start=datetime.now() - timedelta(days=30), periods=30)
|
||||
engagement = np.random.normal(100, 20, 30)
|
||||
engagement = np.maximum(engagement, 0) # Ensure positive values
|
||||
|
||||
df = pd.DataFrame({
|
||||
'Date': dates,
|
||||
'Engagement': engagement,
|
||||
'Likes': engagement * 0.6,
|
||||
'Retweets': engagement * 0.3,
|
||||
'Replies': engagement * 0.1
|
||||
})
|
||||
|
||||
# Create interactive chart
|
||||
fig = make_subplots(
|
||||
rows=2, cols=1,
|
||||
subplot_titles=('Total Engagement', 'Engagement Breakdown'),
|
||||
vertical_spacing=0.1,
|
||||
row_heights=[0.7, 0.3]
|
||||
)
|
||||
|
||||
# Main engagement line
|
||||
fig.add_trace(
|
||||
go.Scatter(
|
||||
x=df['Date'],
|
||||
y=df['Engagement'],
|
||||
mode='lines+markers',
|
||||
name='Total Engagement',
|
||||
line=dict(color='#1DA1F2', width=3),
|
||||
marker=dict(size=6)
|
||||
),
|
||||
row=1, col=1
|
||||
)
|
||||
|
||||
# Stacked area chart for breakdown
|
||||
fig.add_trace(
|
||||
go.Scatter(
|
||||
x=df['Date'],
|
||||
y=df['Likes'],
|
||||
mode='lines',
|
||||
name='Likes',
|
||||
fill='tonexty',
|
||||
line=dict(color='#E53E3E')
|
||||
),
|
||||
row=2, col=1
|
||||
)
|
||||
|
||||
fig.add_trace(
|
||||
go.Scatter(
|
||||
x=df['Date'],
|
||||
y=df['Retweets'],
|
||||
mode='lines',
|
||||
name='Retweets',
|
||||
fill='tonexty',
|
||||
line=dict(color='#38A169')
|
||||
),
|
||||
row=2, col=1
|
||||
)
|
||||
|
||||
fig.add_trace(
|
||||
go.Scatter(
|
||||
x=df['Date'],
|
||||
y=df['Replies'],
|
||||
mode='lines',
|
||||
name='Replies',
|
||||
fill='tonexty',
|
||||
line=dict(color='#D69E2E')
|
||||
),
|
||||
row=2, col=1
|
||||
)
|
||||
|
||||
fig.update_layout(
|
||||
height=500,
|
||||
showlegend=True,
|
||||
hovermode='x unified',
|
||||
plot_bgcolor='rgba(0,0,0,0)',
|
||||
paper_bgcolor='rgba(0,0,0,0)'
|
||||
)
|
||||
|
||||
fig.update_xaxes(showgrid=True, gridwidth=1, gridcolor='rgba(0,0,0,0.1)')
|
||||
fig.update_yaxes(showgrid=True, gridwidth=1, gridcolor='rgba(0,0,0,0.1)')
|
||||
|
||||
st.plotly_chart(fig, use_container_width=True)
|
||||
|
||||
def render_feature_grid():
|
||||
"""Render the feature grid with modern cards."""
|
||||
st.markdown("### 🛠️ Available Tools")
|
||||
|
||||
features = [
|
||||
{
|
||||
"title": "Smart Tweet Generator",
|
||||
"description": "Create engaging tweets with AI assistance, hashtag suggestions, and emoji optimization",
|
||||
"icon": "✨",
|
||||
"status": "active",
|
||||
"action": "tweet_generator"
|
||||
},
|
||||
{
|
||||
"title": "Performance Predictor",
|
||||
"description": "Predict tweet engagement and find optimal posting times",
|
||||
"icon": "🔮",
|
||||
"status": "coming_soon",
|
||||
"action": None
|
||||
},
|
||||
{
|
||||
"title": "Content Calendar",
|
||||
"description": "Plan and schedule your Twitter content strategy",
|
||||
"icon": "📅",
|
||||
"status": "coming_soon",
|
||||
"action": None
|
||||
},
|
||||
{
|
||||
"title": "Hashtag Research",
|
||||
"description": "Discover trending hashtags and analyze their performance",
|
||||
"icon": "#️⃣",
|
||||
"status": "coming_soon",
|
||||
"action": None
|
||||
},
|
||||
{
|
||||
"title": "Visual Content",
|
||||
"description": "Create quote cards, infographics, and visual tweets",
|
||||
"icon": "🎨",
|
||||
"status": "coming_soon",
|
||||
"action": None
|
||||
},
|
||||
{
|
||||
"title": "Analytics Dashboard",
|
||||
"description": "Deep dive into your Twitter performance metrics",
|
||||
"icon": "📊",
|
||||
"status": "coming_soon",
|
||||
"action": None
|
||||
}
|
||||
]
|
||||
|
||||
# Create grid layout
|
||||
cols = st.columns(3)
|
||||
|
||||
for i, feature in enumerate(features):
|
||||
with cols[i % 3]:
|
||||
status_class = "status-active" if feature["status"] == "active" else "status-coming-soon"
|
||||
|
||||
card_html = f"""
|
||||
<div class="feature-card" onclick="handleFeatureClick('{feature['action']}')">
|
||||
<span class="feature-icon">{feature['icon']}</span>
|
||||
<h3 class="feature-title">{feature['title']}</h3>
|
||||
<p class="feature-description">{feature['description']}</p>
|
||||
<span class="feature-status {status_class}">{feature['status'].replace('_', ' ')}</span>
|
||||
</div>
|
||||
"""
|
||||
|
||||
st.markdown(card_html, unsafe_allow_html=True)
|
||||
|
||||
# Add button for active features
|
||||
if feature["status"] == "active" and feature["action"]:
|
||||
if st.button(f"Launch {feature['title']}", key=f"launch_{i}", use_container_width=True):
|
||||
st.session_state.current_page = feature["action"]
|
||||
st.rerun()
|
||||
|
||||
def render_recent_activity():
|
||||
"""Render recent activity feed."""
|
||||
st.markdown("### 📱 Recent Activity")
|
||||
|
||||
# Sample activity data (replace with real data)
|
||||
activities = [
|
||||
{"time": "2 hours ago", "action": "Generated tweet", "details": "AI-powered content about social media trends"},
|
||||
{"time": "5 hours ago", "action": "Analyzed performance", "details": "Tweet received 45 likes and 12 retweets"},
|
||||
{"time": "1 day ago", "action": "Scheduled tweet", "details": "Content scheduled for optimal posting time"},
|
||||
{"time": "2 days ago", "action": "Updated hashtags", "details": "Added trending hashtags to improve reach"}
|
||||
]
|
||||
|
||||
for activity in activities:
|
||||
st.markdown(f"""
|
||||
<div style="
|
||||
background: white;
|
||||
border-radius: 8px;
|
||||
padding: 1rem;
|
||||
margin-bottom: 0.5rem;
|
||||
border-left: 3px solid #1DA1F2;
|
||||
box-shadow: 0 2px 8px rgba(0,0,0,0.05);
|
||||
">
|
||||
<div style="font-weight: 600; color: #2D3748; margin-bottom: 0.25rem;">
|
||||
{activity['action']}
|
||||
</div>
|
||||
<div style="color: #718096; font-size: 0.9rem; margin-bottom: 0.25rem;">
|
||||
{activity['details']}
|
||||
</div>
|
||||
<div style="color: #A0AEC0; font-size: 0.8rem;">
|
||||
{activity['time']}
|
||||
</div>
|
||||
</div>
|
||||
""", unsafe_allow_html=True)
|
||||
|
||||
def run_dashboard():
|
||||
"""Main function to run the enhanced Twitter dashboard."""
|
||||
# Apply modern styling
|
||||
apply_modern_styling()
|
||||
|
||||
# Initialize session state
|
||||
if "current_page" not in st.session_state:
|
||||
st.session_state.current_page = "dashboard"
|
||||
|
||||
# Handle page navigation
|
||||
if st.session_state.current_page == "tweet_generator":
|
||||
if st.button("← Back to Dashboard", key="back_to_dashboard"):
|
||||
st.session_state.current_page = "dashboard"
|
||||
st.rerun()
|
||||
smart_tweet_generator()
|
||||
return
|
||||
|
||||
# Main dashboard container
|
||||
st.markdown('<div class="main-container">', unsafe_allow_html=True)
|
||||
|
||||
# Render dashboard header
|
||||
render_dashboard_header()
|
||||
|
||||
# Render connection status
|
||||
render_connection_status()
|
||||
|
||||
# Create main layout
|
||||
tab1, tab2, tab3 = st.tabs(["🏠 Overview", "📊 Analytics", "⚙️ Settings"])
|
||||
|
||||
with tab1:
|
||||
# Quick actions
|
||||
render_quick_actions()
|
||||
|
||||
# Metrics overview
|
||||
render_metrics_overview()
|
||||
|
||||
# Feature grid
|
||||
render_feature_grid()
|
||||
|
||||
# Recent activity
|
||||
col1, col2 = st.columns([2, 1])
|
||||
with col1:
|
||||
render_engagement_chart()
|
||||
with col2:
|
||||
render_recent_activity()
|
||||
|
||||
with tab2:
|
||||
st.markdown("### 📈 Advanced Analytics")
|
||||
|
||||
# Time range selector
|
||||
col1, col2 = st.columns([1, 3])
|
||||
with col1:
|
||||
time_range = st.selectbox(
|
||||
"Time Range",
|
||||
["Last 7 days", "Last 30 days", "Last 90 days", "Last year"],
|
||||
index=1
|
||||
)
|
||||
|
||||
# Detailed analytics
|
||||
render_engagement_chart()
|
||||
|
||||
# Performance insights
|
||||
st.markdown("### 💡 Performance Insights")
|
||||
|
||||
insights = [
|
||||
"Your tweets perform 23% better when posted between 2-4 PM",
|
||||
"Tweets with 2-3 hashtags get 15% more engagement",
|
||||
"Visual content increases engagement by 35%",
|
||||
"Questions in tweets boost replies by 28%"
|
||||
]
|
||||
|
||||
for insight in insights:
|
||||
st.info(f"💡 {insight}")
|
||||
|
||||
with tab3:
|
||||
st.markdown("### ⚙️ Dashboard Settings")
|
||||
|
||||
# Twitter API settings
|
||||
with st.expander("🔑 Twitter API Configuration", expanded=False):
|
||||
st.markdown("Configure your Twitter API credentials to enable full functionality.")
|
||||
|
||||
api_key = st.text_input("API Key", type="password", help="Your Twitter API key")
|
||||
api_secret = st.text_input("API Secret", type="password", help="Your Twitter API secret")
|
||||
access_token = st.text_input("Access Token", type="password", help="Your Twitter access token")
|
||||
access_token_secret = st.text_input("Access Token Secret", type="password", help="Your Twitter access token secret")
|
||||
|
||||
if st.button("Save API Configuration"):
|
||||
# Save configuration (implement secure storage)
|
||||
show_success_message("API configuration saved successfully!")
|
||||
|
||||
# Dashboard preferences
|
||||
with st.expander("🎨 Dashboard Preferences", expanded=True):
|
||||
theme = st.selectbox("Theme", ["Light", "Dark", "Auto"], index=0)
|
||||
default_tone = st.selectbox("Default Tweet Tone", ["Professional", "Casual", "Humorous", "Inspirational"], index=1)
|
||||
auto_hashtags = st.checkbox("Auto-suggest hashtags", value=True)
|
||||
|
||||
if st.button("Save Preferences"):
|
||||
show_success_message("Preferences saved successfully!")
|
||||
|
||||
# Account management
|
||||
with st.expander("👤 Account Management", expanded=False):
|
||||
st.markdown("Manage your connected Twitter accounts and permissions.")
|
||||
|
||||
if get_from_session("twitter_connected", False):
|
||||
st.success("✅ Twitter account connected")
|
||||
if st.button("Disconnect Account"):
|
||||
save_to_session("twitter_connected", False)
|
||||
st.rerun()
|
||||
else:
|
||||
st.warning("⚠️ No Twitter account connected")
|
||||
if st.button("Connect Account"):
|
||||
save_to_session("twitter_connected", True)
|
||||
st.rerun()
|
||||
|
||||
st.markdown('</div>', unsafe_allow_html=True)
|
||||
|
||||
# JavaScript for handling feature clicks
|
||||
st.markdown("""
|
||||
<script>
|
||||
function handleFeatureClick(action) {
|
||||
if (action && action !== 'null') {
|
||||
// This would trigger a Streamlit rerun with the selected action
|
||||
console.log('Feature clicked:', action);
|
||||
}
|
||||
}
|
||||
</script>
|
||||
""", unsafe_allow_html=True)
|
||||
|
||||
if __name__ == "__main__":
|
||||
run_dashboard()
|
||||
@@ -0,0 +1,203 @@
|
||||
# Twitter Streamlit UI Components
|
||||
|
||||
This module provides a unified, reusable UI component library for all Twitter-related features in the AI Writer suite. It implements best practices for Streamlit UI development and ensures consistency across all Twitter tools.
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
twitter_streamlit_ui/
|
||||
├── components/ # Reusable UI components
|
||||
│ ├── __init__.py
|
||||
│ ├── cards.py # Card components (feature cards, tweet cards)
|
||||
│ ├── forms.py # Form components (input forms, settings forms)
|
||||
│ ├── navigation.py # Navigation components (tabs, sidebar)
|
||||
│ ├── feedback.py # Feedback components (loading, errors, success)
|
||||
│ └── layout.py # Layout components (containers, columns)
|
||||
├── styles/ # CSS and styling
|
||||
│ ├── __init__.py
|
||||
│ ├── theme.py # Theme configuration
|
||||
│ ├── components.py # Component-specific styles
|
||||
│ └── animations.py # Animation styles
|
||||
├── utils/ # UI utilities
|
||||
│ ├── __init__.py
|
||||
│ ├── state.py # State management
|
||||
│ ├── validation.py # Input validation
|
||||
│ └── performance.py # Performance optimizations
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Key Improvements
|
||||
|
||||
### 1. Consistent UI Components
|
||||
|
||||
- **Card Components**
|
||||
- Feature cards with consistent styling
|
||||
- Tweet cards with standardized layout
|
||||
- Status badges with unified design
|
||||
|
||||
- **Form Components**
|
||||
- Standardized input forms
|
||||
- Consistent validation feedback
|
||||
- Unified error handling
|
||||
|
||||
- **Navigation Components**
|
||||
- Consistent tab styling
|
||||
- Standardized sidebar navigation
|
||||
- Breadcrumb navigation
|
||||
|
||||
### 2. Enhanced User Experience
|
||||
|
||||
- **Loading States**
|
||||
- Progress indicators for long operations
|
||||
- Skeleton loading for content
|
||||
- Smooth transitions between states
|
||||
|
||||
- **Feedback Mechanisms**
|
||||
- Toast notifications for actions
|
||||
- Error messages with recovery options
|
||||
- Success confirmations
|
||||
|
||||
- **Responsive Design**
|
||||
- Mobile-friendly layouts
|
||||
- Adaptive column systems
|
||||
- Flexible containers
|
||||
|
||||
### 3. Performance Optimizations
|
||||
|
||||
- **State Management**
|
||||
- Centralized state handling
|
||||
- Efficient data persistence
|
||||
- Optimized re-rendering
|
||||
|
||||
- **Resource Loading**
|
||||
- Lazy loading of components
|
||||
- Optimized image loading
|
||||
- Cached computations
|
||||
|
||||
### 4. Accessibility Features
|
||||
|
||||
- **Keyboard Navigation**
|
||||
- Focus management
|
||||
- Keyboard shortcuts
|
||||
- ARIA labels
|
||||
|
||||
- **Visual Accessibility**
|
||||
- High contrast themes
|
||||
- Screen reader support
|
||||
- Color blind friendly
|
||||
|
||||
### 5. Error Handling
|
||||
|
||||
- **Graceful Degradation**
|
||||
- Fallback UI components
|
||||
- Error boundaries
|
||||
- Recovery options
|
||||
|
||||
- **User Feedback**
|
||||
- Clear error messages
|
||||
- Actionable suggestions
|
||||
- Help documentation
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Component Usage
|
||||
|
||||
```python
|
||||
from twitter_streamlit_ui.components.cards import FeatureCard
|
||||
from twitter_streamlit_ui.components.forms import TweetForm
|
||||
from twitter_streamlit_ui.styles.theme import apply_theme
|
||||
|
||||
# Apply theme
|
||||
apply_theme()
|
||||
|
||||
# Use components
|
||||
feature_card = FeatureCard(
|
||||
title="Tweet Generator",
|
||||
description="Create engaging tweets with AI",
|
||||
icon="🐦"
|
||||
)
|
||||
feature_card.render()
|
||||
|
||||
tweet_form = TweetForm()
|
||||
tweet_form.render()
|
||||
```
|
||||
|
||||
### State Management
|
||||
|
||||
```python
|
||||
from twitter_streamlit_ui.utils.state import StateManager
|
||||
|
||||
# Initialize state
|
||||
state = StateManager()
|
||||
state.initialize()
|
||||
|
||||
# Update state
|
||||
state.update("current_tweet", tweet_data)
|
||||
```
|
||||
|
||||
### Error Handling
|
||||
|
||||
```python
|
||||
from twitter_streamlit_ui.components.feedback import ErrorBoundary
|
||||
|
||||
with ErrorBoundary():
|
||||
# Your code here
|
||||
pass
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Component Reusability**
|
||||
- Use existing components when possible
|
||||
- Create new components only when necessary
|
||||
- Follow the established patterns
|
||||
|
||||
2. **State Management**
|
||||
- Use the StateManager for all state
|
||||
- Avoid direct session state manipulation
|
||||
- Keep state updates atomic
|
||||
|
||||
3. **Performance**
|
||||
- Use lazy loading for heavy components
|
||||
- Implement caching where appropriate
|
||||
- Monitor render performance
|
||||
|
||||
4. **Accessibility**
|
||||
- Include ARIA labels
|
||||
- Ensure keyboard navigation
|
||||
- Test with screen readers
|
||||
|
||||
5. **Error Handling**
|
||||
- Use ErrorBoundary components
|
||||
- Provide clear error messages
|
||||
- Include recovery options
|
||||
|
||||
## Future Improvements
|
||||
|
||||
1. **Component Library**
|
||||
- Add more specialized components
|
||||
- Enhance existing components
|
||||
- Create component documentation
|
||||
|
||||
2. **Theme System**
|
||||
- Add more theme options
|
||||
- Implement theme switching
|
||||
- Create custom theme builder
|
||||
|
||||
3. **Performance**
|
||||
- Implement virtual scrolling
|
||||
- Add performance monitoring
|
||||
- Optimize resource loading
|
||||
|
||||
4. **Testing**
|
||||
- Add component tests
|
||||
- Implement E2E tests
|
||||
- Create test documentation
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Follow the established patterns
|
||||
2. Add tests for new components
|
||||
3. Update documentation
|
||||
4. Ensure accessibility
|
||||
5. Optimize performance
|
||||
@@ -0,0 +1,66 @@
|
||||
"""
|
||||
Twitter Streamlit UI package.
|
||||
Provides a modern and user-friendly interface for Twitter tools.
|
||||
"""
|
||||
|
||||
from .dashboard import TwitterDashboard
|
||||
from .components.cards import FeatureCard, TweetCard
|
||||
from .components.forms import TweetForm, SettingsForm
|
||||
from .components.navigation import Sidebar, Header, Tabs, Breadcrumbs
|
||||
from .styles.theme import Theme
|
||||
from .utils.helpers import (
|
||||
save_to_session,
|
||||
get_from_session,
|
||||
clear_session,
|
||||
save_to_file,
|
||||
load_from_file,
|
||||
format_datetime,
|
||||
parse_datetime,
|
||||
validate_tweet_content,
|
||||
validate_hashtags,
|
||||
validate_emojis,
|
||||
calculate_engagement_score,
|
||||
generate_tweet_metrics,
|
||||
copy_to_clipboard,
|
||||
show_success_message,
|
||||
show_error_message,
|
||||
show_info_message,
|
||||
show_warning_message,
|
||||
create_download_button,
|
||||
create_upload_button
|
||||
)
|
||||
|
||||
__version__ = "1.0.0"
|
||||
__author__ = "AI Writer Team"
|
||||
|
||||
__all__ = [
|
||||
"TwitterDashboard",
|
||||
"FeatureCard",
|
||||
"TweetCard",
|
||||
"TweetForm",
|
||||
"SettingsForm",
|
||||
"Sidebar",
|
||||
"Header",
|
||||
"Tabs",
|
||||
"Breadcrumbs",
|
||||
"Theme",
|
||||
"save_to_session",
|
||||
"get_from_session",
|
||||
"clear_session",
|
||||
"save_to_file",
|
||||
"load_from_file",
|
||||
"format_datetime",
|
||||
"parse_datetime",
|
||||
"validate_tweet_content",
|
||||
"validate_hashtags",
|
||||
"validate_emojis",
|
||||
"calculate_engagement_score",
|
||||
"generate_tweet_metrics",
|
||||
"copy_to_clipboard",
|
||||
"show_success_message",
|
||||
"show_error_message",
|
||||
"show_info_message",
|
||||
"show_warning_message",
|
||||
"create_download_button",
|
||||
"create_upload_button"
|
||||
]
|
||||
@@ -0,0 +1,634 @@
|
||||
"""
|
||||
Enhanced UI Cards with modern styling and improved functionality.
|
||||
"""
|
||||
|
||||
import streamlit as st
|
||||
from typing import Dict, List, Optional, Callable
|
||||
import plotly.express as px
|
||||
import plotly.graph_objects as go
|
||||
from datetime import datetime
|
||||
|
||||
def apply_cards_styling():
|
||||
"""Apply modern CSS styling for cards."""
|
||||
st.markdown("""
|
||||
<style>
|
||||
/* Modern Card Styles */
|
||||
.modern-card {
|
||||
background: rgba(255, 255, 255, 0.95);
|
||||
backdrop-filter: blur(20px);
|
||||
border-radius: 16px;
|
||||
padding: 1.5rem;
|
||||
margin: 1rem 0;
|
||||
box-shadow: 0 8px 32px rgba(0, 0, 0, 0.1);
|
||||
border: 1px solid rgba(255, 255, 255, 0.2);
|
||||
transition: all 0.3s ease;
|
||||
position: relative;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.modern-card:hover {
|
||||
transform: translateY(-4px);
|
||||
box-shadow: 0 12px 40px rgba(0, 0, 0, 0.15);
|
||||
}
|
||||
|
||||
.modern-card::before {
|
||||
content: '';
|
||||
position: absolute;
|
||||
top: 0;
|
||||
left: 0;
|
||||
right: 0;
|
||||
height: 4px;
|
||||
background: linear-gradient(135deg, #1DA1F2, #0C85D0);
|
||||
}
|
||||
|
||||
.feature-card {
|
||||
background: white;
|
||||
border-radius: 12px;
|
||||
padding: 1.5rem;
|
||||
margin: 0.75rem 0;
|
||||
box-shadow: 0 4px 20px rgba(0, 0, 0, 0.08);
|
||||
border: 1px solid #E1E8ED;
|
||||
transition: all 0.3s ease;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.feature-card:hover {
|
||||
transform: translateY(-2px);
|
||||
box-shadow: 0 8px 30px rgba(29, 161, 242, 0.15);
|
||||
border-color: #1DA1F2;
|
||||
}
|
||||
|
||||
.feature-card-header {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 1rem;
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
|
||||
.feature-icon {
|
||||
font-size: 2rem;
|
||||
width: 60px;
|
||||
height: 60px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
background: linear-gradient(135deg, #E6F7FF, #F0F9FF);
|
||||
border-radius: 12px;
|
||||
border: 2px solid #91D5FF;
|
||||
}
|
||||
|
||||
.feature-title {
|
||||
font-size: 1.25rem;
|
||||
font-weight: 600;
|
||||
color: #2D3748;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.feature-description {
|
||||
color: #657786;
|
||||
font-size: 0.95rem;
|
||||
line-height: 1.5;
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
|
||||
.feature-stats {
|
||||
display: flex;
|
||||
gap: 1rem;
|
||||
margin-top: 1rem;
|
||||
padding-top: 1rem;
|
||||
border-top: 1px solid #E1E8ED;
|
||||
}
|
||||
|
||||
.stat-item {
|
||||
text-align: center;
|
||||
flex: 1;
|
||||
}
|
||||
|
||||
.stat-value {
|
||||
font-size: 1.5rem;
|
||||
font-weight: 700;
|
||||
color: #1DA1F2;
|
||||
display: block;
|
||||
}
|
||||
|
||||
.stat-label {
|
||||
font-size: 0.8rem;
|
||||
color: #657786;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.5px;
|
||||
}
|
||||
|
||||
.tweet-card {
|
||||
background: white;
|
||||
border: 1px solid #E1E8ED;
|
||||
border-radius: 16px;
|
||||
padding: 1.5rem;
|
||||
margin: 1rem 0;
|
||||
box-shadow: 0 4px 15px rgba(0, 0, 0, 0.08);
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.tweet-card::before {
|
||||
content: "🐦";
|
||||
position: absolute;
|
||||
top: -10px;
|
||||
left: 20px;
|
||||
background: white;
|
||||
padding: 0 10px;
|
||||
font-size: 1.2rem;
|
||||
}
|
||||
|
||||
.tweet-content {
|
||||
font-size: 1.1rem;
|
||||
line-height: 1.5;
|
||||
color: #14171A;
|
||||
margin-bottom: 1rem;
|
||||
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
|
||||
}
|
||||
|
||||
.tweet-metadata {
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
align-items: center;
|
||||
color: #657786;
|
||||
font-size: 0.9rem;
|
||||
border-top: 1px solid #E1E8ED;
|
||||
padding-top: 1rem;
|
||||
}
|
||||
|
||||
.engagement-badge {
|
||||
background: linear-gradient(135deg, #52C41A, #73D13D);
|
||||
color: white;
|
||||
padding: 0.5rem 1rem;
|
||||
border-radius: 20px;
|
||||
font-weight: 600;
|
||||
font-size: 0.9rem;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.character-badge {
|
||||
padding: 0.25rem 0.75rem;
|
||||
border-radius: 20px;
|
||||
font-weight: 600;
|
||||
font-size: 0.8rem;
|
||||
}
|
||||
|
||||
.char-good { background: #E6F7FF; color: #1890FF; }
|
||||
.char-warning { background: #FFF7E6; color: #FA8C16; }
|
||||
.char-danger { background: #FFF1F0; color: #F5222D; }
|
||||
|
||||
.card-actions {
|
||||
display: flex;
|
||||
gap: 0.5rem;
|
||||
margin-top: 1rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.action-button {
|
||||
background: #F7F9FA;
|
||||
border: 1px solid #E1E8ED;
|
||||
border-radius: 8px;
|
||||
padding: 0.5rem 1rem;
|
||||
color: #657786;
|
||||
font-size: 0.9rem;
|
||||
cursor: pointer;
|
||||
transition: all 0.3s ease;
|
||||
text-decoration: none;
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.action-button:hover {
|
||||
background: #1DA1F2;
|
||||
color: white;
|
||||
border-color: #1DA1F2;
|
||||
transform: translateY(-1px);
|
||||
}
|
||||
|
||||
.action-button.primary {
|
||||
background: #1DA1F2;
|
||||
color: white;
|
||||
border-color: #1DA1F2;
|
||||
}
|
||||
|
||||
.action-button.primary:hover {
|
||||
background: #0C85D0;
|
||||
border-color: #0C85D0;
|
||||
}
|
||||
|
||||
.metrics-grid {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fit, minmax(120px, 1fr));
|
||||
gap: 1rem;
|
||||
margin: 1rem 0;
|
||||
}
|
||||
|
||||
.metric-card {
|
||||
background: white;
|
||||
border-radius: 8px;
|
||||
padding: 1rem;
|
||||
text-align: center;
|
||||
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.05);
|
||||
border: 1px solid #E1E8ED;
|
||||
}
|
||||
|
||||
.metric-value {
|
||||
font-size: 1.5rem;
|
||||
font-weight: 700;
|
||||
color: #1DA1F2;
|
||||
display: block;
|
||||
margin-bottom: 0.25rem;
|
||||
}
|
||||
|
||||
.metric-label {
|
||||
font-size: 0.8rem;
|
||||
color: #657786;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.5px;
|
||||
}
|
||||
|
||||
/* Responsive Design */
|
||||
@media (max-width: 768px) {
|
||||
.modern-card, .feature-card, .tweet-card {
|
||||
margin: 0.5rem;
|
||||
padding: 1rem;
|
||||
}
|
||||
|
||||
.feature-card-header {
|
||||
flex-direction: column;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.feature-stats {
|
||||
flex-direction: column;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.card-actions {
|
||||
justify-content: center;
|
||||
}
|
||||
|
||||
.metrics-grid {
|
||||
grid-template-columns: repeat(2, 1fr);
|
||||
}
|
||||
}
|
||||
</style>
|
||||
""", unsafe_allow_html=True)
|
||||
|
||||
class FeatureCard:
|
||||
"""Modern feature card component."""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
title: str,
|
||||
description: str,
|
||||
icon: str = "🔧",
|
||||
stats: Optional[Dict[str, any]] = None,
|
||||
actions: Optional[List[Dict]] = None,
|
||||
on_click: Optional[Callable] = None
|
||||
):
|
||||
self.title = title
|
||||
self.description = description
|
||||
self.icon = icon
|
||||
self.stats = stats or {}
|
||||
self.actions = actions or []
|
||||
self.on_click = on_click
|
||||
|
||||
def render(self):
|
||||
"""Render the feature card."""
|
||||
apply_cards_styling()
|
||||
|
||||
# Create stats HTML
|
||||
stats_html = ""
|
||||
if self.stats:
|
||||
stats_items = []
|
||||
for label, value in self.stats.items():
|
||||
stats_items.append(f"""
|
||||
<div class="stat-item">
|
||||
<span class="stat-value">{value}</span>
|
||||
<span class="stat-label">{label}</span>
|
||||
</div>
|
||||
""")
|
||||
stats_html = f"""
|
||||
<div class="feature-stats">
|
||||
{''.join(stats_items)}
|
||||
</div>
|
||||
"""
|
||||
|
||||
# Create actions HTML
|
||||
actions_html = ""
|
||||
if self.actions:
|
||||
action_buttons = []
|
||||
for action in self.actions:
|
||||
button_class = "action-button"
|
||||
if action.get("primary", False):
|
||||
button_class += " primary"
|
||||
|
||||
action_buttons.append(f"""
|
||||
<button class="{button_class}" onclick="{action.get('onclick', '')}">
|
||||
{action.get('icon', '')} {action.get('label', 'Action')}
|
||||
</button>
|
||||
""")
|
||||
actions_html = f"""
|
||||
<div class="card-actions">
|
||||
{''.join(action_buttons)}
|
||||
</div>
|
||||
"""
|
||||
|
||||
# Render the card
|
||||
card_html = f"""
|
||||
<div class="feature-card" onclick="{self.on_click or ''}">
|
||||
<div class="feature-card-header">
|
||||
<div class="feature-icon">{self.icon}</div>
|
||||
<div>
|
||||
<h3 class="feature-title">{self.title}</h3>
|
||||
</div>
|
||||
</div>
|
||||
<p class="feature-description">{self.description}</p>
|
||||
{stats_html}
|
||||
{actions_html}
|
||||
</div>
|
||||
"""
|
||||
|
||||
st.markdown(card_html, unsafe_allow_html=True)
|
||||
|
||||
class TweetCard:
|
||||
"""Modern tweet card component."""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
content: str,
|
||||
engagement_score: int = 0,
|
||||
hashtags: List[str] = None,
|
||||
emojis: List[str] = None,
|
||||
metrics: Optional[Dict] = None,
|
||||
timestamp: Optional[str] = None,
|
||||
on_copy: Optional[Callable] = None,
|
||||
on_save: Optional[Callable] = None,
|
||||
on_edit: Optional[Callable] = None,
|
||||
on_post: Optional[Callable] = None
|
||||
):
|
||||
self.content = content
|
||||
self.engagement_score = engagement_score
|
||||
self.hashtags = hashtags or []
|
||||
self.emojis = emojis or []
|
||||
self.metrics = metrics or {}
|
||||
self.timestamp = timestamp or datetime.now().strftime("%Y-%m-%d %H:%M")
|
||||
self.on_copy = on_copy
|
||||
self.on_save = on_save
|
||||
self.on_edit = on_edit
|
||||
self.on_post = on_post
|
||||
|
||||
def _get_character_info(self):
|
||||
"""Get character count information."""
|
||||
full_text = f"{self.content} {' '.join(self.hashtags)}"
|
||||
count = len(full_text)
|
||||
remaining = 280 - count
|
||||
|
||||
if count <= 240:
|
||||
status_class = "char-good"
|
||||
elif count <= 270:
|
||||
status_class = "char-warning"
|
||||
else:
|
||||
status_class = "char-danger"
|
||||
|
||||
return {
|
||||
"count": count,
|
||||
"remaining": remaining,
|
||||
"status_class": status_class
|
||||
}
|
||||
|
||||
def render(self):
|
||||
"""Render the tweet card."""
|
||||
apply_cards_styling()
|
||||
|
||||
char_info = self._get_character_info()
|
||||
full_content = f"{self.content} {' '.join(self.hashtags)}"
|
||||
|
||||
# Create metrics HTML
|
||||
metrics_html = ""
|
||||
if self.metrics:
|
||||
metric_items = []
|
||||
for label, value in self.metrics.items():
|
||||
metric_items.append(f"""
|
||||
<div class="metric-card">
|
||||
<span class="metric-value">{value}</span>
|
||||
<span class="metric-label">{label}</span>
|
||||
</div>
|
||||
""")
|
||||
metrics_html = f"""
|
||||
<div class="metrics-grid">
|
||||
{''.join(metric_items)}
|
||||
</div>
|
||||
"""
|
||||
|
||||
# Create actions
|
||||
actions = []
|
||||
if self.on_copy:
|
||||
actions.append('<button class="action-button" onclick="copyTweet()">📋 Copy</button>')
|
||||
if self.on_save:
|
||||
actions.append('<button class="action-button" onclick="saveTweet()">💾 Save</button>')
|
||||
if self.on_edit:
|
||||
actions.append('<button class="action-button" onclick="editTweet()">✏️ Edit</button>')
|
||||
if self.on_post:
|
||||
actions.append('<button class="action-button primary" onclick="postTweet()">🐦 Post</button>')
|
||||
|
||||
actions_html = f'<div class="card-actions">{"".join(actions)}</div>' if actions else ""
|
||||
|
||||
# Render the card
|
||||
card_html = f"""
|
||||
<div class="tweet-card">
|
||||
<div class="tweet-content">{full_content}</div>
|
||||
{metrics_html}
|
||||
<div class="tweet-metadata">
|
||||
<div class="engagement-badge">
|
||||
📊 {self.engagement_score}% Engagement
|
||||
</div>
|
||||
<div class="character-badge {char_info['status_class']}">
|
||||
{char_info['count']}/280
|
||||
</div>
|
||||
</div>
|
||||
{actions_html}
|
||||
</div>
|
||||
"""
|
||||
|
||||
st.markdown(card_html, unsafe_allow_html=True)
|
||||
|
||||
class MetricsCard:
|
||||
"""Modern metrics display card."""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
title: str,
|
||||
metrics: Dict[str, any],
|
||||
chart_data: Optional[Dict] = None,
|
||||
trend: Optional[str] = None
|
||||
):
|
||||
self.title = title
|
||||
self.metrics = metrics
|
||||
self.chart_data = chart_data
|
||||
self.trend = trend
|
||||
|
||||
def render(self):
|
||||
"""Render the metrics card."""
|
||||
apply_cards_styling()
|
||||
|
||||
# Create metrics grid
|
||||
metric_items = []
|
||||
for label, value in self.metrics.items():
|
||||
metric_items.append(f"""
|
||||
<div class="metric-card">
|
||||
<span class="metric-value">{value}</span>
|
||||
<span class="metric-label">{label}</span>
|
||||
</div>
|
||||
""")
|
||||
|
||||
metrics_grid = f"""
|
||||
<div class="metrics-grid">
|
||||
{''.join(metric_items)}
|
||||
</div>
|
||||
"""
|
||||
|
||||
# Add trend indicator
|
||||
trend_html = ""
|
||||
if self.trend:
|
||||
trend_color = "#52C41A" if "up" in self.trend.lower() else "#F5222D"
|
||||
trend_icon = "📈" if "up" in self.trend.lower() else "📉"
|
||||
trend_html = f"""
|
||||
<div style="text-align: center; margin-top: 1rem; color: {trend_color};">
|
||||
{trend_icon} {self.trend}
|
||||
</div>
|
||||
"""
|
||||
|
||||
# Render the card
|
||||
card_html = f"""
|
||||
<div class="modern-card">
|
||||
<h3 style="margin-bottom: 1rem; color: #2D3748;">{self.title}</h3>
|
||||
{metrics_grid}
|
||||
{trend_html}
|
||||
</div>
|
||||
"""
|
||||
|
||||
st.markdown(card_html, unsafe_allow_html=True)
|
||||
|
||||
# Add chart if provided
|
||||
if self.chart_data:
|
||||
self._render_chart()
|
||||
|
||||
def _render_chart(self):
|
||||
"""Render chart for metrics."""
|
||||
if self.chart_data.get("type") == "line":
|
||||
fig = px.line(
|
||||
x=self.chart_data.get("x", []),
|
||||
y=self.chart_data.get("y", []),
|
||||
title=self.chart_data.get("title", ""),
|
||||
labels=self.chart_data.get("labels", {})
|
||||
)
|
||||
elif self.chart_data.get("type") == "bar":
|
||||
fig = px.bar(
|
||||
x=self.chart_data.get("x", []),
|
||||
y=self.chart_data.get("y", []),
|
||||
title=self.chart_data.get("title", ""),
|
||||
labels=self.chart_data.get("labels", {})
|
||||
)
|
||||
else:
|
||||
return
|
||||
|
||||
fig.update_layout(
|
||||
plot_bgcolor='rgba(0,0,0,0)',
|
||||
paper_bgcolor='rgba(0,0,0,0)',
|
||||
showlegend=False,
|
||||
height=300
|
||||
)
|
||||
|
||||
st.plotly_chart(fig, use_container_width=True)
|
||||
|
||||
class StatusCard:
|
||||
"""Status indicator card."""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
title: str,
|
||||
status: str,
|
||||
message: str,
|
||||
icon: str = "ℹ️",
|
||||
actions: Optional[List[Dict]] = None
|
||||
):
|
||||
self.title = title
|
||||
self.status = status # success, warning, error, info
|
||||
self.message = message
|
||||
self.icon = icon
|
||||
self.actions = actions or []
|
||||
|
||||
def render(self):
|
||||
"""Render the status card."""
|
||||
apply_cards_styling()
|
||||
|
||||
# Status colors
|
||||
status_colors = {
|
||||
"success": "#52C41A",
|
||||
"warning": "#FA8C16",
|
||||
"error": "#F5222D",
|
||||
"info": "#1890FF"
|
||||
}
|
||||
|
||||
color = status_colors.get(self.status, "#1890FF")
|
||||
|
||||
# Create actions
|
||||
actions_html = ""
|
||||
if self.actions:
|
||||
action_buttons = []
|
||||
for action in self.actions:
|
||||
action_buttons.append(f"""
|
||||
<button class="action-button" onclick="{action.get('onclick', '')}">
|
||||
{action.get('icon', '')} {action.get('label', 'Action')}
|
||||
</button>
|
||||
""")
|
||||
actions_html = f"""
|
||||
<div class="card-actions">
|
||||
{''.join(action_buttons)}
|
||||
</div>
|
||||
"""
|
||||
|
||||
# Render the card
|
||||
card_html = f"""
|
||||
<div class="modern-card" style="border-left: 4px solid {color};">
|
||||
<div style="display: flex; align-items: center; gap: 1rem; margin-bottom: 1rem;">
|
||||
<span style="font-size: 2rem;">{self.icon}</span>
|
||||
<div>
|
||||
<h3 style="margin: 0; color: #2D3748;">{self.title}</h3>
|
||||
<span style="color: {color}; font-weight: 600; text-transform: uppercase; font-size: 0.8rem;">
|
||||
{self.status}
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
<p style="color: #657786; margin-bottom: 1rem;">{self.message}</p>
|
||||
{actions_html}
|
||||
</div>
|
||||
"""
|
||||
|
||||
st.markdown(card_html, unsafe_allow_html=True)
|
||||
|
||||
# Utility functions for creating common cards
|
||||
def create_feature_card(title: str, description: str, icon: str = "🔧", **kwargs):
|
||||
"""Create and render a feature card."""
|
||||
card = FeatureCard(title, description, icon, **kwargs)
|
||||
card.render()
|
||||
|
||||
def create_tweet_card(content: str, **kwargs):
|
||||
"""Create and render a tweet card."""
|
||||
card = TweetCard(content, **kwargs)
|
||||
card.render()
|
||||
|
||||
def create_metrics_card(title: str, metrics: Dict, **kwargs):
|
||||
"""Create and render a metrics card."""
|
||||
card = MetricsCard(title, metrics, **kwargs)
|
||||
card.render()
|
||||
|
||||
def create_status_card(title: str, status: str, message: str, **kwargs):
|
||||
"""Create and render a status card."""
|
||||
card = StatusCard(title, status, message, **kwargs)
|
||||
card.render()
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,554 @@
|
||||
"""
|
||||
Enhanced Navigation Component for Twitter UI with modern styling and improved functionality.
|
||||
"""
|
||||
|
||||
import streamlit as st
|
||||
from typing import Dict, List, Optional, Callable, Any
|
||||
from ..styles.theme import Theme
|
||||
import os
|
||||
|
||||
def apply_navigation_styling():
|
||||
"""Apply modern CSS styling for navigation components."""
|
||||
st.markdown("""
|
||||
<style>
|
||||
/* Navigation Styles */
|
||||
.nav-container {
|
||||
background: rgba(255, 255, 255, 0.95);
|
||||
backdrop-filter: blur(20px);
|
||||
border-radius: 16px;
|
||||
padding: 1rem;
|
||||
margin-bottom: 2rem;
|
||||
box-shadow: 0 8px 32px rgba(0, 0, 0, 0.1);
|
||||
border: 1px solid rgba(255, 255, 255, 0.2);
|
||||
}
|
||||
|
||||
.nav-header {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
margin-bottom: 1rem;
|
||||
padding-bottom: 1rem;
|
||||
border-bottom: 2px solid #E2E8F0;
|
||||
}
|
||||
|
||||
.nav-title {
|
||||
font-size: 1.5rem;
|
||||
font-weight: 700;
|
||||
color: #1DA1F2;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.nav-status {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
padding: 0.5rem 1rem;
|
||||
border-radius: 20px;
|
||||
font-size: 0.9rem;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.status-connected {
|
||||
background: linear-gradient(135deg, #52C41A, #73D13D);
|
||||
color: white;
|
||||
}
|
||||
|
||||
.status-disconnected {
|
||||
background: linear-gradient(135deg, #FA8C16, #FFA940);
|
||||
color: white;
|
||||
}
|
||||
|
||||
.nav-menu {
|
||||
display: flex;
|
||||
gap: 0.5rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.nav-item {
|
||||
background: #F7F9FA;
|
||||
border: 2px solid transparent;
|
||||
border-radius: 12px;
|
||||
padding: 0.75rem 1.5rem;
|
||||
color: #657786;
|
||||
font-weight: 600;
|
||||
cursor: pointer;
|
||||
transition: all 0.3s ease;
|
||||
text-decoration: none;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.nav-item:hover {
|
||||
background: #E1F5FE;
|
||||
border-color: #1DA1F2;
|
||||
color: #1DA1F2;
|
||||
transform: translateY(-2px);
|
||||
box-shadow: 0 4px 15px rgba(29, 161, 242, 0.2);
|
||||
}
|
||||
|
||||
.nav-item.active {
|
||||
background: linear-gradient(135deg, #1DA1F2, #0C85D0);
|
||||
color: white;
|
||||
border-color: #1DA1F2;
|
||||
box-shadow: 0 4px 15px rgba(29, 161, 242, 0.3);
|
||||
}
|
||||
|
||||
.nav-item.active:hover {
|
||||
transform: translateY(-2px);
|
||||
box-shadow: 0 6px 20px rgba(29, 161, 242, 0.4);
|
||||
}
|
||||
|
||||
.nav-breadcrumb {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
margin-bottom: 1rem;
|
||||
font-size: 0.9rem;
|
||||
color: #657786;
|
||||
}
|
||||
|
||||
.breadcrumb-item {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.25rem;
|
||||
}
|
||||
|
||||
.breadcrumb-separator {
|
||||
color: #CBD5E0;
|
||||
margin: 0 0.5rem;
|
||||
}
|
||||
|
||||
.nav-actions {
|
||||
display: flex;
|
||||
gap: 0.5rem;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
.action-button {
|
||||
background: linear-gradient(135deg, #52C41A, #73D13D);
|
||||
color: white;
|
||||
border: none;
|
||||
border-radius: 8px;
|
||||
padding: 0.5rem 1rem;
|
||||
font-weight: 600;
|
||||
cursor: pointer;
|
||||
transition: all 0.3s ease;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.action-button:hover {
|
||||
transform: translateY(-2px);
|
||||
box-shadow: 0 4px 15px rgba(82, 196, 26, 0.3);
|
||||
}
|
||||
|
||||
.action-button.secondary {
|
||||
background: #F7F9FA;
|
||||
color: #657786;
|
||||
border: 1px solid #E1E8ED;
|
||||
}
|
||||
|
||||
.action-button.secondary:hover {
|
||||
background: #E1F5FE;
|
||||
color: #1DA1F2;
|
||||
border-color: #1DA1F2;
|
||||
}
|
||||
|
||||
/* Mobile Responsive */
|
||||
@media (max-width: 768px) {
|
||||
.nav-header {
|
||||
flex-direction: column;
|
||||
gap: 1rem;
|
||||
align-items: flex-start;
|
||||
}
|
||||
|
||||
.nav-menu {
|
||||
flex-direction: column;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.nav-item {
|
||||
width: 100%;
|
||||
justify-content: center;
|
||||
}
|
||||
|
||||
.nav-actions {
|
||||
width: 100%;
|
||||
justify-content: center;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
""", unsafe_allow_html=True)
|
||||
|
||||
class TwitterNavigation:
|
||||
"""Enhanced navigation component for Twitter dashboard."""
|
||||
|
||||
def __init__(self, theme: Optional[Theme] = None):
|
||||
self.theme = theme or Theme()
|
||||
self.current_page = st.session_state.get('current_page', 'dashboard')
|
||||
|
||||
def render_header(self, title: str = "Twitter AI Assistant", show_status: bool = True):
|
||||
"""Render the navigation header with title and status."""
|
||||
apply_navigation_styling()
|
||||
|
||||
st.markdown('<div class="nav-container">', unsafe_allow_html=True)
|
||||
st.markdown('<div class="nav-header">', unsafe_allow_html=True)
|
||||
|
||||
# Title
|
||||
st.markdown(f'<div class="nav-title">🐦 {title}</div>', unsafe_allow_html=True)
|
||||
|
||||
# Status indicator
|
||||
if show_status:
|
||||
twitter_connected = self._check_twitter_connection()
|
||||
status_class = "status-connected" if twitter_connected else "status-disconnected"
|
||||
status_text = "Connected" if twitter_connected else "Not Connected"
|
||||
status_icon = "✅" if twitter_connected else "⚠️"
|
||||
|
||||
st.markdown(f'''
|
||||
<div class="nav-status {status_class}">
|
||||
{status_icon} Twitter {status_text}
|
||||
</div>
|
||||
''', unsafe_allow_html=True)
|
||||
|
||||
st.markdown('</div>', unsafe_allow_html=True)
|
||||
|
||||
def render_menu(self, menu_items: List[Dict], current_page: Optional[str] = None):
|
||||
"""Render navigation menu with items."""
|
||||
if current_page:
|
||||
self.current_page = current_page
|
||||
st.session_state.current_page = current_page
|
||||
|
||||
st.markdown('<div class="nav-menu">', unsafe_allow_html=True)
|
||||
|
||||
cols = st.columns(len(menu_items))
|
||||
|
||||
for i, item in enumerate(menu_items):
|
||||
with cols[i]:
|
||||
active_class = "active" if item.get('key') == self.current_page else ""
|
||||
|
||||
if st.button(
|
||||
f"{item.get('icon', '')} {item.get('label', '')}",
|
||||
key=f"nav_{item.get('key', i)}",
|
||||
use_container_width=True,
|
||||
type="primary" if active_class else "secondary"
|
||||
):
|
||||
st.session_state.current_page = item.get('key')
|
||||
if item.get('callback'):
|
||||
item['callback']()
|
||||
st.rerun()
|
||||
|
||||
st.markdown('</div>', unsafe_allow_html=True)
|
||||
st.markdown('</div>', unsafe_allow_html=True)
|
||||
|
||||
return st.session_state.get('current_page', menu_items[0].get('key'))
|
||||
|
||||
def render_breadcrumb(self, items: List[Dict]):
|
||||
"""Render breadcrumb navigation."""
|
||||
st.markdown('<div class="nav-breadcrumb">', unsafe_allow_html=True)
|
||||
|
||||
for i, item in enumerate(items):
|
||||
if i > 0:
|
||||
st.markdown('<span class="breadcrumb-separator">›</span>', unsafe_allow_html=True)
|
||||
|
||||
icon = item.get('icon', '')
|
||||
label = item.get('label', '')
|
||||
|
||||
if item.get('active', False):
|
||||
st.markdown(f'<span class="breadcrumb-item"><strong>{icon} {label}</strong></span>', unsafe_allow_html=True)
|
||||
else:
|
||||
st.markdown(f'<span class="breadcrumb-item">{icon} {label}</span>', unsafe_allow_html=True)
|
||||
|
||||
st.markdown('</div>', unsafe_allow_html=True)
|
||||
|
||||
def render_actions(self, actions: List[Dict]):
|
||||
"""Render action buttons in navigation."""
|
||||
st.markdown('<div class="nav-actions">', unsafe_allow_html=True)
|
||||
|
||||
cols = st.columns(len(actions))
|
||||
|
||||
for i, action in enumerate(actions):
|
||||
with cols[i]:
|
||||
button_type = action.get('type', 'primary')
|
||||
|
||||
if st.button(
|
||||
f"{action.get('icon', '')} {action.get('label', '')}",
|
||||
key=f"action_{action.get('key', i)}",
|
||||
type=button_type,
|
||||
use_container_width=True,
|
||||
help=action.get('help', '')
|
||||
):
|
||||
if action.get('callback'):
|
||||
action['callback']()
|
||||
|
||||
st.markdown('</div>', unsafe_allow_html=True)
|
||||
|
||||
def render_sidebar_menu(self, menu_items: List[Dict]):
|
||||
"""Render sidebar navigation menu."""
|
||||
with st.sidebar:
|
||||
st.markdown("### 🐦 Twitter Tools")
|
||||
|
||||
for item in menu_items:
|
||||
icon = item.get('icon', '')
|
||||
label = item.get('label', '')
|
||||
key = item.get('key', '')
|
||||
|
||||
if st.button(f"{icon} {label}", key=f"sidebar_{key}", use_container_width=True):
|
||||
st.session_state.current_page = key
|
||||
if item.get('callback'):
|
||||
item['callback']()
|
||||
st.rerun()
|
||||
|
||||
# Twitter connection status in sidebar
|
||||
st.markdown("---")
|
||||
twitter_connected = self._check_twitter_connection()
|
||||
|
||||
if twitter_connected:
|
||||
st.success("🐦 Twitter Connected")
|
||||
else:
|
||||
st.warning("⚠️ Twitter Not Connected")
|
||||
if st.button("🔧 Configure Twitter", use_container_width=True):
|
||||
st.session_state.show_twitter_config = True
|
||||
st.rerun()
|
||||
|
||||
def _check_twitter_connection(self) -> bool:
|
||||
"""Check if Twitter is connected."""
|
||||
twitter_config = st.session_state.get('twitter_config', {})
|
||||
return bool(twitter_config and all([
|
||||
twitter_config.get('api_key'),
|
||||
twitter_config.get('api_secret'),
|
||||
twitter_config.get('access_token'),
|
||||
twitter_config.get('access_token_secret')
|
||||
]))
|
||||
|
||||
class Sidebar:
|
||||
"""Sidebar navigation component."""
|
||||
|
||||
def __init__(self, title: str = "Navigation", logo: Optional[str] = None):
|
||||
"""Initialize the sidebar."""
|
||||
self.title = title
|
||||
self.logo = logo
|
||||
self.menu_items = []
|
||||
|
||||
def add_menu_item(self, label: str, icon: str, key: str, callback: Optional[Callable] = None):
|
||||
"""Add a menu item to the sidebar."""
|
||||
self.menu_items.append({
|
||||
'label': label,
|
||||
'icon': icon,
|
||||
'key': key,
|
||||
'callback': callback
|
||||
})
|
||||
|
||||
def render(self) -> str:
|
||||
"""Render the sidebar and return the selected page."""
|
||||
with st.sidebar:
|
||||
# Logo and title
|
||||
if self.logo and os.path.exists(self.logo):
|
||||
st.image(self.logo, width=100)
|
||||
st.title(self.title)
|
||||
st.markdown("---")
|
||||
|
||||
# Menu items
|
||||
selected_page = None
|
||||
for item in self.menu_items:
|
||||
if st.button(
|
||||
f"{item['icon']} {item['label']}",
|
||||
key=f"sidebar_{item['key']}",
|
||||
use_container_width=True
|
||||
):
|
||||
selected_page = item['key']
|
||||
if item.get('callback'):
|
||||
item['callback']()
|
||||
|
||||
return selected_page or st.session_state.get('current_page', 'dashboard')
|
||||
|
||||
|
||||
class Header:
|
||||
"""Header component with title and actions."""
|
||||
|
||||
def __init__(self, title: str = "Dashboard", subtitle: str = ""):
|
||||
"""Initialize the header."""
|
||||
self.title = title
|
||||
self.subtitle = subtitle
|
||||
self.actions = []
|
||||
|
||||
def add_action(self, label: str, icon: str, callback: Callable, help_text: str = ""):
|
||||
"""Add an action button to the header."""
|
||||
self.actions.append({
|
||||
'label': label,
|
||||
'icon': icon,
|
||||
'callback': callback,
|
||||
'help': help_text
|
||||
})
|
||||
|
||||
def render(self):
|
||||
"""Render the header."""
|
||||
col1, col2 = st.columns([3, 1])
|
||||
|
||||
with col1:
|
||||
st.title(f"{self.title}")
|
||||
if self.subtitle:
|
||||
st.markdown(f"*{self.subtitle}*")
|
||||
|
||||
with col2:
|
||||
if self.actions:
|
||||
for i, action in enumerate(self.actions):
|
||||
if st.button(
|
||||
f"{action['icon']} {action['label']}",
|
||||
key=f"header_action_{i}",
|
||||
help=action.get('help', ''),
|
||||
use_container_width=True
|
||||
):
|
||||
action['callback']()
|
||||
|
||||
|
||||
class Tabs:
|
||||
"""Tab navigation component."""
|
||||
|
||||
def __init__(self):
|
||||
"""Initialize the tabs."""
|
||||
self.tabs = []
|
||||
|
||||
def add_tab(self, label: str, icon: str, content_func: Callable):
|
||||
"""Add a tab."""
|
||||
self.tabs.append({
|
||||
'label': label,
|
||||
'icon': icon,
|
||||
'content_func': content_func
|
||||
})
|
||||
|
||||
def render(self):
|
||||
"""Render the tabs."""
|
||||
if not self.tabs:
|
||||
return
|
||||
|
||||
tab_labels = [f"{tab['icon']} {tab['label']}" for tab in self.tabs]
|
||||
selected_tabs = st.tabs(tab_labels)
|
||||
|
||||
for i, tab in enumerate(self.tabs):
|
||||
with selected_tabs[i]:
|
||||
tab['content_func']()
|
||||
|
||||
|
||||
class Breadcrumbs:
|
||||
"""Breadcrumb navigation component."""
|
||||
|
||||
def __init__(self):
|
||||
"""Initialize breadcrumbs."""
|
||||
self.items = []
|
||||
|
||||
def add_item(self, label: str, key: str = None, callback: Callable = None):
|
||||
"""Add a breadcrumb item."""
|
||||
self.items.append({
|
||||
'label': label,
|
||||
'key': key,
|
||||
'callback': callback
|
||||
})
|
||||
|
||||
def render(self):
|
||||
"""Render the breadcrumbs."""
|
||||
if not self.items:
|
||||
return
|
||||
|
||||
breadcrumb_html = '<div class="nav-breadcrumb">'
|
||||
|
||||
for i, item in enumerate(self.items):
|
||||
if i > 0:
|
||||
breadcrumb_html += '<span class="breadcrumb-separator">›</span>'
|
||||
|
||||
if item.get('callback'):
|
||||
breadcrumb_html += f'<span class="breadcrumb-item clickable" onclick="handleBreadcrumbClick(\'{item["key"]}\')">{item["label"]}</span>'
|
||||
else:
|
||||
breadcrumb_html += f'<span class="breadcrumb-item">{item["label"]}</span>'
|
||||
|
||||
breadcrumb_html += '</div>'
|
||||
st.markdown(breadcrumb_html, unsafe_allow_html=True)
|
||||
|
||||
|
||||
def create_main_navigation() -> TwitterNavigation:
|
||||
"""Create and return the main navigation instance."""
|
||||
return TwitterNavigation()
|
||||
|
||||
def render_page_header(title: str, subtitle: str = "", icon: str = ""):
|
||||
"""Render a consistent page header."""
|
||||
st.markdown(f"""
|
||||
<div style="text-align: center; margin-bottom: 2rem; padding: 2rem; background: linear-gradient(135deg, #E6F7FF, #F0F9FF); border-radius: 16px;">
|
||||
<h1 style="color: #1DA1F2; margin-bottom: 0.5rem;">{icon} {title}</h1>
|
||||
{f'<p style="color: #657786; font-size: 1.1rem;">{subtitle}</p>' if subtitle else ''}
|
||||
</div>
|
||||
""", unsafe_allow_html=True)
|
||||
|
||||
def render_quick_actions(actions: List[Dict]):
|
||||
"""Render quick action buttons."""
|
||||
st.markdown("### ⚡ Quick Actions")
|
||||
|
||||
cols = st.columns(len(actions))
|
||||
|
||||
for i, action in enumerate(actions):
|
||||
with cols[i]:
|
||||
if st.button(
|
||||
f"{action.get('icon', '')} {action.get('label', '')}",
|
||||
key=f"quick_action_{i}",
|
||||
use_container_width=True,
|
||||
help=action.get('help', '')
|
||||
):
|
||||
if action.get('callback'):
|
||||
action['callback']()
|
||||
|
||||
# Default menu items for Twitter dashboard
|
||||
DEFAULT_MENU_ITEMS = [
|
||||
{
|
||||
'key': 'dashboard',
|
||||
'label': 'Dashboard',
|
||||
'icon': '🏠',
|
||||
'help': 'Main dashboard overview'
|
||||
},
|
||||
{
|
||||
'key': 'generator',
|
||||
'label': 'Tweet Generator',
|
||||
'icon': '✨',
|
||||
'help': 'AI-powered tweet generation'
|
||||
},
|
||||
{
|
||||
'key': 'analytics',
|
||||
'label': 'Analytics',
|
||||
'icon': '📊',
|
||||
'help': 'Tweet performance analytics'
|
||||
},
|
||||
{
|
||||
'key': 'scheduler',
|
||||
'label': 'Scheduler',
|
||||
'icon': '📅',
|
||||
'help': 'Schedule tweets for later'
|
||||
},
|
||||
{
|
||||
'key': 'settings',
|
||||
'label': 'Settings',
|
||||
'icon': '⚙️',
|
||||
'help': 'Twitter account and API settings'
|
||||
}
|
||||
]
|
||||
|
||||
DEFAULT_QUICK_ACTIONS = [
|
||||
{
|
||||
'key': 'new_tweet',
|
||||
'label': 'New Tweet',
|
||||
'icon': '✍️',
|
||||
'help': 'Create a new tweet'
|
||||
},
|
||||
{
|
||||
'key': 'ai_generate',
|
||||
'label': 'AI Generate',
|
||||
'icon': '🤖',
|
||||
'help': 'Generate tweets with AI'
|
||||
},
|
||||
{
|
||||
'key': 'view_analytics',
|
||||
'label': 'View Analytics',
|
||||
'icon': '📈',
|
||||
'help': 'Check tweet performance'
|
||||
}
|
||||
]
|
||||
@@ -0,0 +1,278 @@
|
||||
"""
|
||||
Main dashboard for Twitter UI.
|
||||
Combines all UI components into a cohesive interface.
|
||||
"""
|
||||
|
||||
import streamlit as st
|
||||
from typing import Dict, Any, Optional
|
||||
from .components.cards import FeatureCard, TweetCard
|
||||
from .components.forms import TweetForm, SettingsForm
|
||||
from .components.navigation import Sidebar, Header, Tabs, Breadcrumbs
|
||||
from .styles.theme import Theme
|
||||
import os
|
||||
|
||||
class TwitterDashboard:
|
||||
"""Main dashboard class for Twitter UI."""
|
||||
|
||||
def __init__(self):
|
||||
"""Initialize the Twitter dashboard."""
|
||||
self.setup_theme()
|
||||
self.setup_navigation()
|
||||
self.setup_state()
|
||||
|
||||
def get_logo_path(self) -> str:
|
||||
"""Get the best available logo path with fallbacks."""
|
||||
# List of potential logo paths in order of preference
|
||||
logo_paths = [
|
||||
"lib/workspace/alwrity_logo.png",
|
||||
"lib/workspace/AskAlwrity-min.ico",
|
||||
"lib/workspace/alwrity_ai_writer.png"
|
||||
]
|
||||
|
||||
for path in logo_paths:
|
||||
if os.path.exists(path):
|
||||
return path
|
||||
|
||||
# If no logo files are found, return None
|
||||
return None
|
||||
|
||||
def setup_theme(self) -> None:
|
||||
"""Setup theme and styling."""
|
||||
Theme.apply()
|
||||
|
||||
def setup_navigation(self) -> None:
|
||||
"""Setup navigation components."""
|
||||
# Sidebar
|
||||
self.sidebar = Sidebar(
|
||||
title="Twitter Tools",
|
||||
logo=self.get_logo_path()
|
||||
)
|
||||
|
||||
# Add menu items
|
||||
self.sidebar.add_menu_item("Dashboard", "📊", "dashboard")
|
||||
self.sidebar.add_menu_item("Tweet Generator", "✍️", "tweet_generator")
|
||||
self.sidebar.add_menu_item("Analytics", "📈", "analytics")
|
||||
self.sidebar.add_menu_item("Settings", "⚙️", "settings")
|
||||
|
||||
# Header
|
||||
self.header = Header(
|
||||
title="Twitter Dashboard",
|
||||
subtitle="Create and manage your Twitter content"
|
||||
)
|
||||
|
||||
# Add header actions
|
||||
self.header.add_action(
|
||||
"New Tweet",
|
||||
"✏️",
|
||||
self.create_new_tweet,
|
||||
"Create a new tweet"
|
||||
)
|
||||
self.header.add_action(
|
||||
"Refresh",
|
||||
"🔄",
|
||||
self.refresh_dashboard,
|
||||
"Refresh dashboard data"
|
||||
)
|
||||
|
||||
# Tabs
|
||||
self.tabs = Tabs()
|
||||
|
||||
# Add tabs
|
||||
self.tabs.add_tab("Overview", "📊", self.render_overview)
|
||||
self.tabs.add_tab("Recent Tweets", "🐦", self.render_recent_tweets)
|
||||
self.tabs.add_tab("Analytics", "📈", self.render_analytics)
|
||||
|
||||
# Breadcrumbs
|
||||
self.breadcrumbs = Breadcrumbs()
|
||||
|
||||
def setup_state(self) -> None:
|
||||
"""Initialize session state variables."""
|
||||
if "current_page" not in st.session_state:
|
||||
st.session_state["current_page"] = "dashboard"
|
||||
if "current_tab" not in st.session_state:
|
||||
st.session_state["current_tab"] = "Overview"
|
||||
if "tweets" not in st.session_state:
|
||||
st.session_state["tweets"] = []
|
||||
|
||||
def create_new_tweet(self) -> None:
|
||||
"""Handle new tweet creation."""
|
||||
st.session_state["current_page"] = "tweet_generator"
|
||||
|
||||
def refresh_dashboard(self) -> None:
|
||||
"""Refresh dashboard data."""
|
||||
st.rerun()
|
||||
|
||||
def render_overview(self) -> None:
|
||||
"""Render the overview tab content."""
|
||||
# Feature cards
|
||||
col1, col2, col3 = st.columns(3)
|
||||
|
||||
with col1:
|
||||
FeatureCard(
|
||||
title="Tweet Generator",
|
||||
description="Create engaging tweets with AI assistance",
|
||||
icon="✍️",
|
||||
features=[
|
||||
{
|
||||
"name": "AI-Powered",
|
||||
"description": "Generate tweets using advanced AI"
|
||||
},
|
||||
{
|
||||
"name": "Customizable",
|
||||
"description": "Adjust tone, length, and style"
|
||||
}
|
||||
],
|
||||
on_click=self.create_new_tweet
|
||||
).render()
|
||||
|
||||
with col2:
|
||||
FeatureCard(
|
||||
title="Analytics",
|
||||
description="Track your tweet performance",
|
||||
icon="📈",
|
||||
features=[
|
||||
{
|
||||
"name": "Engagement",
|
||||
"description": "Monitor likes, retweets, and replies"
|
||||
},
|
||||
{
|
||||
"name": "Growth",
|
||||
"description": "Track follower growth over time"
|
||||
}
|
||||
]
|
||||
).render()
|
||||
|
||||
with col3:
|
||||
FeatureCard(
|
||||
title="Settings",
|
||||
description="Customize your experience",
|
||||
icon="⚙️",
|
||||
features=[
|
||||
{
|
||||
"name": "Preferences",
|
||||
"description": "Set your default options"
|
||||
},
|
||||
{
|
||||
"name": "API",
|
||||
"description": "Configure Twitter API settings"
|
||||
}
|
||||
]
|
||||
).render()
|
||||
|
||||
def render_recent_tweets(self) -> None:
|
||||
"""Render the recent tweets tab content."""
|
||||
# Tweet form
|
||||
tweet_form = TweetForm(
|
||||
on_submit=self.handle_tweet_submit
|
||||
)
|
||||
tweet_form.render()
|
||||
|
||||
# Recent tweets
|
||||
st.markdown("### Recent Tweets")
|
||||
|
||||
for tweet in st.session_state["tweets"]:
|
||||
TweetCard(
|
||||
content=tweet["content"],
|
||||
engagement_score=tweet["engagement_score"],
|
||||
hashtags=tweet["hashtags"],
|
||||
emojis=tweet["emojis"],
|
||||
metrics=tweet["metrics"],
|
||||
on_copy=lambda: self.copy_tweet(tweet),
|
||||
on_save=lambda: self.save_tweet(tweet)
|
||||
).render()
|
||||
|
||||
def render_analytics(self) -> None:
|
||||
"""Render the analytics tab content."""
|
||||
# Analytics content
|
||||
st.markdown("### Tweet Analytics")
|
||||
|
||||
# Placeholder for analytics charts
|
||||
st.info("Analytics features coming soon!")
|
||||
|
||||
def handle_tweet_submit(self) -> None:
|
||||
"""Handle tweet form submission."""
|
||||
# Get form data
|
||||
content = st.session_state["tweet_content"]
|
||||
tone = st.session_state["tone"]
|
||||
length = st.session_state["length"]
|
||||
hashtags = st.session_state["hashtags"]
|
||||
emojis = st.session_state["emojis"]
|
||||
engagement_boost = st.session_state["engagement_boost"]
|
||||
|
||||
# Create tweet object
|
||||
tweet = {
|
||||
"content": content,
|
||||
"tone": tone,
|
||||
"length": length,
|
||||
"hashtags": hashtags,
|
||||
"emojis": emojis,
|
||||
"engagement_score": engagement_boost,
|
||||
"metrics": {
|
||||
"Engagement": engagement_boost,
|
||||
"Reach": engagement_boost * 0.8,
|
||||
"Growth": engagement_boost * 0.6
|
||||
}
|
||||
}
|
||||
|
||||
# Add to tweets list
|
||||
st.session_state["tweets"].append(tweet)
|
||||
|
||||
# Show success message
|
||||
st.success("Tweet created successfully!")
|
||||
|
||||
def copy_tweet(self, tweet: Dict[str, Any]) -> None:
|
||||
"""Copy tweet to clipboard."""
|
||||
st.write("Tweet copied to clipboard!")
|
||||
|
||||
def save_tweet(self, tweet: Dict[str, Any]) -> None:
|
||||
"""Save tweet for later."""
|
||||
st.write("Tweet saved!")
|
||||
|
||||
def render(self) -> None:
|
||||
"""Render the complete dashboard."""
|
||||
# Render navigation
|
||||
self.sidebar.render()
|
||||
self.header.render()
|
||||
self.breadcrumbs.render()
|
||||
|
||||
# Render content based on current page
|
||||
if st.session_state["current_page"] == "dashboard":
|
||||
self.tabs.render()
|
||||
elif st.session_state["current_page"] == "tweet_generator":
|
||||
self.render_recent_tweets()
|
||||
elif st.session_state["current_page"] == "analytics":
|
||||
self.render_analytics()
|
||||
elif st.session_state["current_page"] == "settings":
|
||||
settings_form = SettingsForm(
|
||||
on_submit=self.handle_settings_submit
|
||||
)
|
||||
settings_form.render()
|
||||
|
||||
def handle_settings_submit(self) -> None:
|
||||
"""Handle settings form submission."""
|
||||
# Get form data
|
||||
api_key = st.session_state["api_key"]
|
||||
theme = st.session_state["theme"]
|
||||
notifications = st.session_state["notifications"]
|
||||
auto_save = st.session_state["auto_save"]
|
||||
language = st.session_state["language"]
|
||||
|
||||
# Save settings
|
||||
st.session_state["settings"] = {
|
||||
"api_key": api_key,
|
||||
"theme": theme,
|
||||
"notifications": notifications,
|
||||
"auto_save": auto_save,
|
||||
"language": language
|
||||
}
|
||||
|
||||
# Show success message
|
||||
st.success("Settings saved successfully!")
|
||||
|
||||
def main():
|
||||
"""Main entry point for the dashboard."""
|
||||
dashboard = TwitterDashboard()
|
||||
dashboard.render()
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,173 @@
|
||||
"""
|
||||
Theme configuration for Twitter UI components.
|
||||
Provides consistent styling across all Twitter-related features.
|
||||
"""
|
||||
|
||||
import streamlit as st
|
||||
from typing import Dict, Any
|
||||
|
||||
class Theme:
|
||||
"""Theme configuration for Twitter UI components."""
|
||||
|
||||
# Color palette
|
||||
COLORS = {
|
||||
"primary": "#1DA1F2", # Twitter blue
|
||||
"secondary": "#14171A", # Dark blue
|
||||
"background": "#15202B", # Dark background
|
||||
"text": "#FFFFFF", # White text
|
||||
"text_secondary": "#8899A6", # Gray text
|
||||
"success": "#17BF63", # Green
|
||||
"warning": "#FFAD1F", # Yellow
|
||||
"error": "#E0245E", # Red
|
||||
"border": "rgba(255, 255, 255, 0.1)", # Subtle border
|
||||
}
|
||||
|
||||
# Typography
|
||||
TYPOGRAPHY = {
|
||||
"font_family": "'Helvetica Neue', sans-serif",
|
||||
"font_sizes": {
|
||||
"h1": "2.5rem",
|
||||
"h2": "2rem",
|
||||
"h3": "1.5rem",
|
||||
"body": "1rem",
|
||||
"small": "0.875rem",
|
||||
},
|
||||
"font_weights": {
|
||||
"regular": 400,
|
||||
"medium": 500,
|
||||
"bold": 700,
|
||||
},
|
||||
}
|
||||
|
||||
# Spacing
|
||||
SPACING = {
|
||||
"xs": "0.25rem",
|
||||
"sm": "0.5rem",
|
||||
"md": "1rem",
|
||||
"lg": "1.5rem",
|
||||
"xl": "2rem",
|
||||
}
|
||||
|
||||
# Border radius
|
||||
BORDER_RADIUS = {
|
||||
"sm": "4px",
|
||||
"md": "8px",
|
||||
"lg": "12px",
|
||||
"xl": "16px",
|
||||
"full": "9999px",
|
||||
}
|
||||
|
||||
# Shadows
|
||||
SHADOWS = {
|
||||
"sm": "0 1px 2px rgba(0, 0, 0, 0.05)",
|
||||
"md": "0 4px 6px rgba(0, 0, 0, 0.1)",
|
||||
"lg": "0 10px 15px rgba(0, 0, 0, 0.1)",
|
||||
"xl": "0 20px 25px rgba(0, 0, 0, 0.15)",
|
||||
}
|
||||
|
||||
# Transitions
|
||||
TRANSITIONS = {
|
||||
"fast": "0.15s ease",
|
||||
"normal": "0.3s ease",
|
||||
"slow": "0.5s ease",
|
||||
}
|
||||
|
||||
@classmethod
|
||||
def get_css(cls) -> str:
|
||||
"""Get the complete CSS for the theme."""
|
||||
return f"""
|
||||
/* Base styles */
|
||||
.stApp {{
|
||||
background-color: {cls.COLORS['background']};
|
||||
color: {cls.COLORS['text']};
|
||||
font-family: {cls.TYPOGRAPHY['font_family']};
|
||||
}}
|
||||
|
||||
/* Typography */
|
||||
h1, h2, h3, h4, h5, h6 {{
|
||||
color: {cls.COLORS['text']};
|
||||
font-family: {cls.TYPOGRAPHY['font_family']};
|
||||
font-weight: {cls.TYPOGRAPHY['font_weights']['bold']};
|
||||
}}
|
||||
|
||||
/* Buttons */
|
||||
.stButton > button {{
|
||||
background: linear-gradient(45deg, {cls.COLORS['primary']}, #0C85D0);
|
||||
color: {cls.COLORS['text']};
|
||||
border: none;
|
||||
padding: {cls.SPACING['md']} {cls.SPACING['lg']};
|
||||
border-radius: {cls.BORDER_RADIUS['full']};
|
||||
font-weight: {cls.TYPOGRAPHY['font_weights']['medium']};
|
||||
transition: all {cls.TRANSITIONS['normal']};
|
||||
box-shadow: {cls.SHADOWS['md']};
|
||||
}}
|
||||
|
||||
.stButton > button:hover {{
|
||||
transform: translateY(-2px);
|
||||
box-shadow: {cls.SHADOWS['lg']};
|
||||
}}
|
||||
|
||||
/* Cards */
|
||||
.card {{
|
||||
background: rgba(255, 255, 255, 0.05);
|
||||
border: 1px solid {cls.COLORS['border']};
|
||||
border-radius: {cls.BORDER_RADIUS['lg']};
|
||||
padding: {cls.SPACING['lg']};
|
||||
margin-bottom: {cls.SPACING['md']};
|
||||
backdrop-filter: blur(10px);
|
||||
transition: transform {cls.TRANSITIONS['normal']};
|
||||
}}
|
||||
|
||||
.card:hover {{
|
||||
transform: translateY(-4px);
|
||||
}}
|
||||
|
||||
/* Forms */
|
||||
.stTextInput > div > div > input {{
|
||||
background-color: rgba(255, 255, 255, 0.05);
|
||||
border: 1px solid {cls.COLORS['border']};
|
||||
border-radius: {cls.BORDER_RADIUS['md']};
|
||||
color: {cls.COLORS['text']};
|
||||
padding: {cls.SPACING['md']};
|
||||
}}
|
||||
|
||||
/* Tabs */
|
||||
.stTabs [data-baseweb="tab-list"] {{
|
||||
gap: {cls.SPACING['sm']};
|
||||
background-color: rgba(0, 0, 0, 0.2);
|
||||
padding: {cls.SPACING['md']};
|
||||
border-radius: {cls.BORDER_RADIUS['lg']};
|
||||
}}
|
||||
|
||||
.stTabs [data-baseweb="tab"] {{
|
||||
background-color: transparent;
|
||||
color: {cls.COLORS['text']};
|
||||
border: 1px solid {cls.COLORS['border']};
|
||||
border-radius: {cls.BORDER_RADIUS['md']};
|
||||
padding: {cls.SPACING['sm']} {cls.SPACING['md']};
|
||||
}}
|
||||
|
||||
/* Status badges */
|
||||
.status-badge {{
|
||||
display: inline-block;
|
||||
padding: {cls.SPACING['xs']} {cls.SPACING['md']};
|
||||
border-radius: {cls.BORDER_RADIUS['full']};
|
||||
font-size: {cls.TYPOGRAPHY['font_sizes']['small']};
|
||||
font-weight: {cls.TYPOGRAPHY['font_weights']['medium']};
|
||||
}}
|
||||
|
||||
.status-active {{
|
||||
background: linear-gradient(45deg, {cls.COLORS['success']}, #69F0AE);
|
||||
color: {cls.COLORS['secondary']};
|
||||
}}
|
||||
|
||||
.status-coming-soon {{
|
||||
background: linear-gradient(45deg, {cls.COLORS['warning']}, #FFA000);
|
||||
color: {cls.COLORS['secondary']};
|
||||
}}
|
||||
"""
|
||||
|
||||
@classmethod
|
||||
def apply(cls) -> None:
|
||||
"""Apply the theme to the Streamlit app."""
|
||||
st.markdown(f"<style>{cls.get_css()}</style>", unsafe_allow_html=True)
|
||||
@@ -0,0 +1,503 @@
|
||||
"""
|
||||
Enhanced Twitter Dashboard with real authentication and posting capabilities.
|
||||
"""
|
||||
|
||||
import streamlit as st
|
||||
import asyncio
|
||||
from datetime import datetime, timedelta
|
||||
import json
|
||||
from typing import Dict, Any, List, Optional
|
||||
|
||||
# Import our enhanced components
|
||||
from .components.navigation import TwitterNavigation, create_main_navigation
|
||||
from .components.cards import TwitterCard, create_analytics_card, create_tweet_card
|
||||
from .components.forms import TweetForm, TwitterConfigForm
|
||||
from ..tweet_generator.smart_tweet_generator import (
|
||||
smart_tweet_generator,
|
||||
post_tweet_to_twitter,
|
||||
get_real_tweet_analytics,
|
||||
render_twitter_authentication
|
||||
)
|
||||
from ....integrations.twitter_auth_bridge import (
|
||||
TwitterAuthBridge,
|
||||
save_twitter_credentials,
|
||||
load_twitter_credentials,
|
||||
is_twitter_authenticated,
|
||||
setup_twitter_session,
|
||||
clear_twitter_session
|
||||
)
|
||||
|
||||
# Initialize authentication bridge
|
||||
auth_bridge = TwitterAuthBridge()
|
||||
|
||||
def initialize_dashboard():
|
||||
"""Initialize the Twitter dashboard with proper styling and state management."""
|
||||
|
||||
# Apply custom CSS
|
||||
st.markdown("""
|
||||
<style>
|
||||
.main-dashboard {
|
||||
padding: 1rem;
|
||||
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
|
||||
min-height: 100vh;
|
||||
}
|
||||
|
||||
.dashboard-header {
|
||||
background: white;
|
||||
padding: 2rem;
|
||||
border-radius: 15px;
|
||||
box-shadow: 0 10px 30px rgba(0,0,0,0.1);
|
||||
margin-bottom: 2rem;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.dashboard-title {
|
||||
font-size: 2.5rem;
|
||||
font-weight: 700;
|
||||
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
|
||||
-webkit-background-clip: text;
|
||||
-webkit-text-fill-color: transparent;
|
||||
margin-bottom: 0.5rem;
|
||||
}
|
||||
|
||||
.dashboard-subtitle {
|
||||
color: #666;
|
||||
font-size: 1.1rem;
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
|
||||
.status-indicator {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
padding: 0.5rem 1rem;
|
||||
border-radius: 25px;
|
||||
font-weight: 500;
|
||||
font-size: 0.9rem;
|
||||
}
|
||||
|
||||
.status-connected {
|
||||
background: #d4edda;
|
||||
color: #155724;
|
||||
border: 1px solid #c3e6cb;
|
||||
}
|
||||
|
||||
.status-disconnected {
|
||||
background: #f8d7da;
|
||||
color: #721c24;
|
||||
border: 1px solid #f5c6cb;
|
||||
}
|
||||
|
||||
.dashboard-grid {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr 1fr;
|
||||
gap: 2rem;
|
||||
margin-bottom: 2rem;
|
||||
}
|
||||
|
||||
@media (max-width: 768px) {
|
||||
.dashboard-grid {
|
||||
grid-template-columns: 1fr;
|
||||
}
|
||||
}
|
||||
|
||||
.action-button {
|
||||
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
|
||||
color: white;
|
||||
border: none;
|
||||
padding: 0.75rem 1.5rem;
|
||||
border-radius: 8px;
|
||||
font-weight: 600;
|
||||
cursor: pointer;
|
||||
transition: all 0.3s ease;
|
||||
}
|
||||
|
||||
.action-button:hover {
|
||||
transform: translateY(-2px);
|
||||
box-shadow: 0 5px 15px rgba(102, 126, 234, 0.4);
|
||||
}
|
||||
|
||||
.metrics-grid {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
|
||||
gap: 1rem;
|
||||
margin: 1rem 0;
|
||||
}
|
||||
|
||||
.metric-card {
|
||||
background: white;
|
||||
padding: 1.5rem;
|
||||
border-radius: 10px;
|
||||
box-shadow: 0 5px 15px rgba(0,0,0,0.1);
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.metric-value {
|
||||
font-size: 2rem;
|
||||
font-weight: 700;
|
||||
color: #667eea;
|
||||
margin-bottom: 0.5rem;
|
||||
}
|
||||
|
||||
.metric-label {
|
||||
color: #666;
|
||||
font-size: 0.9rem;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.5px;
|
||||
}
|
||||
</style>
|
||||
""", unsafe_allow_html=True)
|
||||
|
||||
# Initialize session state
|
||||
if 'twitter_dashboard_initialized' not in st.session_state:
|
||||
st.session_state.twitter_dashboard_initialized = True
|
||||
st.session_state.current_page = 'dashboard'
|
||||
st.session_state.tweet_drafts = []
|
||||
st.session_state.posted_tweets = []
|
||||
st.session_state.analytics_data = {}
|
||||
|
||||
def render_dashboard_header():
|
||||
"""Render the main dashboard header with connection status."""
|
||||
|
||||
st.markdown('<div class="dashboard-header">', unsafe_allow_html=True)
|
||||
|
||||
col1, col2, col3 = st.columns([1, 2, 1])
|
||||
|
||||
with col2:
|
||||
st.markdown('<h1 class="dashboard-title">🐦 Twitter AI Dashboard</h1>', unsafe_allow_html=True)
|
||||
st.markdown('<p class="dashboard-subtitle">AI-Powered Tweet Generation & Analytics</p>', unsafe_allow_html=True)
|
||||
|
||||
# Connection status
|
||||
is_connected = is_twitter_authenticated()
|
||||
|
||||
if is_connected:
|
||||
user_info = st.session_state.get('twitter_user', {})
|
||||
username = user_info.get('screen_name', 'Unknown')
|
||||
st.markdown(f'''
|
||||
<div class="status-indicator status-connected">
|
||||
✅ Connected as @{username}
|
||||
</div>
|
||||
''', unsafe_allow_html=True)
|
||||
else:
|
||||
st.markdown('''
|
||||
<div class="status-indicator status-disconnected">
|
||||
❌ Not Connected to Twitter
|
||||
</div>
|
||||
''', unsafe_allow_html=True)
|
||||
|
||||
st.markdown('</div>', unsafe_allow_html=True)
|
||||
|
||||
def render_quick_actions():
|
||||
"""Render quick action buttons."""
|
||||
|
||||
st.markdown("### 🚀 Quick Actions")
|
||||
|
||||
col1, col2, col3, col4 = st.columns(4)
|
||||
|
||||
with col1:
|
||||
if st.button("📝 Generate Tweet", key="quick_generate", help="Create AI-powered tweets"):
|
||||
st.session_state.current_page = 'generate'
|
||||
st.rerun()
|
||||
|
||||
with col2:
|
||||
if st.button("📊 View Analytics", key="quick_analytics", help="View tweet performance"):
|
||||
st.session_state.current_page = 'analytics'
|
||||
st.rerun()
|
||||
|
||||
with col3:
|
||||
if st.button("⚙️ Settings", key="quick_settings", help="Configure Twitter connection"):
|
||||
st.session_state.current_page = 'settings'
|
||||
st.rerun()
|
||||
|
||||
with col4:
|
||||
if st.button("📋 Drafts", key="quick_drafts", help="Manage tweet drafts"):
|
||||
st.session_state.current_page = 'drafts'
|
||||
st.rerun()
|
||||
|
||||
def render_dashboard_overview():
|
||||
"""Render the main dashboard overview with metrics."""
|
||||
|
||||
if not is_twitter_authenticated():
|
||||
st.warning("⚠️ Please connect your Twitter account to view dashboard metrics.")
|
||||
if st.button("Connect Twitter Account", type="primary"):
|
||||
st.session_state.current_page = 'settings'
|
||||
st.rerun()
|
||||
return
|
||||
|
||||
# Get user metrics
|
||||
user_info = st.session_state.get('twitter_user', {})
|
||||
|
||||
# Display metrics
|
||||
st.markdown("### 📈 Account Overview")
|
||||
|
||||
col1, col2, col3, col4 = st.columns(4)
|
||||
|
||||
with col1:
|
||||
st.markdown(f'''
|
||||
<div class="metric-card">
|
||||
<div class="metric-value">{user_info.get('followers_count', 0):,}</div>
|
||||
<div class="metric-label">Followers</div>
|
||||
</div>
|
||||
''', unsafe_allow_html=True)
|
||||
|
||||
with col2:
|
||||
st.markdown(f'''
|
||||
<div class="metric-card">
|
||||
<div class="metric-value">{user_info.get('friends_count', 0):,}</div>
|
||||
<div class="metric-label">Following</div>
|
||||
</div>
|
||||
''', unsafe_allow_html=True)
|
||||
|
||||
with col3:
|
||||
posted_count = len(st.session_state.get('posted_tweets', []))
|
||||
st.markdown(f'''
|
||||
<div class="metric-card">
|
||||
<div class="metric-value">{posted_count}</div>
|
||||
<div class="metric-label">Posted Today</div>
|
||||
</div>
|
||||
''', unsafe_allow_html=True)
|
||||
|
||||
with col4:
|
||||
draft_count = len(st.session_state.get('tweet_drafts', []))
|
||||
st.markdown(f'''
|
||||
<div class="metric-card">
|
||||
<div class="metric-value">{draft_count}</div>
|
||||
<div class="metric-label">Drafts</div>
|
||||
</div>
|
||||
''', unsafe_allow_html=True)
|
||||
|
||||
# Recent activity
|
||||
st.markdown("### 📝 Recent Activity")
|
||||
|
||||
recent_tweets = st.session_state.get('posted_tweets', [])[-5:] # Last 5 tweets
|
||||
|
||||
if recent_tweets:
|
||||
for tweet in reversed(recent_tweets):
|
||||
with st.expander(f"Tweet: {tweet.get('text', '')[:50]}..."):
|
||||
col1, col2 = st.columns([2, 1])
|
||||
|
||||
with col1:
|
||||
st.write(f"**Text:** {tweet.get('text', '')}")
|
||||
st.write(f"**Posted:** {tweet.get('created_at', '')}")
|
||||
|
||||
if tweet.get('metrics'):
|
||||
metrics = tweet['metrics']
|
||||
st.write(f"**Engagement:** {metrics.get('favorite_count', 0)} likes, "
|
||||
f"{metrics.get('retweet_count', 0)} retweets")
|
||||
|
||||
with col2:
|
||||
if st.button(f"View Analytics", key=f"analytics_{tweet.get('id')}"):
|
||||
st.session_state.selected_tweet_id = tweet.get('id')
|
||||
st.session_state.current_page = 'analytics'
|
||||
st.rerun()
|
||||
else:
|
||||
st.info("No recent tweets found. Start by generating and posting some content!")
|
||||
|
||||
def render_settings_page():
|
||||
"""Render the settings page for Twitter configuration."""
|
||||
|
||||
st.markdown("### ⚙️ Twitter Configuration")
|
||||
|
||||
# Twitter Authentication Section
|
||||
with st.expander("🔐 Twitter API Configuration", expanded=not is_twitter_authenticated()):
|
||||
render_twitter_authentication()
|
||||
|
||||
# Account Information
|
||||
if is_twitter_authenticated():
|
||||
st.markdown("### 👤 Account Information")
|
||||
|
||||
user_info = st.session_state.get('twitter_user', {})
|
||||
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
st.write(f"**Username:** @{user_info.get('screen_name', 'N/A')}")
|
||||
st.write(f"**Display Name:** {user_info.get('name', 'N/A')}")
|
||||
st.write(f"**Followers:** {user_info.get('followers_count', 0):,}")
|
||||
|
||||
with col2:
|
||||
st.write(f"**Following:** {user_info.get('friends_count', 0):,}")
|
||||
st.write(f"**Tweets:** {user_info.get('statuses_count', 0):,}")
|
||||
st.write(f"**Account Created:** {user_info.get('created_at', 'N/A')}")
|
||||
|
||||
# Disconnect option
|
||||
st.markdown("---")
|
||||
if st.button("🔓 Disconnect Twitter Account", type="secondary"):
|
||||
clear_twitter_session()
|
||||
st.success("Twitter account disconnected successfully!")
|
||||
st.rerun()
|
||||
|
||||
def render_analytics_page():
|
||||
"""Render the analytics page with real Twitter metrics."""
|
||||
|
||||
st.markdown("### 📊 Tweet Analytics")
|
||||
|
||||
if not is_twitter_authenticated():
|
||||
st.warning("Please connect your Twitter account to view analytics.")
|
||||
return
|
||||
|
||||
# Tweet selection
|
||||
posted_tweets = st.session_state.get('posted_tweets', [])
|
||||
|
||||
if not posted_tweets:
|
||||
st.info("No tweets found. Generate and post some tweets to see analytics!")
|
||||
return
|
||||
|
||||
# Select tweet for analysis
|
||||
tweet_options = {
|
||||
f"{tweet.get('text', '')[:50]}... ({tweet.get('created_at', '')})": tweet.get('id')
|
||||
for tweet in posted_tweets
|
||||
}
|
||||
|
||||
selected_tweet_text = st.selectbox(
|
||||
"Select a tweet to analyze:",
|
||||
options=list(tweet_options.keys())
|
||||
)
|
||||
|
||||
if selected_tweet_text:
|
||||
tweet_id = tweet_options[selected_tweet_text]
|
||||
|
||||
# Get analytics
|
||||
with st.spinner("Loading analytics..."):
|
||||
analytics_result = asyncio.run(get_real_tweet_analytics(tweet_id))
|
||||
|
||||
if analytics_result.get('success'):
|
||||
analytics_data = analytics_result['data']
|
||||
|
||||
# Display metrics
|
||||
st.markdown("#### 📈 Performance Metrics")
|
||||
|
||||
col1, col2, col3, col4 = st.columns(4)
|
||||
|
||||
metrics = analytics_data.get('metrics', {})
|
||||
|
||||
with col1:
|
||||
st.metric("Likes", metrics.get('likes', 0))
|
||||
|
||||
with col2:
|
||||
st.metric("Retweets", metrics.get('retweets', 0))
|
||||
|
||||
with col3:
|
||||
st.metric("Replies", metrics.get('replies', 0))
|
||||
|
||||
with col4:
|
||||
engagement = analytics_data.get('engagement', {})
|
||||
st.metric("Engagement Rate", f"{engagement.get('engagement_rate', 0):.2f}%")
|
||||
|
||||
# Detailed analytics
|
||||
st.markdown("#### 🔍 Detailed Analysis")
|
||||
|
||||
col1, col2 = st.columns(2)
|
||||
|
||||
with col1:
|
||||
st.markdown("**Engagement Breakdown:**")
|
||||
total_engagement = metrics.get('total_engagement', 0)
|
||||
st.write(f"• Total Engagement: {total_engagement}")
|
||||
st.write(f"• Likes Rate: {engagement.get('likes_rate', 0):.2f}%")
|
||||
st.write(f"• Retweets Rate: {engagement.get('retweets_rate', 0):.2f}%")
|
||||
|
||||
with col2:
|
||||
st.markdown("**Content Analysis:**")
|
||||
content_analysis = analytics_data.get('content_analysis', {})
|
||||
st.write(f"• Character Count: {content_analysis.get('character_count', 0)}")
|
||||
st.write(f"• Hashtags: {content_analysis.get('hashtag_count', 0)}")
|
||||
st.write(f"• Mentions: {content_analysis.get('mention_count', 0)}")
|
||||
|
||||
# Timing analysis
|
||||
timing = analytics_data.get('timing', {})
|
||||
if timing:
|
||||
st.markdown("#### ⏰ Timing Analysis")
|
||||
st.write(f"• Posted: {timing.get('posted_at', 'N/A')}")
|
||||
st.write(f"• Age: {timing.get('age_hours', 0):.1f} hours")
|
||||
st.write(f"• Peak Period: {timing.get('peak_engagement_period', 'N/A')}")
|
||||
st.write(f"• Engagement Velocity: {timing.get('engagement_velocity', 0):.2f} per hour")
|
||||
|
||||
else:
|
||||
st.error(f"Failed to load analytics: {analytics_result.get('error', 'Unknown error')}")
|
||||
|
||||
def render_drafts_page():
|
||||
"""Render the drafts management page."""
|
||||
|
||||
st.markdown("### 📋 Tweet Drafts")
|
||||
|
||||
drafts = st.session_state.get('tweet_drafts', [])
|
||||
|
||||
if not drafts:
|
||||
st.info("No drafts found. Create some tweets in the generator to save as drafts!")
|
||||
return
|
||||
|
||||
for i, draft in enumerate(drafts):
|
||||
with st.expander(f"Draft {i+1}: {draft.get('text', '')[:50]}..."):
|
||||
col1, col2 = st.columns([3, 1])
|
||||
|
||||
with col1:
|
||||
st.write(f"**Text:** {draft.get('text', '')}")
|
||||
st.write(f"**Created:** {draft.get('created_at', '')}")
|
||||
if draft.get('hashtags'):
|
||||
st.write(f"**Hashtags:** {', '.join(draft['hashtags'])}")
|
||||
|
||||
with col2:
|
||||
if st.button(f"Post Now", key=f"post_draft_{i}"):
|
||||
if is_twitter_authenticated():
|
||||
with st.spinner("Posting tweet..."):
|
||||
result = asyncio.run(post_tweet_to_twitter(draft))
|
||||
|
||||
if result.get('success'):
|
||||
st.success("Tweet posted successfully!")
|
||||
# Move from drafts to posted
|
||||
st.session_state.posted_tweets.append(result['data'])
|
||||
st.session_state.tweet_drafts.pop(i)
|
||||
st.rerun()
|
||||
else:
|
||||
st.error(f"Failed to post: {result.get('error')}")
|
||||
else:
|
||||
st.error("Please connect your Twitter account first!")
|
||||
|
||||
if st.button(f"Delete", key=f"delete_draft_{i}"):
|
||||
st.session_state.tweet_drafts.pop(i)
|
||||
st.rerun()
|
||||
|
||||
def main_twitter_dashboard():
|
||||
"""Main Twitter dashboard function."""
|
||||
|
||||
# Initialize dashboard
|
||||
initialize_dashboard()
|
||||
|
||||
# Create navigation
|
||||
nav = TwitterNavigation()
|
||||
current_page = nav.render_main_navigation()
|
||||
|
||||
# Update session state if page changed
|
||||
if current_page != st.session_state.get('current_page'):
|
||||
st.session_state.current_page = current_page
|
||||
|
||||
# Render dashboard header
|
||||
render_dashboard_header()
|
||||
|
||||
# Route to appropriate page
|
||||
page = st.session_state.get('current_page', 'dashboard')
|
||||
|
||||
if page == 'dashboard':
|
||||
render_quick_actions()
|
||||
render_dashboard_overview()
|
||||
|
||||
elif page == 'generate':
|
||||
st.markdown("### 🤖 AI Tweet Generator")
|
||||
smart_tweet_generator()
|
||||
|
||||
elif page == 'analytics':
|
||||
render_analytics_page()
|
||||
|
||||
elif page == 'settings':
|
||||
render_settings_page()
|
||||
|
||||
elif page == 'drafts':
|
||||
render_drafts_page()
|
||||
|
||||
else:
|
||||
# Default to dashboard
|
||||
render_quick_actions()
|
||||
render_dashboard_overview()
|
||||
|
||||
if __name__ == "__main__":
|
||||
main_twitter_dashboard()
|
||||
@@ -0,0 +1,194 @@
|
||||
"""
|
||||
Utility functions for Twitter UI.
|
||||
Provides helper functions for common operations.
|
||||
"""
|
||||
|
||||
import streamlit as st
|
||||
from typing import Dict, Any, List, Optional
|
||||
import json
|
||||
import os
|
||||
from datetime import datetime
|
||||
|
||||
def save_to_session(key: str, value: Any) -> None:
|
||||
"""Save a value to the session state."""
|
||||
st.session_state[key] = value
|
||||
|
||||
def get_from_session(key: str, default: Any = None) -> Any:
|
||||
"""Get a value from the session state."""
|
||||
return st.session_state.get(key, default)
|
||||
|
||||
def clear_session() -> None:
|
||||
"""Clear all session state variables."""
|
||||
for key in list(st.session_state.keys()):
|
||||
del st.session_state[key]
|
||||
|
||||
def save_to_file(data: Dict[str, Any], filename: str) -> None:
|
||||
"""Save data to a JSON file."""
|
||||
try:
|
||||
with open(filename, 'w') as f:
|
||||
json.dump(data, f, indent=4)
|
||||
except Exception as e:
|
||||
st.error(f"Error saving data: {str(e)}")
|
||||
|
||||
def load_from_file(filename: str) -> Optional[Dict[str, Any]]:
|
||||
"""Load data from a JSON file."""
|
||||
try:
|
||||
if os.path.exists(filename):
|
||||
with open(filename, 'r') as f:
|
||||
return json.load(f)
|
||||
except Exception as e:
|
||||
st.error(f"Error loading data: {str(e)}")
|
||||
return None
|
||||
|
||||
def format_datetime(dt: datetime) -> str:
|
||||
"""Format a datetime object for display."""
|
||||
return dt.strftime("%Y-%m-%d %H:%M:%S")
|
||||
|
||||
def parse_datetime(dt_str: str) -> Optional[datetime]:
|
||||
"""Parse a datetime string."""
|
||||
try:
|
||||
return datetime.strptime(dt_str, "%Y-%m-%d %H:%M:%S")
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
def validate_tweet_content(content: str) -> bool:
|
||||
"""Validate tweet content."""
|
||||
if not content:
|
||||
st.error("Tweet content cannot be empty")
|
||||
return False
|
||||
if len(content) > 280:
|
||||
st.error("Tweet content cannot exceed 280 characters")
|
||||
return False
|
||||
return True
|
||||
|
||||
def validate_hashtags(hashtags: List[str]) -> bool:
|
||||
"""Validate hashtags."""
|
||||
for tag in hashtags:
|
||||
if not tag.startswith('#'):
|
||||
st.error(f"Hashtag {tag} must start with #")
|
||||
return False
|
||||
if len(tag) > 30:
|
||||
st.error(f"Hashtag {tag} cannot exceed 30 characters")
|
||||
return False
|
||||
return True
|
||||
|
||||
def validate_emojis(emojis: List[str]) -> bool:
|
||||
"""Validate emojis."""
|
||||
for emoji in emojis:
|
||||
if len(emoji) != 1:
|
||||
st.error(f"Invalid emoji: {emoji}")
|
||||
return False
|
||||
return True
|
||||
|
||||
def calculate_engagement_score(
|
||||
content: str,
|
||||
hashtags: List[str],
|
||||
emojis: List[str],
|
||||
tone: str
|
||||
) -> float:
|
||||
"""Calculate engagement score for a tweet."""
|
||||
score = 0.0
|
||||
|
||||
# Content length score (optimal length is 100-150 characters)
|
||||
content_length = len(content)
|
||||
if 100 <= content_length <= 150:
|
||||
score += 30
|
||||
elif 50 <= content_length <= 200:
|
||||
score += 20
|
||||
else:
|
||||
score += 10
|
||||
|
||||
# Hashtag score (optimal number is 2-3 hashtags)
|
||||
hashtag_count = len(hashtags)
|
||||
if 2 <= hashtag_count <= 3:
|
||||
score += 20
|
||||
elif 1 <= hashtag_count <= 4:
|
||||
score += 15
|
||||
else:
|
||||
score += 5
|
||||
|
||||
# Emoji score (optimal number is 1-2 emojis)
|
||||
emoji_count = len(emojis)
|
||||
if 1 <= emoji_count <= 2:
|
||||
score += 20
|
||||
elif 0 <= emoji_count <= 3:
|
||||
score += 15
|
||||
else:
|
||||
score += 5
|
||||
|
||||
# Tone score
|
||||
tone_scores = {
|
||||
"professional": 15,
|
||||
"casual": 20,
|
||||
"humorous": 25,
|
||||
"informative": 15,
|
||||
"inspirational": 20
|
||||
}
|
||||
score += tone_scores.get(tone, 10)
|
||||
|
||||
return min(score, 100)
|
||||
|
||||
def generate_tweet_metrics(engagement_score: float) -> Dict[str, float]:
|
||||
"""Generate metrics for a tweet based on engagement score."""
|
||||
return {
|
||||
"Engagement": engagement_score,
|
||||
"Reach": engagement_score * 0.8,
|
||||
"Growth": engagement_score * 0.6
|
||||
}
|
||||
|
||||
def copy_to_clipboard(text: str) -> None:
|
||||
"""Copy text to clipboard."""
|
||||
try:
|
||||
st.write(f'<script>navigator.clipboard.writeText("{text}")</script>', unsafe_allow_html=True)
|
||||
except Exception as e:
|
||||
st.error(f"Error copying to clipboard: {str(e)}")
|
||||
|
||||
def show_success_message(message: str) -> None:
|
||||
"""Show a success message."""
|
||||
st.success(message)
|
||||
|
||||
def show_error_message(message: str) -> None:
|
||||
"""Show an error message."""
|
||||
st.error(message)
|
||||
|
||||
def show_info_message(message: str) -> None:
|
||||
"""Show an info message."""
|
||||
st.info(message)
|
||||
|
||||
def show_warning_message(message: str) -> None:
|
||||
"""Show a warning message."""
|
||||
st.warning(message)
|
||||
|
||||
def create_download_button(
|
||||
data: Dict[str, Any],
|
||||
filename: str,
|
||||
button_text: str = "Download"
|
||||
) -> None:
|
||||
"""Create a download button for data."""
|
||||
try:
|
||||
json_str = json.dumps(data, indent=4)
|
||||
st.download_button(
|
||||
label=button_text,
|
||||
data=json_str,
|
||||
file_name=filename,
|
||||
mime="application/json"
|
||||
)
|
||||
except Exception as e:
|
||||
st.error(f"Error creating download button: {str(e)}")
|
||||
|
||||
def create_upload_button(
|
||||
on_upload: callable,
|
||||
button_text: str = "Upload",
|
||||
file_types: List[str] = ["json"]
|
||||
) -> None:
|
||||
"""Create an upload button for data."""
|
||||
try:
|
||||
uploaded_file = st.file_uploader(
|
||||
button_text,
|
||||
type=file_types
|
||||
)
|
||||
if uploaded_file is not None:
|
||||
data = json.load(uploaded_file)
|
||||
on_upload(data)
|
||||
except Exception as e:
|
||||
st.error(f"Error handling upload: {str(e)}")
|
||||
121
ToBeMigrated/ai_writers/web_url_ai_writer.py
Normal file
121
ToBeMigrated/ai_writers/web_url_ai_writer.py
Normal file
@@ -0,0 +1,121 @@
|
||||
import sys
|
||||
import os
|
||||
|
||||
from textwrap import dedent
|
||||
import json
|
||||
from pathlib import Path
|
||||
from datetime import datetime
|
||||
import streamlit as st
|
||||
|
||||
from dotenv import load_dotenv
|
||||
load_dotenv(Path('../../.env'))
|
||||
from loguru import logger
|
||||
logger.remove()
|
||||
logger.add(sys.stdout,
|
||||
colorize=True,
|
||||
format="<level>{level}</level>|<green>{file}:{line}:{function}</green>| {message}"
|
||||
)
|
||||
|
||||
from ..ai_web_researcher.firecrawl_web_crawler import scrape_url
|
||||
from ..blog_metadata.get_blog_metadata import blog_metadata, run_async
|
||||
from ..blog_postprocessing.save_blog_to_file import save_blog_to_file
|
||||
from ..gpt_providers.text_to_image_generation.main_generate_image_from_prompt import generate_image
|
||||
from ..gpt_providers.text_generation.main_text_generation import llm_text_gen
|
||||
|
||||
|
||||
def blog_from_url(weburl):
|
||||
"""
|
||||
This function will take a blog Topic to first generate sections for it
|
||||
and then generate content for each section.
|
||||
"""
|
||||
# Use to store the blog in a string, to save in a *.md file.
|
||||
blog_markdown_str = None
|
||||
tavily_search_result = None
|
||||
# Initializing the variables
|
||||
blog_title = None
|
||||
blog_meta_desc = None
|
||||
blog_tags = None
|
||||
blog_categories = None
|
||||
|
||||
logger.info(f"Researching and Writing Blog on: {weburl}")
|
||||
with st.status("Started Writing..", expanded=True) as status:
|
||||
st.empty()
|
||||
status.update(label=f"Researching and Writing Blog on: {weburl}")
|
||||
try:
|
||||
scraped_text = scrape_url(weburl)
|
||||
#logger.info(scraped_text)
|
||||
except Exception as err:
|
||||
st.error(f"Failed to scrape web page from url-{weburl} - Error: {err}")
|
||||
logger.error(f"Failed in web research: {err}")
|
||||
st.stop()
|
||||
status.update(label=f"Successfully Scraped/Fetched url: {weburl}", expanded=False, state="complete")
|
||||
|
||||
with st.status(f"Started Writing blog from {weburl}..", expanded=True) as status:
|
||||
# Do Tavily AI research to augument the above blog.
|
||||
try:
|
||||
blog_markdown_str = write_blog_from_weburl(scraped_text)
|
||||
status.update(label="Finished Writing Blog From: {weburl}")
|
||||
except Exception as err:
|
||||
logger.error(f"Failed to write blog from: {weburl}")
|
||||
st.error(f"Failed to write blog from: {weburl}")
|
||||
st.stop()
|
||||
|
||||
try:
|
||||
status.update(label="🙎 Generating - Title, Meta Description, Tags, Categories for the content.")
|
||||
blog_title, blog_meta_desc, blog_tags, blog_categories = run_async(blog_metadata(blog_markdown_str))
|
||||
except Exception as err:
|
||||
st.error(f"Failed to get blog metadata: {err}")
|
||||
|
||||
try:
|
||||
status.update(label="🙎 Generating Image for the new blog.")
|
||||
generated_image_filepath = generate_image(f"{blog_title} + ' ' + {blog_meta_desc}")
|
||||
except Exception as err:
|
||||
st.warning(f"Failed in Image generation: {err}")
|
||||
|
||||
saved_blog_to_file = save_blog_to_file(blog_markdown_str, blog_title, blog_meta_desc,
|
||||
blog_tags, blog_categories, generated_image_filepath)
|
||||
status.update(label=f"Saved the content in this file: {saved_blog_to_file}")
|
||||
|
||||
logger.info(f"\n\n --------- Finished writing Blog for : {weburl} -------------- \n")
|
||||
if generated_image_filepath:
|
||||
st.image(generated_image_filepath)
|
||||
|
||||
st.markdown(f"{blog_markdown_str}")
|
||||
status.update(label=f"Finished, Review & Use your Original Content Below: {saved_blog_to_file}", state="complete")
|
||||
|
||||
|
||||
def write_blog_from_weburl(scraped_website):
|
||||
"""Combine the given online research and GPT blog content"""
|
||||
try:
|
||||
config_path = Path(os.environ["ALWRITY_CONFIG"])
|
||||
with open(config_path, 'r', encoding='utf-8') as file:
|
||||
config = json.load(file)
|
||||
except Exception as err:
|
||||
logger.error(f"Error: Failed to read values from config: {err}")
|
||||
exit(1)
|
||||
|
||||
blog_characteristics = config['Blog Content Characteristics']
|
||||
|
||||
prompt = f"""
|
||||
As expert Creative Content writer, I will provide you with scraped website content.
|
||||
I want you to write a detailed {blog_characteristics['Blog Type']} blog post including 5 FAQs.
|
||||
|
||||
Below are the guidelines to follow:
|
||||
1). You must respond in {blog_characteristics['Blog Language']} language.
|
||||
2). Tone and Brand Alignment: Adjust your tone, voice, personality for {blog_characteristics['Blog Tone']} audience.
|
||||
3). Make sure your response content length is of {blog_characteristics['Blog Length']} words.
|
||||
4). Include FAQs from 'People also Ask' section of provided context 'google search result'.
|
||||
|
||||
I want the post to offer unique insights, relatable examples, and a fresh perspective on the topic.
|
||||
\n\n
|
||||
Website Content:
|
||||
'''{scraped_website}'''
|
||||
"""
|
||||
logger.info("Generating blog and FAQs from Google web search results.")
|
||||
|
||||
try:
|
||||
response = llm_text_gen(prompt)
|
||||
return response
|
||||
except Exception as err:
|
||||
logger.error(f"Exit: Failed to get response from LLM: {err}")
|
||||
exit(1)
|
||||
@@ -351,27 +351,3 @@ If you encounter issues:
|
||||
---
|
||||
|
||||
**Happy coding! 🎉**
|
||||
|
||||
## Backlink Outreach Migration Map
|
||||
|
||||
Canonical migrated backlinking module paths:
|
||||
|
||||
- Router: `backend/routers/backlink_outreach.py`
|
||||
- Service: `backend/services/backlink_outreach_service.py`
|
||||
- Frontend API client: `frontend/src/api/backlinkOutreachApi.ts`
|
||||
- Frontend store: `frontend/src/stores/backlinkOutreachStore.ts`
|
||||
- Frontend UI integration: `frontend/src/components/SEODashboard/BacklinkOutreachModuleList.tsx`
|
||||
|
||||
Invoke from backend:
|
||||
|
||||
- `GET /api/backlink-outreach/modules`
|
||||
- `GET /api/backlink-outreach/query-templates?keyword=<keyword>`
|
||||
- `GET /api/backlink-outreach/migration-coverage`
|
||||
- `POST /api/backlink-outreach/discover` with JSON body: `{ "keyword": "...", "max_results": 10 }`
|
||||
- `POST /api/backlink-outreach/policy-validate` to enforce compliance/suppression/throttles before send
|
||||
- `GET /api/backlink-outreach/reporting` for send-volume and conversion snapshot
|
||||
- `POST /api/backlink-outreach/campaigns` and `GET /api/backlink-outreach/campaigns` for persisted campaign records (campaign-creator style storage flow)
|
||||
|
||||
The modules endpoint returns migration identifiers: `backlink`, `outreach`, and `guest_post`.
|
||||
The query-template endpoint mirrors legacy `generate_search_queries(...)` behavior from `ToBeMigrated/ai_marketing_tools/ai_backlinker/ai_backlinking.py`.
|
||||
The migration-coverage endpoint summarizes what is already implemented vs planned from the legacy prototype roadmap.
|
||||
|
||||
@@ -18,9 +18,8 @@ CORE_ROUTER_REGISTRY = [
|
||||
{"name": "step3_research", "module": "api.onboarding_utils.step3_routes", "attr": "router", "features": {"all", "core"}},
|
||||
{"name": "step4_assets", "module": "api.onboarding_utils.step4_asset_routes", "attr": "router", "features": {"all", "core", "podcast"}},
|
||||
{"name": "step4_persona", "module": "api.onboarding_utils.step4_persona_routes_optimized", "attr": "router", "features": {"all", "core"}},
|
||||
{"name": "gsc_auth", "module": "routers.gsc_auth", "attr": "router", "features": {"all", "core", "seo", "blog_writer"}},
|
||||
{"name": "wordpress", "module": "routers.wordpress", "attr": "router", "features": {"all", "core", "blog_writer"}},
|
||||
{"name": "wordpress_oauth", "module": "routers.wordpress_oauth", "attr": "router", "features": {"all", "core", "blog_writer"}},
|
||||
{"name": "gsc_auth", "module": "routers.gsc_auth", "attr": "router", "features": {"all", "core", "seo"}},
|
||||
{"name": "wordpress_oauth", "module": "routers.wordpress_oauth", "attr": "router", "features": {"all", "core"}},
|
||||
{"name": "bing_oauth", "module": "routers.bing_oauth", "attr": "router", "features": {"all", "core"}},
|
||||
{"name": "bing_analytics", "module": "routers.bing_analytics", "attr": "router", "features": {"all", "core"}},
|
||||
{"name": "bing_analytics_storage", "module": "routers.bing_analytics_storage", "attr": "router", "features": {"all", "core"}},
|
||||
@@ -45,8 +44,7 @@ CORE_ROUTER_REGISTRY = [
|
||||
OPTIONAL_ROUTER_REGISTRY = [
|
||||
{"name": "blog_writer", "module": "api.blog_writer.router", "attr": "router", "features": {"all", "blog_writer"}},
|
||||
{"name": "story_writer", "module": "api.story_writer.router", "attr": "router", "features": {"all", "story_writer"}},
|
||||
{"name": "wix", "module": "api.wix_routes", "attr": "router", "features": {"all", "blog_writer"}},
|
||||
{"name": "wix_test", "module": "api.wix_routes", "attr": "qa_router", "features": {"all"}},
|
||||
{"name": "wix", "module": "api.wix_routes", "attr": "router", "features": {"all"}},
|
||||
{"name": "blog_seo_analysis", "module": "api.blog_writer.seo_analysis", "attr": "router", "features": {"all", "blog_writer"}},
|
||||
{"name": "persona", "module": "api.persona_routes", "attr": "router", "features": {"all", "persona"}},
|
||||
{"name": "video_studio", "module": "api.video_studio.router", "attr": "router", "features": {"all", "video_studio"}},
|
||||
@@ -161,12 +159,6 @@ class RouterManager:
|
||||
logger.info(f"Including {group_name} routers with features: {enabled_features}...")
|
||||
|
||||
for entry in registry:
|
||||
if entry["name"] == "wix_test" and not self._should_include_wix_test_router():
|
||||
reason = "wix test routes disabled or running in production environment"
|
||||
self.skipped_routers.append({"name": entry["name"], "reason": reason})
|
||||
if verbose:
|
||||
logger.info(f"⏭️ Skipping {entry['name']}: {reason}")
|
||||
continue
|
||||
if not self._should_include_router(entry, enabled_features):
|
||||
reason = f"features {enabled_features} not matching {entry.get('features', set())}"
|
||||
self.skipped_routers.append({"name": entry["name"], "reason": reason})
|
||||
@@ -187,13 +179,6 @@ class RouterManager:
|
||||
logger.error(f"❌ Error including {group_name} routers: {e}")
|
||||
return False
|
||||
|
||||
@staticmethod
|
||||
def _should_include_wix_test_router() -> bool:
|
||||
environment = (os.getenv("ENVIRONMENT") or os.getenv("APP_ENV") or "development").strip().lower()
|
||||
is_production = environment in {"prod", "production"}
|
||||
wix_test_enabled = os.getenv("WIX_TEST_ROUTES_ENABLED", "false").lower() in {"1", "true", "yes", "on"}
|
||||
return wix_test_enabled and not is_production
|
||||
|
||||
def include_core_routers(self) -> bool:
|
||||
"""Include core application routers."""
|
||||
return self._include_registry_group(CORE_ROUTER_REGISTRY, "core")
|
||||
|
||||
@@ -38,15 +38,6 @@ MIME_MAP = {
|
||||
}
|
||||
|
||||
|
||||
def _verify_ownership(url_user_id: str, current_user: Dict[str, Any]) -> str:
|
||||
"""Verify the URL user_id matches the authenticated user. Returns sanitized user_id."""
|
||||
raw = current_user.get("id") or current_user.get("user_id") or current_user.get("clerk_user_id")
|
||||
authed_id = str(raw) if raw else ""
|
||||
if not authed_id or sanitize_user_id(url_user_id) != sanitize_user_id(authed_id):
|
||||
raise HTTPException(status_code=403, detail="Access denied: user mismatch")
|
||||
return sanitize_user_id(url_user_id)
|
||||
|
||||
|
||||
def _resolve_asset_path(user_id: str, category: str, filename: str) -> Path:
|
||||
"""Resolve asset path in user workspace with path-traversal protection."""
|
||||
safe_user_id = sanitize_user_id(user_id)
|
||||
@@ -73,19 +64,13 @@ async def serve_avatar(
|
||||
filename: str,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user_with_query_token),
|
||||
):
|
||||
"""Serve avatar images. Supports auth via Authorization header or ?token= query param.
|
||||
Falls back to images/ directory for backward compatibility with old asset library entries."""
|
||||
"""Serve avatar images. Supports auth via Authorization header or ?token= query param."""
|
||||
require_authenticated_user(current_user)
|
||||
_verify_ownership(user_id, current_user)
|
||||
|
||||
safe_filename = os.path.basename(filename)
|
||||
file_path = _resolve_asset_path(user_id, "avatars", safe_filename)
|
||||
|
||||
if not file_path.exists():
|
||||
alt_path = _resolve_asset_path(user_id, "images", safe_filename)
|
||||
if alt_path.exists():
|
||||
media_type = _get_media_type(safe_filename)
|
||||
return FileResponse(alt_path, media_type=media_type)
|
||||
raise HTTPException(status_code=404, detail="Asset not found")
|
||||
|
||||
media_type = _get_media_type(safe_filename)
|
||||
@@ -105,7 +90,6 @@ async def serve_voice_sample(
|
||||
which cannot send Authorization headers.
|
||||
"""
|
||||
require_authenticated_user(current_user)
|
||||
_verify_ownership(user_id, current_user)
|
||||
|
||||
safe_filename = os.path.basename(filename)
|
||||
file_path = _resolve_asset_path(user_id, "voice_samples", safe_filename)
|
||||
@@ -118,23 +102,3 @@ async def serve_voice_sample(
|
||||
file_size = file_path.stat().st_size
|
||||
logger.warning(f"[Assets] Serving voice sample: {safe_filename} ({media_type}, {file_size} bytes)")
|
||||
return FileResponse(file_path, media_type=media_type)
|
||||
|
||||
|
||||
@router.get("/{user_id}/images/{filename}")
|
||||
async def serve_image(
|
||||
user_id: str,
|
||||
filename: str,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user_with_query_token),
|
||||
):
|
||||
"""Serve generated/uploaded images. Supports auth via Authorization header or ?token= query param."""
|
||||
require_authenticated_user(current_user)
|
||||
_verify_ownership(user_id, current_user)
|
||||
|
||||
safe_filename = os.path.basename(filename)
|
||||
file_path = _resolve_asset_path(user_id, "images", safe_filename)
|
||||
|
||||
if not file_path.exists():
|
||||
raise HTTPException(status_code=404, detail="Asset not found")
|
||||
|
||||
media_type = _get_media_type(safe_filename)
|
||||
return FileResponse(file_path, media_type=media_type)
|
||||
@@ -9,12 +9,10 @@ from fastapi import APIRouter, HTTPException, Depends
|
||||
from typing import Any, Dict, List, Optional
|
||||
from pydantic import BaseModel, Field
|
||||
from loguru import logger
|
||||
from datetime import datetime
|
||||
from middleware.auth_middleware import get_current_user
|
||||
from sqlalchemy.orm import Session
|
||||
from services.database import get_db as get_db_dependency
|
||||
from utils.text_asset_tracker import save_and_track_text_content
|
||||
from models.content_asset_models import AssetType, AssetSource
|
||||
|
||||
from models.blog_models import (
|
||||
BlogResearchRequest,
|
||||
@@ -38,7 +36,6 @@ from models.blog_models import (
|
||||
from services.blog_writer.blog_service import BlogWriterService
|
||||
from services.blog_writer.seo.blog_seo_recommendation_applier import BlogSEORecommendationApplier
|
||||
from services.llm_providers.main_text_generation import llm_text_gen
|
||||
from services.content_asset_service import ContentAssetService
|
||||
from .task_manager import task_manager
|
||||
from .cache_manager import cache_manager
|
||||
from models.blog_models import MediumBlogGenerateRequest
|
||||
@@ -1263,233 +1260,3 @@ async def save_complete_blog_asset(
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to save complete blog asset: {e}")
|
||||
raise HTTPException(status_code=500, detail=str(e))
|
||||
|
||||
|
||||
# ---------------------------------------
|
||||
# Blog Asset API (phase-by-phase saving via ContentAsset)
|
||||
# ---------------------------------------
|
||||
|
||||
|
||||
class BlogAssetCreateRequest(BaseModel):
|
||||
research_keywords: str = Field(..., max_length=2000, description="Research keywords / topic")
|
||||
topic: Optional[str] = Field(default=None, max_length=500)
|
||||
word_count_target: Optional[int] = Field(default=None, ge=100, le=20000)
|
||||
|
||||
|
||||
class BlogAssetUpdateRequest(BaseModel):
|
||||
phase: Optional[str] = Field(default=None, pattern=r"^(research|outline|content|seo|publish)$")
|
||||
topic: Optional[str] = Field(default=None, max_length=500)
|
||||
selected_title: Optional[str] = Field(default=None, max_length=500)
|
||||
word_count_target: Optional[int] = Field(default=None, ge=100, le=20000)
|
||||
research_data: Optional[Dict[str, Any]] = None
|
||||
outline_data: Optional[Dict[str, Any]] = None
|
||||
content_data: Optional[Dict[str, Any]] = None
|
||||
seo_data: Optional[Dict[str, Any]] = None
|
||||
publish_data: Optional[Dict[str, Any]] = None
|
||||
|
||||
|
||||
def _normalize_keywords(kw: str) -> str:
|
||||
"""Normalize keywords for duplicate comparison."""
|
||||
return " ".join(sorted(kw.lower().split()))
|
||||
|
||||
|
||||
@router.post("/asset", response_model=Dict[str, Any])
|
||||
async def create_blog_asset(
|
||||
request: BlogAssetCreateRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
db: Session = Depends(get_db),
|
||||
):
|
||||
"""
|
||||
Create a blog ContentAsset on research start.
|
||||
Returns existing asset if duplicate keywords found (unique topics only).
|
||||
"""
|
||||
try:
|
||||
if not current_user:
|
||||
raise HTTPException(status_code=401, detail="Authentication required")
|
||||
user_id = str(current_user.get("id", ""))
|
||||
if not user_id:
|
||||
raise HTTPException(status_code=401, detail="Invalid user ID")
|
||||
|
||||
svc = ContentAssetService(db)
|
||||
normalized_kw = _normalize_keywords(request.research_keywords)
|
||||
|
||||
# Duplicate check — search existing blog assets for matching keywords
|
||||
existing_assets, _ = svc.get_user_assets(
|
||||
user_id=user_id,
|
||||
source_module=AssetSource.BLOG_WRITER,
|
||||
asset_type=AssetType.TEXT,
|
||||
limit=100,
|
||||
)
|
||||
for asset in existing_assets:
|
||||
meta = asset.asset_metadata or {}
|
||||
if meta.get("normalized_keywords") == normalized_kw:
|
||||
logger.info(f"Duplicate blog asset found: {asset.id}, returning existing")
|
||||
return {
|
||||
"success": True,
|
||||
"asset": _asset_to_response(asset),
|
||||
"existing": True,
|
||||
}
|
||||
|
||||
# Create new ContentAsset for this blog
|
||||
title = request.topic or request.research_keywords[:200]
|
||||
asset_metadata = {
|
||||
"phase": "research",
|
||||
"research_keywords": request.research_keywords,
|
||||
"normalized_keywords": normalized_kw,
|
||||
"word_count_target": request.word_count_target,
|
||||
"topic": request.topic,
|
||||
"research_data": None,
|
||||
"outline_data": None,
|
||||
"content_data": None,
|
||||
"seo_data": None,
|
||||
"publish_data": None,
|
||||
}
|
||||
asset = svc.create_asset(
|
||||
user_id=user_id,
|
||||
asset_type=AssetType.TEXT,
|
||||
source_module=AssetSource.BLOG_WRITER,
|
||||
filename=f"blog_{int(datetime.utcnow().timestamp())}.md",
|
||||
file_url=f"/api/blog/content/pending",
|
||||
title=title,
|
||||
description=f"Blog: {title}",
|
||||
tags=["blog", "research"],
|
||||
asset_metadata=asset_metadata,
|
||||
)
|
||||
logger.info(f"✅ Created blog asset: {asset.id}")
|
||||
return {
|
||||
"success": True,
|
||||
"asset": _asset_to_response(asset),
|
||||
"existing": False,
|
||||
}
|
||||
except HTTPException:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to create blog asset: {e}")
|
||||
raise HTTPException(status_code=500, detail=str(e))
|
||||
|
||||
|
||||
@router.put("/asset/{asset_id}", response_model=Dict[str, Any])
|
||||
async def update_blog_asset(
|
||||
asset_id: int,
|
||||
request: BlogAssetUpdateRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
db: Session = Depends(get_db),
|
||||
):
|
||||
"""Update a blog asset's phase, metadata, and tags."""
|
||||
try:
|
||||
if not current_user:
|
||||
raise HTTPException(status_code=401, detail="Authentication required")
|
||||
user_id = str(current_user.get("id", ""))
|
||||
if not user_id:
|
||||
raise HTTPException(status_code=401, detail="Invalid user ID")
|
||||
|
||||
svc = ContentAssetService(db)
|
||||
asset = svc.get_asset_by_id(asset_id, user_id)
|
||||
if not asset:
|
||||
raise HTTPException(status_code=404, detail="Blog asset not found")
|
||||
|
||||
meta = dict(asset.asset_metadata or {})
|
||||
tags = list(asset.tags or [])
|
||||
|
||||
if request.phase is not None:
|
||||
meta["phase"] = request.phase
|
||||
# Update tags to reflect phase
|
||||
new_tags = [t for t in tags if t not in ("research", "outline", "content", "seo", "publish")]
|
||||
new_tags.append(request.phase)
|
||||
if "blog" not in new_tags:
|
||||
new_tags.append("blog")
|
||||
tags = new_tags
|
||||
|
||||
if request.topic is not None:
|
||||
meta["topic"] = request.topic
|
||||
if request.selected_title is not None:
|
||||
meta["selected_title"] = request.selected_title
|
||||
if request.word_count_target is not None:
|
||||
meta["word_count_target"] = request.word_count_target
|
||||
|
||||
for field in ("research_data", "outline_data", "content_data", "seo_data", "publish_data"):
|
||||
val = getattr(request, field, None)
|
||||
if val is not None:
|
||||
meta[field] = val
|
||||
|
||||
if meta.get("selected_title"):
|
||||
new_title = meta["selected_title"]
|
||||
elif meta.get("topic"):
|
||||
new_title = meta["topic"]
|
||||
else:
|
||||
new_title = asset.title or "Blog Post"
|
||||
|
||||
updated = svc.update_asset(
|
||||
asset_id=asset_id,
|
||||
user_id=user_id,
|
||||
title=new_title[:500],
|
||||
tags=tags,
|
||||
asset_metadata=meta,
|
||||
)
|
||||
if not updated:
|
||||
raise HTTPException(status_code=500, detail="Failed to update asset")
|
||||
|
||||
logger.info(f"✅ Updated blog asset {asset_id}: phase={meta.get('phase')}")
|
||||
return {"success": True, "asset": _asset_to_response(updated)}
|
||||
except HTTPException:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to update blog asset {asset_id}: {e}")
|
||||
raise HTTPException(status_code=500, detail=str(e))
|
||||
|
||||
|
||||
@router.get("/asset/{asset_id}", response_model=Dict[str, Any])
|
||||
async def get_blog_asset(
|
||||
asset_id: int,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
db: Session = Depends(get_db),
|
||||
):
|
||||
"""Get a blog asset with all phase data."""
|
||||
try:
|
||||
if not current_user:
|
||||
raise HTTPException(status_code=401, detail="Authentication required")
|
||||
user_id = str(current_user.get("id", ""))
|
||||
if not user_id:
|
||||
raise HTTPException(status_code=401, detail="Invalid user ID")
|
||||
|
||||
svc = ContentAssetService(db)
|
||||
asset = svc.get_asset_by_id(asset_id, user_id)
|
||||
if not asset:
|
||||
raise HTTPException(status_code=404, detail="Blog asset not found")
|
||||
|
||||
return {"success": True, "asset": _asset_to_response(asset, full=True)}
|
||||
except HTTPException:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to get blog asset {asset_id}: {e}")
|
||||
raise HTTPException(status_code=500, detail=str(e))
|
||||
|
||||
|
||||
def _asset_to_response(asset: Any, full: bool = False) -> Dict[str, Any]:
|
||||
"""Convert a ContentAsset to a blog asset response dict."""
|
||||
meta = asset.asset_metadata or {}
|
||||
resp: Dict[str, Any] = {
|
||||
"id": asset.id,
|
||||
"title": asset.title,
|
||||
"description": asset.description,
|
||||
"tags": asset.tags or [],
|
||||
"phase": meta.get("phase", "research"),
|
||||
"research_keywords": meta.get("research_keywords"),
|
||||
"topic": meta.get("topic"),
|
||||
"selected_title": meta.get("selected_title"),
|
||||
"word_count_target": meta.get("word_count_target"),
|
||||
"has_research": meta.get("research_data") is not None,
|
||||
"has_outline": meta.get("outline_data") is not None,
|
||||
"has_content": meta.get("content_data") is not None,
|
||||
"has_seo": meta.get("seo_data") is not None,
|
||||
"has_publish": meta.get("publish_data") is not None,
|
||||
"created_at": asset.created_at.isoformat() if asset.created_at else None,
|
||||
"updated_at": asset.updated_at.isoformat() if asset.updated_at else None,
|
||||
}
|
||||
if full:
|
||||
resp["research_data"] = meta.get("research_data")
|
||||
resp["outline_data"] = meta.get("outline_data")
|
||||
resp["content_data"] = meta.get("content_data")
|
||||
resp["seo_data"] = meta.get("seo_data")
|
||||
resp["publish_data"] = meta.get("publish_data")
|
||||
return resp
|
||||
|
||||
@@ -256,8 +256,7 @@ class TaskManager:
|
||||
self.task_storage[task_id]["status"] = "running"
|
||||
self.task_storage[task_id]["progress_messages"] = []
|
||||
|
||||
await self.update_progress(task_id, "📝 Alwrity is preparing your blog content — this usually takes 20–40 seconds.")
|
||||
await self.update_progress(task_id, "📦 Packaging your outline sections and research data...")
|
||||
await self.update_progress(task_id, "📦 Packaging outline and metadata...")
|
||||
|
||||
# Basic guard: respect global target words
|
||||
total_target = int(request.globalTargetWords or 1000)
|
||||
@@ -282,21 +281,15 @@ class TaskManager:
|
||||
# Check if result came from cache
|
||||
cache_hit = getattr(result, 'cache_hit', False)
|
||||
if cache_hit:
|
||||
await self.update_progress(task_id, "⚡ Found existing content in cache — no need to regenerate!")
|
||||
await self.update_progress(task_id, "⚡ Found cached content - loading instantly!")
|
||||
else:
|
||||
await self.update_progress(task_id, "🧠 AI is writing each section with research-backed insights and natural flow...")
|
||||
await self.update_progress(task_id, "✨ Polishing content — improving structure, readability, and transitions...")
|
||||
await self.update_progress(task_id, "🤖 Generated fresh content with AI...")
|
||||
await self.update_progress(task_id, "✨ Post-processing and assembling sections...")
|
||||
|
||||
# Mark completed
|
||||
self.task_storage[task_id]["status"] = "completed"
|
||||
self.task_storage[task_id]["result"] = result.dict()
|
||||
section_count = len(result.sections)
|
||||
total_words = sum(getattr(s, 'wordCount', 0) or 0 for s in result.sections)
|
||||
await self.update_progress(
|
||||
task_id,
|
||||
f"✅ Content generation complete! {section_count} sections written ({total_words} words). "
|
||||
"Next up: SEO Analysis to optimize your blog for search engines."
|
||||
)
|
||||
await self.update_progress(task_id, f"✅ Generated {len(result.sections)} sections successfully.")
|
||||
|
||||
# Note: Blog content tracking is handled in the status endpoint
|
||||
# to ensure we have proper database session and user context
|
||||
|
||||
@@ -1,192 +0,0 @@
|
||||
"""
|
||||
Chart API — Shared chart generation endpoints for Blog Writer, Podcast Maker, etc.
|
||||
|
||||
Two modes:
|
||||
1. Explicit: POST /api/charts/generate with { chart_type, chart_data, title }
|
||||
2. AI-driven: POST /api/charts/generate with { text } → LLM infers chart_type + data
|
||||
|
||||
Both return { preview_url, chart_id, chart_type?, chart_data?, title? }
|
||||
"""
|
||||
|
||||
import uuid
|
||||
from pathlib import Path
|
||||
from typing import Dict, Any, Optional
|
||||
|
||||
from fastapi import APIRouter, Depends, HTTPException
|
||||
from fastapi.responses import FileResponse
|
||||
from pydantic import BaseModel, Field
|
||||
from loguru import logger
|
||||
|
||||
from middleware.auth_middleware import get_current_user, get_current_user_with_query_token
|
||||
from api.story_writer.utils.auth import require_authenticated_user
|
||||
from services.chart_service import get_chart_service, VALID_CHART_TYPES
|
||||
|
||||
|
||||
router = APIRouter(prefix="/api/charts", tags=["Charts"])
|
||||
|
||||
|
||||
class ChartGenerateRequest(BaseModel):
|
||||
"""Request for chart generation.
|
||||
|
||||
Provide either:
|
||||
- chart_type + chart_data (explicit mode), OR
|
||||
- text (AI inference mode — LLM determines chart_type + data)
|
||||
"""
|
||||
chart_data: Optional[Dict[str, Any]] = Field(
|
||||
default=None,
|
||||
description="Chart data dict (labels, values, before/after, etc.)"
|
||||
)
|
||||
chart_type: Optional[str] = Field(
|
||||
default=None,
|
||||
description=f"Chart type: {', '.join(VALID_CHART_TYPES)}"
|
||||
)
|
||||
title: str = Field(default="", description="Chart title")
|
||||
subtitle: Optional[str] = Field(default="", description="Optional subtitle")
|
||||
text: Optional[str] = Field(
|
||||
default=None,
|
||||
description="Text to infer chart from (AI mode). Mutually exclusive with chart_type+chart_data."
|
||||
)
|
||||
section_heading: Optional[str] = Field(
|
||||
default=None,
|
||||
description="Blog section heading for context (AI mode with research)"
|
||||
)
|
||||
section_key_points: Optional[list] = Field(
|
||||
default=None,
|
||||
description="Key points from the section (AI mode with research)"
|
||||
)
|
||||
|
||||
|
||||
class ChartGenerateResponse(BaseModel):
|
||||
"""Response for chart generation."""
|
||||
preview_url: str = ""
|
||||
chart_id: str = ""
|
||||
chart_type: Optional[str] = None
|
||||
chart_data: Optional[Dict[str, Any]] = None
|
||||
title: Optional[str] = None
|
||||
warnings: list = Field(default_factory=list, description="Pipeline warnings (e.g. Exa search failures)")
|
||||
|
||||
|
||||
@router.post("/generate", response_model=ChartGenerateResponse)
|
||||
async def generate_chart(
|
||||
request: ChartGenerateRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""
|
||||
Generate a chart PNG preview.
|
||||
|
||||
Two modes:
|
||||
1. Explicit: Provide chart_type + chart_data
|
||||
2. AI-driven: Provide text, and the LLM infers chart_type + chart_data
|
||||
"""
|
||||
user_id = require_authenticated_user(current_user)
|
||||
|
||||
try:
|
||||
chart_svc = get_chart_service(user_id=user_id)
|
||||
|
||||
if request.text and not request.chart_type:
|
||||
# AI inference mode
|
||||
logger.info(f"[Charts] AI inference mode for user {user_id}, text length={len(request.text)}")
|
||||
result = await chart_svc.generate_chart_from_text(
|
||||
text=request.text,
|
||||
user_id=user_id,
|
||||
section_heading=request.section_heading,
|
||||
section_key_points=request.section_key_points,
|
||||
)
|
||||
|
||||
if not result.get("path"):
|
||||
raise HTTPException(status_code=500, detail="Chart generation failed")
|
||||
|
||||
chart_id = result["chart_id"]
|
||||
filename = result.get("filename", f"chart_preview_{chart_id}.png")
|
||||
|
||||
return ChartGenerateResponse(
|
||||
preview_url=f"/api/charts/preview/{chart_id}/{filename}",
|
||||
chart_id=chart_id,
|
||||
chart_type=result.get("chart_type"),
|
||||
chart_data=result.get("chart_data"),
|
||||
title=result.get("title"),
|
||||
warnings=result.get("warnings", []),
|
||||
)
|
||||
|
||||
elif request.chart_type and request.chart_data:
|
||||
# Explicit mode
|
||||
chart_type = request.chart_type
|
||||
if chart_type not in VALID_CHART_TYPES:
|
||||
# Try normalizing aliases
|
||||
from services.chart_service import _normalize_chart_type
|
||||
chart_type = _normalize_chart_type(chart_type)
|
||||
if chart_type not in VALID_CHART_TYPES:
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail=f"Invalid chart_type. Must be one of: {VALID_CHART_TYPES}"
|
||||
)
|
||||
|
||||
logger.info(f"[Charts] Explicit mode: type={chart_type}, user={user_id}")
|
||||
|
||||
chart_id = uuid.uuid4().hex[:8]
|
||||
result = chart_svc.generate_chart(
|
||||
chart_data=request.chart_data,
|
||||
chart_type=chart_type,
|
||||
title=request.title,
|
||||
subtitle=request.subtitle or "",
|
||||
chart_id=chart_id,
|
||||
)
|
||||
|
||||
if not result.get("path"):
|
||||
raise HTTPException(status_code=500, detail="Chart generation failed — check chart_data format")
|
||||
|
||||
filename = result.get("filename", f"chart_preview_{chart_id}.png")
|
||||
|
||||
return ChartGenerateResponse(
|
||||
preview_url=f"/api/charts/preview/{chart_id}/{filename}",
|
||||
chart_id=chart_id,
|
||||
chart_type=chart_type,
|
||||
chart_data=request.chart_data,
|
||||
title=request.title,
|
||||
)
|
||||
|
||||
else:
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail="Provide either 'text' (AI mode) or 'chart_type' + 'chart_data' (explicit mode)"
|
||||
)
|
||||
|
||||
except HTTPException:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error(f"[Charts] Generation failed: {e}")
|
||||
raise HTTPException(status_code=500, detail=f"Chart generation failed: {str(e)}")
|
||||
|
||||
|
||||
@router.get("/preview/{chart_id}/{filename}")
|
||||
async def serve_chart_preview(
|
||||
chart_id: str,
|
||||
filename: str,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user_with_query_token),
|
||||
):
|
||||
"""Serve chart preview PNG files. Auth via header or query token."""
|
||||
user_id = require_authenticated_user(current_user)
|
||||
|
||||
if ".." in filename or "/" in filename or "\\" in filename:
|
||||
raise HTTPException(status_code=400, detail="Invalid filename")
|
||||
|
||||
chart_svc = get_chart_service(user_id=user_id)
|
||||
file_path = chart_svc.get_chart_preview_path(chart_id)
|
||||
|
||||
if not file_path.exists():
|
||||
raise HTTPException(status_code=404, detail="Chart preview not found")
|
||||
|
||||
if not str(file_path.resolve()).startswith(str(chart_svc.output_dir.resolve())):
|
||||
raise HTTPException(status_code=403, detail="Access denied")
|
||||
|
||||
return FileResponse(
|
||||
path=str(file_path),
|
||||
media_type="image/png",
|
||||
filename=filename,
|
||||
)
|
||||
|
||||
|
||||
@router.get("/health")
|
||||
async def charts_health():
|
||||
"""Health check for Charts service."""
|
||||
return {"status": "ok", "service": "charts"}
|
||||
@@ -52,7 +52,7 @@ class AutoFillRefreshService:
|
||||
|
||||
logger.info(f" - Website analysis keys: {list(website_analysis.keys()) if website_analysis else 'None'}")
|
||||
logger.info(f" - Research preferences keys: {list(research_preferences.keys()) if research_preferences else 'None'}")
|
||||
logger.info(" - API keys data present: %s | entry_count=%s", bool(api_keys_data), len(api_keys_data) if isinstance(api_keys_data, dict) else 0)
|
||||
logger.info(f" - API keys data keys: {list(api_keys_data.keys()) if api_keys_data else 'None'}")
|
||||
logger.info(f" - Onboarding session keys: {list(onboarding_session.keys()) if onboarding_session else 'None'}")
|
||||
|
||||
# Log specific data points
|
||||
@@ -64,7 +64,7 @@ class AutoFillRefreshService:
|
||||
logger.info(f" - Content types: {research_preferences.get('content_types', 'Not found')}")
|
||||
if api_keys_data:
|
||||
logger.info(f" - API providers: {api_keys_data.get('providers', [])}")
|
||||
logger.info(" - API key data present: %s", bool(api_keys_data))
|
||||
logger.info(f" - Total keys: {api_keys_data.get('total_keys', 0)}")
|
||||
else:
|
||||
logger.warning(f"AutoFillRefreshService: no base context available | user=%s", user_id)
|
||||
|
||||
|
||||
@@ -79,8 +79,8 @@ class CachingService:
|
||||
if kwargs:
|
||||
key_data += ":" + json.dumps(kwargs, sort_keys=True)
|
||||
|
||||
# Create hash for consistent key length using a strong hash algorithm
|
||||
key_hash = hashlib.sha256(key_data.encode("utf-8")).hexdigest()
|
||||
# Create hash for consistent key length
|
||||
key_hash = hashlib.md5(key_data.encode()).hexdigest()
|
||||
return f"content_strategy:{cache_type}:{key_hash}"
|
||||
|
||||
except Exception as e:
|
||||
|
||||
@@ -8,7 +8,7 @@ using Exa.ai integration, similar to the Exa.ai demo implementation.
|
||||
import time
|
||||
import logging
|
||||
from typing import Dict, Any
|
||||
from fastapi import APIRouter, HTTPException, BackgroundTasks, Depends
|
||||
from fastapi import APIRouter, HTTPException, BackgroundTasks
|
||||
from fastapi.responses import JSONResponse
|
||||
|
||||
from models.hallucination_models import (
|
||||
@@ -24,7 +24,6 @@ from models.hallucination_models import (
|
||||
AssessmentType
|
||||
)
|
||||
from services.hallucination_detector import HallucinationDetector
|
||||
from middleware.auth_middleware import get_current_user
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
@@ -35,7 +34,7 @@ router = APIRouter(prefix="/api/hallucination-detector", tags=["Hallucination De
|
||||
detector = HallucinationDetector()
|
||||
|
||||
@router.post("/detect", response_model=HallucinationDetectionResponse)
|
||||
async def detect_hallucinations(request: HallucinationDetectionRequest, current_user: Dict[str, Any] = Depends(get_current_user)) -> HallucinationDetectionResponse:
|
||||
async def detect_hallucinations(request: HallucinationDetectionRequest) -> HallucinationDetectionResponse:
|
||||
"""
|
||||
Detect hallucinations in the provided text.
|
||||
|
||||
@@ -55,10 +54,8 @@ async def detect_hallucinations(request: HallucinationDetectionRequest, current_
|
||||
try:
|
||||
logger.info(f"Starting hallucination detection for text of length: {len(request.text)}")
|
||||
|
||||
user_id = current_user.get("id")
|
||||
|
||||
# Perform hallucination detection
|
||||
result = await detector.detect_hallucinations(request.text, user_id=user_id)
|
||||
result = await detector.detect_hallucinations(request.text)
|
||||
|
||||
# Convert to response format
|
||||
claims = []
|
||||
@@ -71,7 +68,7 @@ async def detect_hallucinations(request: HallucinationDetectionRequest, current_
|
||||
text=source.get('text', ''),
|
||||
published_date=source.get('publishedDate'),
|
||||
author=source.get('author'),
|
||||
score=source.get('score') if source.get('score') is not None else 0.5
|
||||
score=source.get('score', 0.5)
|
||||
)
|
||||
for source in claim.supporting_sources
|
||||
]
|
||||
@@ -83,7 +80,7 @@ async def detect_hallucinations(request: HallucinationDetectionRequest, current_
|
||||
text=source.get('text', ''),
|
||||
published_date=source.get('publishedDate'),
|
||||
author=source.get('author'),
|
||||
score=source.get('score') if source.get('score') is not None else 0.5
|
||||
score=source.get('score', 0.5)
|
||||
)
|
||||
for source in claim.refuting_sources
|
||||
]
|
||||
@@ -116,8 +113,6 @@ async def detect_hallucinations(request: HallucinationDetectionRequest, current_
|
||||
return response
|
||||
|
||||
except Exception as e:
|
||||
if isinstance(e, HTTPException):
|
||||
raise e
|
||||
logger.error(f"Error in hallucination detection: {str(e)}")
|
||||
processing_time = int((time.time() - start_time) * 1000)
|
||||
|
||||
@@ -179,7 +174,7 @@ async def extract_claims(request: ClaimExtractionRequest) -> ClaimExtractionResp
|
||||
)
|
||||
|
||||
@router.post("/verify-claim", response_model=ClaimVerificationResponse)
|
||||
async def verify_claim(request: ClaimVerificationRequest, current_user: Dict[str, Any] = Depends(get_current_user)) -> ClaimVerificationResponse:
|
||||
async def verify_claim(request: ClaimVerificationRequest) -> ClaimVerificationResponse:
|
||||
"""
|
||||
Verify a single claim against available sources.
|
||||
|
||||
@@ -197,10 +192,8 @@ async def verify_claim(request: ClaimVerificationRequest, current_user: Dict[str
|
||||
try:
|
||||
logger.info(f"Verifying claim: {request.claim[:100]}...")
|
||||
|
||||
user_id = current_user.get("id")
|
||||
|
||||
# Verify the claim
|
||||
claim_result = await detector._verify_claim(request.claim, user_id=user_id)
|
||||
claim_result = await detector._verify_claim(request.claim)
|
||||
|
||||
# Convert to response format
|
||||
supporting_sources = []
|
||||
@@ -214,7 +207,7 @@ async def verify_claim(request: ClaimVerificationRequest, current_user: Dict[str
|
||||
text=source.get('text', ''),
|
||||
published_date=source.get('publishedDate'),
|
||||
author=source.get('author'),
|
||||
score=source.get('score') if source.get('score') is not None else 0.5
|
||||
score=source.get('score', 0.5)
|
||||
)
|
||||
for source in claim_result.supporting_sources
|
||||
]
|
||||
@@ -226,7 +219,7 @@ async def verify_claim(request: ClaimVerificationRequest, current_user: Dict[str
|
||||
text=source.get('text', ''),
|
||||
published_date=source.get('publishedDate'),
|
||||
author=source.get('author'),
|
||||
score=source.get('score') if source.get('score') is not None else 0.5
|
||||
score=source.get('score', 0.5)
|
||||
)
|
||||
for source in claim_result.refuting_sources
|
||||
]
|
||||
@@ -253,8 +246,6 @@ async def verify_claim(request: ClaimVerificationRequest, current_user: Dict[str
|
||||
return response
|
||||
|
||||
except Exception as e:
|
||||
if isinstance(e, HTTPException):
|
||||
raise e
|
||||
logger.error(f"Error in claim verification: {str(e)}")
|
||||
processing_time = int((time.time() - start_time) * 1000)
|
||||
|
||||
@@ -282,21 +273,17 @@ async def health_check() -> HealthCheckResponse:
|
||||
HealthCheckResponse with service status and API availability
|
||||
"""
|
||||
try:
|
||||
from services.blog_writer.research.exa_provider import ExaResearchProvider
|
||||
try:
|
||||
exa_provider = ExaResearchProvider()
|
||||
exa_available = bool(exa_provider.api_key)
|
||||
except RuntimeError:
|
||||
exa_available = False
|
||||
llm_available = True # llm_text_gen handles provider selection via GPT_PROVIDER
|
||||
# Check API availability
|
||||
exa_available = bool(detector.exa_api_key)
|
||||
openai_available = bool(detector.openai_api_key)
|
||||
|
||||
status = "healthy" if (exa_available and llm_available) else ("degraded" if exa_available or llm_available else "unhealthy")
|
||||
status = "healthy" if (exa_available or openai_available) else "degraded"
|
||||
|
||||
response = HealthCheckResponse(
|
||||
status=status,
|
||||
version="1.0.0",
|
||||
exa_api_available=exa_available,
|
||||
openai_api_available=llm_available,
|
||||
openai_api_available=openai_available,
|
||||
timestamp=time.strftime('%Y-%m-%dT%H:%M:%S')
|
||||
)
|
||||
|
||||
|
||||
@@ -27,8 +27,6 @@ from services.subscription import UsageTrackingService, PricingService
|
||||
from models.subscription_models import APIProvider, UsageSummary
|
||||
from utils.asset_tracker import save_asset_to_library
|
||||
from utils.file_storage import save_file_safely, generate_unique_filename, sanitize_filename
|
||||
from services.content_asset_service import ContentAssetService
|
||||
from models.content_asset_models import ContentAsset
|
||||
|
||||
|
||||
router = APIRouter(prefix="/api/images", tags=["images"])
|
||||
@@ -191,27 +189,44 @@ def generate(
|
||||
billing_period=current_period
|
||||
)
|
||||
db_track.add(summary)
|
||||
db_track.flush()
|
||||
db_track.flush() # Ensure summary is persisted before updating
|
||||
|
||||
# Get "before" state for unified log
|
||||
current_calls_before = getattr(summary, "stability_calls", 0) or 0
|
||||
new_calls = current_calls_before + 1
|
||||
|
||||
# Update provider-specific counters (stability for image generation)
|
||||
# Note: All image generation goes through STABILITY provider enum regardless of actual provider
|
||||
new_calls = current_calls_before + 1
|
||||
setattr(summary, "stability_calls", new_calls)
|
||||
logger.debug(f"[images.generate] Updated stability_calls: {current_calls_before} -> {new_calls}")
|
||||
|
||||
# Update totals
|
||||
old_total_calls = summary.total_calls or 0
|
||||
summary.total_calls = old_total_calls + 1
|
||||
logger.debug(f"[images.generate] Updated totals: calls {old_total_calls} -> {summary.total_calls}")
|
||||
|
||||
# Get plan details for unified log
|
||||
limits = pricing.get_user_limits(user_id)
|
||||
plan_name = limits.get('plan_name', 'unknown') if limits else 'unknown'
|
||||
tier = limits.get('tier', 'unknown') if limits else 'unknown'
|
||||
call_limit = limits['limits'].get("stability_calls", 0) if limits else 0
|
||||
|
||||
# Get image editing stats for unified log
|
||||
current_image_edit_calls = getattr(summary, "image_edit_calls", 0) or 0
|
||||
image_edit_limit = limits['limits'].get("image_edit_calls", 0) if limits else 0
|
||||
|
||||
# Get video stats for unified log
|
||||
current_video_calls = getattr(summary, "video_calls", 0) or 0
|
||||
video_limit = limits['limits'].get("video_calls", 0) if limits else 0
|
||||
|
||||
# Get audio stats for unified log
|
||||
current_audio_calls = getattr(summary, "audio_calls", 0) or 0
|
||||
audio_limit = limits['limits'].get("audio_calls", 0) if limits else 0
|
||||
# Only show ∞ for Enterprise tier when limit is 0 (unlimited)
|
||||
audio_limit_display = audio_limit if (audio_limit > 0 or tier != 'enterprise') else '∞'
|
||||
|
||||
logger.debug(f"[images.generate] Usage snapshot for logging: stability_calls={current_calls_before}, total_calls={summary.total_calls or 0}")
|
||||
db_track.commit()
|
||||
logger.info(f"[images.generate] ✅ Successfully tracked usage: user {user_id} -> stability -> {new_calls} calls")
|
||||
|
||||
# UNIFIED SUBSCRIPTION LOG - Shows before/after state in one message
|
||||
print(f"""
|
||||
@@ -950,19 +965,32 @@ def edit(
|
||||
billing_period=current_period
|
||||
)
|
||||
db_track.add(summary)
|
||||
db_track.flush()
|
||||
db_track.flush() # Ensure summary is persisted before updating
|
||||
|
||||
# Get "before" state for unified log
|
||||
current_calls_before = getattr(summary, "image_edit_calls", 0) or 0
|
||||
new_calls = current_calls_before + 1
|
||||
|
||||
# Update image editing counters (separate from image generation)
|
||||
new_calls = current_calls_before + 1
|
||||
setattr(summary, "image_edit_calls", new_calls)
|
||||
logger.debug(f"[images.edit] Updated image_edit_calls: {current_calls_before} -> {new_calls}")
|
||||
|
||||
# Update totals
|
||||
old_total_calls = summary.total_calls or 0
|
||||
summary.total_calls = old_total_calls + 1
|
||||
logger.debug(f"[images.edit] Updated totals: calls {old_total_calls} -> {summary.total_calls}")
|
||||
|
||||
# Get plan details for unified log
|
||||
limits = pricing.get_user_limits(user_id)
|
||||
plan_name = limits.get('plan_name', 'unknown') if limits else 'unknown'
|
||||
tier = limits.get('tier', 'unknown') if limits else 'unknown'
|
||||
call_limit = limits['limits'].get("image_edit_calls", 0) if limits else 0
|
||||
|
||||
# Get image generation stats for unified log
|
||||
current_image_gen_calls = getattr(summary, "stability_calls", 0) or 0
|
||||
image_gen_limit = limits['limits'].get("stability_calls", 0) if limits else 0
|
||||
|
||||
# Get video stats for unified log
|
||||
current_video_calls = getattr(summary, "video_calls", 0) or 0
|
||||
video_limit = limits['limits'].get("video_calls", 0) if limits else 0
|
||||
|
||||
@@ -972,7 +1000,8 @@ def edit(
|
||||
# Only show ∞ for Enterprise tier when limit is 0 (unlimited)
|
||||
audio_limit_display = audio_limit if (audio_limit > 0 or tier != 'enterprise') else '∞'
|
||||
|
||||
logger.debug(f"[images.edit] Usage snapshot for logging: image_edit_calls={current_calls_before}, total_calls={summary.total_calls or 0}")
|
||||
db_track.commit()
|
||||
logger.info(f"[images.edit] ✅ Successfully tracked usage: user {user_id} -> image_edit -> {new_calls} calls")
|
||||
|
||||
# UNIFIED SUBSCRIPTION LOG - Shows before/after state in one message
|
||||
print(f"""
|
||||
@@ -1024,29 +1053,13 @@ def edit(
|
||||
@router.get("/image-studio/images/{image_filename:path}")
|
||||
async def serve_image_studio_image(
|
||||
image_filename: str,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
db: Session = Depends(get_db),
|
||||
current_user: Dict[str, Any] = Depends(get_current_user)
|
||||
):
|
||||
"""Serve a generated or edited image from Image Studio.
|
||||
Verifies the authenticated user owns the image via asset library lookup."""
|
||||
"""Serve a generated or edited image from Image Studio."""
|
||||
try:
|
||||
if not current_user:
|
||||
raise HTTPException(status_code=401, detail="Authentication required")
|
||||
|
||||
user_id = current_user.get("id") or current_user.get("user_id") or current_user.get("clerk_user_id")
|
||||
if not user_id:
|
||||
raise HTTPException(status_code=401, detail="User ID not found")
|
||||
|
||||
# Verify ownership: the requesting user must have a content_assets record for this file_url
|
||||
full_url = f"/api/images/image-studio/images/{image_filename}"
|
||||
service = ContentAssetService(db)
|
||||
owned = db.query(ContentAsset).filter(
|
||||
ContentAsset.user_id == user_id,
|
||||
ContentAsset.file_url == full_url,
|
||||
).first()
|
||||
if not owned:
|
||||
raise HTTPException(status_code=403, detail="Access denied: image not found in your library")
|
||||
|
||||
# Determine if it's an edited image or regular image
|
||||
base_dir = Path(__file__).parent.parent
|
||||
image_studio_dir = (base_dir / "image_studio_images").resolve()
|
||||
|
||||
@@ -1,185 +0,0 @@
|
||||
"""
|
||||
Link Search API — Internal & external link discovery and reword-with-links.
|
||||
|
||||
Endpoints:
|
||||
POST /api/links/search — Search for internal or external links via Exa
|
||||
POST /api/links/reword — Reword text to naturally incorporate selected links
|
||||
GET /api/links/health — Health check
|
||||
"""
|
||||
|
||||
from typing import Dict, Any, List, Optional
|
||||
|
||||
from fastapi import APIRouter, Depends, HTTPException
|
||||
from pydantic import BaseModel, Field
|
||||
from loguru import logger
|
||||
|
||||
from middleware.auth_middleware import get_current_user
|
||||
from api.story_writer.utils.auth import require_authenticated_user
|
||||
from services.link_search_service import get_link_search_service
|
||||
|
||||
|
||||
router = APIRouter(prefix="/api/links", tags=["Links"])
|
||||
|
||||
|
||||
class LinkSearchRequest(BaseModel):
|
||||
"""Request for link search (internal or external)."""
|
||||
query: str = Field(..., description="Search query (typically section heading or topic)")
|
||||
link_type: str = Field(
|
||||
...,
|
||||
description="Type of links: 'internal' or 'external'",
|
||||
)
|
||||
site_url: Optional[str] = Field(
|
||||
default=None,
|
||||
description="User's website URL (required for internal links, optional for external to exclude own domain)",
|
||||
)
|
||||
num_results: int = Field(default=5, description="Number of results to return", ge=1, le=15)
|
||||
|
||||
|
||||
class LinkSearchResult(BaseModel):
|
||||
"""A single link search result."""
|
||||
title: str = ""
|
||||
url: str = ""
|
||||
text: str = ""
|
||||
publishedDate: str = ""
|
||||
author: str = ""
|
||||
score: float = 0.5
|
||||
|
||||
|
||||
class LinkSearchResponse(BaseModel):
|
||||
"""Response for link search."""
|
||||
results: List[LinkSearchResult] = Field(default_factory=list)
|
||||
warnings: List[str] = Field(default_factory=list)
|
||||
|
||||
|
||||
class RewordRequest(BaseModel):
|
||||
"""Request to reword text with selected links."""
|
||||
section_text: str = Field(..., description="Full section text")
|
||||
selected_text: Optional[str] = Field(
|
||||
default=None,
|
||||
description="If provided, only reword this portion of the text",
|
||||
)
|
||||
section_heading: Optional[str] = Field(default=None, description="Section heading for context")
|
||||
links: List[Dict[str, str]] = Field(
|
||||
...,
|
||||
description="List of {'url': str, 'title': str} dicts to incorporate",
|
||||
)
|
||||
|
||||
|
||||
class RewordResponse(BaseModel):
|
||||
"""Response for reword-with-links."""
|
||||
reworded_text: str = ""
|
||||
warnings: List[str] = Field(default_factory=list)
|
||||
|
||||
|
||||
@router.post("/search", response_model=LinkSearchResponse)
|
||||
async def search_links(
|
||||
request: LinkSearchRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Search for internal or external links using Exa."""
|
||||
user_id = require_authenticated_user(current_user)
|
||||
|
||||
if request.link_type not in ("internal", "external"):
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail="link_type must be 'internal' or 'external'",
|
||||
)
|
||||
|
||||
if request.link_type == "internal" and not request.site_url:
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail="site_url is required for internal link search",
|
||||
)
|
||||
|
||||
if len(request.query) > 500:
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail="Query must be 500 characters or less",
|
||||
)
|
||||
|
||||
service = get_link_search_service(user_id=user_id)
|
||||
|
||||
try:
|
||||
if request.link_type == "internal":
|
||||
logger.info(f"[Links] Internal search: query='{request.query[:50]}', site='{request.site_url}', user={user_id}")
|
||||
result = await service.search_internal(
|
||||
query=request.query,
|
||||
site_url=request.site_url,
|
||||
user_id=user_id,
|
||||
num_results=request.num_results,
|
||||
)
|
||||
else:
|
||||
logger.info(f"[Links] External search: query='{request.query[:50]}', user={user_id}")
|
||||
result = await service.search_external(
|
||||
query=request.query,
|
||||
site_url=request.site_url,
|
||||
user_id=user_id,
|
||||
num_results=request.num_results,
|
||||
)
|
||||
|
||||
return LinkSearchResponse(
|
||||
results=[LinkSearchResult(**r) for r in result.get("results", [])],
|
||||
warnings=result.get("warnings", []),
|
||||
)
|
||||
|
||||
except HTTPException:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error(f"[Links] Search failed: {e}")
|
||||
raise HTTPException(status_code=500, detail=f"Link search failed: {str(e)}")
|
||||
|
||||
|
||||
@router.post("/reword", response_model=RewordResponse)
|
||||
async def reword_with_links(
|
||||
request: RewordRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Reword text to naturally incorporate selected links."""
|
||||
user_id = require_authenticated_user(current_user)
|
||||
|
||||
if not request.links:
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail="At least one link must be provided",
|
||||
)
|
||||
|
||||
# Validate each link has a url
|
||||
for i, link in enumerate(request.links):
|
||||
if not link.get("url"):
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail=f"Link at index {i} is missing a 'url' field",
|
||||
)
|
||||
|
||||
if len(request.section_text) > 10000:
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail="section_text must be 10000 characters or less",
|
||||
)
|
||||
|
||||
service = get_link_search_service(user_id=user_id)
|
||||
|
||||
try:
|
||||
logger.info(f"[Links] Reword: heading='{request.section_heading}', links={len(request.links)}, user={user_id}")
|
||||
result = service.reword_with_links(
|
||||
section_text=request.section_text,
|
||||
links=request.links,
|
||||
section_heading=request.section_heading,
|
||||
selected_text=request.selected_text,
|
||||
user_id=user_id,
|
||||
)
|
||||
|
||||
return RewordResponse(
|
||||
reworded_text=result.get("reworded_text", request.section_text),
|
||||
warnings=result.get("warnings", []),
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"[Links] Reword failed: {e}")
|
||||
raise HTTPException(status_code=500, detail=f"Reword failed: {str(e)}")
|
||||
|
||||
|
||||
@router.get("/health")
|
||||
async def links_health():
|
||||
"""Health check for Links service."""
|
||||
return {"status": "ok", "service": "links"}
|
||||
@@ -10,7 +10,9 @@ from pathlib import Path
|
||||
from typing import Literal
|
||||
from loguru import logger
|
||||
from services.story_writer.audio_generation_service import StoryAudioGenerationService
|
||||
from services.workspace_paths import get_workspace_root, get_user_workspace_dir
|
||||
from utils.storage_paths import get_repo_root, sanitize_user_id as _sanitize_user_id
|
||||
|
||||
ROOT_DIR = get_repo_root()
|
||||
|
||||
# Video subdirectory (relative to workspace media dir)
|
||||
AI_VIDEO_SUBDIR = Path("AI_Videos")
|
||||
@@ -43,10 +45,15 @@ def get_podcast_media_dir(
|
||||
}[media_type]
|
||||
|
||||
if user_id:
|
||||
resolved_dir = (get_user_workspace_dir(user_id) / "media" / media_subdir).resolve()
|
||||
sanitized = _sanitize_user_id(user_id)
|
||||
resolved_dir = (
|
||||
ROOT_DIR / "workspace" / f"workspace_{sanitized}" / "media" / media_subdir
|
||||
).resolve()
|
||||
else:
|
||||
logger.warning(f"[Podcast] get_podcast_media_dir called without user_id for {media_type} — using default workspace. This should not happen in production.")
|
||||
resolved_dir = (get_workspace_root() / "workspace_alwrity" / "media" / media_subdir).resolve()
|
||||
resolved_dir = (
|
||||
ROOT_DIR / "workspace" / "workspace_alwrity" / "media" / media_subdir
|
||||
).resolve()
|
||||
|
||||
if ensure_exists:
|
||||
resolved_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
@@ -25,17 +25,10 @@ def _resolve_podcast_media_file(
|
||||
if not clean_filename:
|
||||
raise HTTPException(status_code=400, detail="Invalid filename")
|
||||
|
||||
# Filename must be a basename only (no path separators / traversal)
|
||||
filename_path = Path(clean_filename)
|
||||
if filename_path.name != clean_filename or clean_filename in {".", ".."}:
|
||||
raise HTTPException(status_code=400, detail="Invalid filename")
|
||||
|
||||
for base_dir in get_podcast_media_read_dirs(media_type, user_id):
|
||||
target_dir = (base_dir / subdir).resolve() if subdir else base_dir.resolve()
|
||||
candidate = (target_dir / clean_filename).resolve()
|
||||
try:
|
||||
candidate.relative_to(target_dir)
|
||||
except ValueError:
|
||||
if not str(candidate).startswith(str(target_dir)):
|
||||
logger.error(f"[Podcast] Attempted path traversal for {media_type}: {filename}")
|
||||
raise HTTPException(status_code=403, detail="Invalid media path")
|
||||
if candidate.exists():
|
||||
@@ -82,13 +75,10 @@ def load_podcast_image_bytes(image_url: str, user_id: str | None = None) -> byte
|
||||
logger.info(f"[Podcast] Loading image from URL: {image_url}")
|
||||
|
||||
try:
|
||||
parsed = urlparse(image_url)
|
||||
path = parsed.path if parsed.scheme else image_url
|
||||
|
||||
# Extract filename from API image path
|
||||
# Extract filename from URL path
|
||||
prefix = "/api/podcast/images/"
|
||||
if path.startswith(prefix):
|
||||
filename = path[len(prefix):].split("?", 1)[0].strip()
|
||||
if prefix in image_url:
|
||||
filename = image_url.split(prefix, 1)[1].split("?", 1)[0].strip()
|
||||
# Handle subdirectories like avatars/
|
||||
subdir = None
|
||||
if "/" in filename:
|
||||
|
||||
@@ -123,252 +123,3 @@ async def stripe_webhook(
|
||||
except Exception as e:
|
||||
logger.error(f"Error processing webhook: {e}")
|
||||
raise HTTPException(status_code=500, detail="Webhook processing failed")
|
||||
|
||||
@router.get("/verify-checkout/{user_id}")
|
||||
async def verify_checkout_status(
|
||||
user_id: str,
|
||||
db: Session = Depends(get_db),
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
request: Request = None
|
||||
) -> Dict[str, Any]:
|
||||
"""
|
||||
Directly query Stripe for user's current subscription status.
|
||||
Used during post-checkout polling to get fresh data without waiting for webhooks.
|
||||
|
||||
Rate limited: 5 requests per minute per user to prevent abuse.
|
||||
"""
|
||||
from ..dependencies import verify_user_access
|
||||
from models.subscription_models import UserSubscription, SubscriptionPlan, SubscriptionTier
|
||||
from services.subscription import PricingService
|
||||
from api.subscription.utils import format_plan_limits
|
||||
from datetime import datetime
|
||||
|
||||
verify_user_access(user_id, current_user)
|
||||
|
||||
# Rate limiting: 5 requests per minute per user
|
||||
now = time.time()
|
||||
window_start = now - 60 # 1 minute window
|
||||
if user_id not in _checkout_attempts_by_user:
|
||||
_checkout_attempts_by_user[user_id] = []
|
||||
attempts = _checkout_attempts_by_user[user_id]
|
||||
attempts[:] = [ts for ts in attempts if ts >= window_start]
|
||||
attempts.append(now)
|
||||
_checkout_attempts_by_user[user_id] = attempts
|
||||
|
||||
if len(attempts) > 5:
|
||||
client_ip = request.client.host if request and request.client else "unknown"
|
||||
logger.warning(f"Verify-checkout rate limit exceeded for user_id={user_id}, ip={client_ip}")
|
||||
raise HTTPException(status_code=429, detail="Too many verification requests. Please wait before trying again.")
|
||||
|
||||
stripe_service = StripeService(db)
|
||||
|
||||
try:
|
||||
# First, try to find user in local DB
|
||||
subscription = db.query(UserSubscription).filter(
|
||||
UserSubscription.user_id == user_id
|
||||
).first()
|
||||
|
||||
stripe_customer_id = subscription.stripe_customer_id if subscription else None
|
||||
|
||||
# If no stripe_customer_id in DB, try to find it by email or metadata
|
||||
if not stripe_customer_id:
|
||||
try:
|
||||
import stripe
|
||||
# Get user email from auth context
|
||||
user_email = current_user.get("email")
|
||||
if user_email:
|
||||
customers = stripe.Customer.list(email=user_email, limit=1)
|
||||
if customers and customers.data:
|
||||
stripe_customer_id = customers.data[0].id
|
||||
logger.info(f"Verify-checkout: Found Stripe customer by email for user {user_id}")
|
||||
|
||||
# Update DB with found customer ID
|
||||
if subscription:
|
||||
subscription.stripe_customer_id = stripe_customer_id
|
||||
db.commit()
|
||||
else:
|
||||
logger.info(f"Verify-checkout: No local subscription record for user {user_id}, will query Stripe directly")
|
||||
|
||||
# Fallback: search by metadata user_id (handles email mismatches)
|
||||
if not stripe_customer_id:
|
||||
customers = stripe.Customer.search(
|
||||
query=f"metadata['user_id']:'{user_id}'",
|
||||
limit=1
|
||||
)
|
||||
if customers and customers.data:
|
||||
stripe_customer_id = customers.data[0].id
|
||||
logger.info(f"Verify-checkout: Found Stripe customer by metadata user_id for user {user_id}")
|
||||
|
||||
if subscription:
|
||||
subscription.stripe_customer_id = stripe_customer_id
|
||||
db.commit()
|
||||
except Exception as lookup_err:
|
||||
logger.warning(f"Failed to find Stripe customer by email or metadata: {lookup_err}")
|
||||
|
||||
# If user has a Stripe customer ID, query Stripe directly
|
||||
if stripe_customer_id:
|
||||
try:
|
||||
import stripe
|
||||
stripe_subscriptions = stripe.Subscription.list(
|
||||
customer=stripe_customer_id,
|
||||
status="active",
|
||||
limit=1
|
||||
)
|
||||
|
||||
if stripe_subscriptions and stripe_subscriptions.data:
|
||||
stripe_sub = stripe_subscriptions.data[0]
|
||||
price_id = stripe_sub['items']['data'][0]['price']['id']
|
||||
|
||||
logger.info(f"Verify-checkout: Found active Stripe subscription for user {user_id}, plan from price {price_id}")
|
||||
|
||||
# Update local DB with fresh Stripe data
|
||||
stripe_service._update_user_subscription(
|
||||
user_id,
|
||||
stripe_customer_id=stripe_customer_id,
|
||||
stripe_subscription_id=stripe_sub.id,
|
||||
status="active",
|
||||
price_id=price_id
|
||||
)
|
||||
|
||||
# Clear caches
|
||||
try:
|
||||
PricingService.clear_user_cache(user_id)
|
||||
except Exception:
|
||||
pass
|
||||
try:
|
||||
from api.subscription.cache import clear_dashboard_cache
|
||||
clear_dashboard_cache(user_id)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
db.expire_all()
|
||||
|
||||
# Re-query with fresh data
|
||||
subscription = db.query(UserSubscription).filter(
|
||||
UserSubscription.user_id == user_id,
|
||||
UserSubscription.is_active == True
|
||||
).first()
|
||||
|
||||
if subscription:
|
||||
return {
|
||||
"success": True,
|
||||
"data": {
|
||||
"active": True,
|
||||
"plan": subscription.plan.tier.value,
|
||||
"tier": subscription.plan.tier.value,
|
||||
"can_use_api": True,
|
||||
"limits": format_plan_limits(subscription.plan),
|
||||
"source": "stripe_direct"
|
||||
}
|
||||
}
|
||||
except Exception as stripe_err:
|
||||
logger.warning(f"Failed to query Stripe directly for user {user_id}: {stripe_err}")
|
||||
|
||||
# Fallback: search Stripe subscriptions by metadata user_id (handles cases where
|
||||
# customer was created without metadata or email doesn't match)
|
||||
if not stripe_customer_id or not subscription:
|
||||
try:
|
||||
import stripe
|
||||
meta_subs = stripe.Subscription.search(
|
||||
query=f"status:'active' AND metadata['user_id']:'{user_id}'",
|
||||
limit=1
|
||||
)
|
||||
if meta_subs and meta_subs.data:
|
||||
stripe_sub = meta_subs.data[0]
|
||||
stripe_customer_id = stripe_sub.customer
|
||||
price_id = stripe_sub['items']['data'][0]['price']['id']
|
||||
|
||||
logger.info(f"Verify-checkout: Found subscription by metadata user_id for user {user_id}")
|
||||
|
||||
stripe_service._update_user_subscription(
|
||||
user_id,
|
||||
stripe_customer_id=stripe_customer_id,
|
||||
stripe_subscription_id=stripe_sub.id,
|
||||
status="active",
|
||||
price_id=price_id
|
||||
)
|
||||
|
||||
try:
|
||||
PricingService.clear_user_cache(user_id)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
db.expire_all()
|
||||
|
||||
subscription = db.query(UserSubscription).filter(
|
||||
UserSubscription.user_id == user_id,
|
||||
UserSubscription.is_active == True
|
||||
).first()
|
||||
|
||||
if subscription:
|
||||
return {
|
||||
"success": True,
|
||||
"data": {
|
||||
"active": True,
|
||||
"plan": subscription.plan.tier.value,
|
||||
"tier": subscription.plan.tier.value,
|
||||
"can_use_api": True,
|
||||
"limits": format_plan_limits(subscription.plan),
|
||||
"source": "stripe_direct_metadata"
|
||||
}
|
||||
}
|
||||
except Exception as meta_err:
|
||||
logger.warning(f"Failed to find subscription by metadata for user {user_id}: {meta_err}")
|
||||
|
||||
# Fallback to local DB status
|
||||
if subscription and subscription.is_active:
|
||||
from services.subscription.pricing_service import PricingService
|
||||
pricing = PricingService(db)
|
||||
try:
|
||||
pricing._ensure_subscription_current(subscription)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
return {
|
||||
"success": True,
|
||||
"data": {
|
||||
"active": True,
|
||||
"plan": subscription.plan.tier.value,
|
||||
"tier": subscription.plan.tier.value,
|
||||
"can_use_api": True,
|
||||
"limits": format_plan_limits(subscription.plan),
|
||||
"source": "local_db"
|
||||
}
|
||||
}
|
||||
|
||||
# No active subscription - return free tier
|
||||
free_plan = db.query(SubscriptionPlan).filter(
|
||||
SubscriptionPlan.tier == SubscriptionTier.FREE,
|
||||
SubscriptionPlan.is_active == True
|
||||
).first()
|
||||
|
||||
if free_plan:
|
||||
return {
|
||||
"success": True,
|
||||
"data": {
|
||||
"active": True,
|
||||
"plan": "free",
|
||||
"tier": "free",
|
||||
"can_use_api": True,
|
||||
"limits": format_plan_limits(free_plan),
|
||||
"source": "free_tier"
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
"success": True,
|
||||
"data": {
|
||||
"active": False,
|
||||
"plan": "none",
|
||||
"tier": "none",
|
||||
"can_use_api": False,
|
||||
"reason": "No active subscription found",
|
||||
"source": "none"
|
||||
}
|
||||
}
|
||||
|
||||
except HTTPException:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error(f"Error verifying checkout status for user {user_id}: {e}")
|
||||
raise HTTPException(status_code=500, detail=f"Failed to verify subscription: {str(e)}")
|
||||
|
||||
@@ -9,21 +9,13 @@ from fastapi.responses import HTMLResponse
|
||||
from typing import Dict, Any, Optional
|
||||
from loguru import logger
|
||||
from pydantic import BaseModel
|
||||
import os
|
||||
import uuid
|
||||
import requests
|
||||
|
||||
from services.wix_service import WixService
|
||||
from services.integrations.wix_oauth import WixOAuthService
|
||||
from services.integrations.oauth_callback_utils import (
|
||||
build_oauth_callback_html,
|
||||
sanitize_error,
|
||||
)
|
||||
from middleware.auth_middleware import get_current_user
|
||||
import os
|
||||
|
||||
router = APIRouter(prefix="/api/wix", tags=["Wix Integration"])
|
||||
qa_router = APIRouter(prefix="/api/wix/test", tags=["Wix Integration QA"])
|
||||
|
||||
|
||||
# Initialize Wix service
|
||||
wix_service = WixService()
|
||||
@@ -32,72 +24,10 @@ wix_service = WixService()
|
||||
wix_oauth_service = WixOAuthService()
|
||||
|
||||
|
||||
def _get_current_user_id(current_user: dict) -> str:
|
||||
user_id = current_user.get("id") if current_user else None
|
||||
if not user_id:
|
||||
raise HTTPException(status_code=401, detail="Missing authenticated user context")
|
||||
return user_id
|
||||
|
||||
|
||||
def _map_wix_error(exc: Exception, fallback: str = "Wix API request failed") -> HTTPException:
|
||||
if isinstance(exc, HTTPException):
|
||||
return exc
|
||||
if isinstance(exc, requests.HTTPError):
|
||||
status = exc.response.status_code if exc.response is not None else None
|
||||
msg = str(exc) if str(exc) != "" else fallback
|
||||
if status == 401:
|
||||
return HTTPException(status_code=401, detail=msg)
|
||||
if status == 403:
|
||||
return HTTPException(status_code=403, detail=msg)
|
||||
return HTTPException(status_code=502, detail=msg)
|
||||
if isinstance(exc, requests.RequestException):
|
||||
return HTTPException(status_code=502, detail=str(exc) or fallback)
|
||||
return HTTPException(status_code=500, detail=str(exc))
|
||||
|
||||
|
||||
def _resolve_valid_wix_token(current_user: dict) -> Dict[str, Any]:
|
||||
user_id = _get_current_user_id(current_user)
|
||||
tokens = wix_oauth_service.get_user_tokens(user_id)
|
||||
if tokens:
|
||||
return tokens[0]
|
||||
|
||||
token_status = wix_oauth_service.get_user_token_status(user_id)
|
||||
expired_tokens = token_status.get("expired_tokens", [])
|
||||
if not expired_tokens:
|
||||
raise HTTPException(status_code=401, detail="Wix account not connected")
|
||||
|
||||
for candidate in expired_tokens:
|
||||
refresh_token = candidate.get("refresh_token")
|
||||
token_id = candidate.get("id")
|
||||
if not refresh_token:
|
||||
continue
|
||||
try:
|
||||
refreshed = wix_service.refresh_access_token(refresh_token)
|
||||
except Exception as exc:
|
||||
continue
|
||||
|
||||
wix_oauth_service.update_tokens(
|
||||
user_id=user_id,
|
||||
access_token=refreshed.get("access_token"),
|
||||
refresh_token=refreshed.get("refresh_token", refresh_token),
|
||||
expires_in=refreshed.get("expires_in"),
|
||||
token_id=token_id,
|
||||
)
|
||||
|
||||
return {
|
||||
"access_token": refreshed.get("access_token"),
|
||||
"refresh_token": refreshed.get("refresh_token", refresh_token),
|
||||
"member_id": candidate.get("member_id"),
|
||||
"site_id": candidate.get("site_id"),
|
||||
}
|
||||
|
||||
raise HTTPException(status_code=401, detail="Wix token expired and cannot be refreshed")
|
||||
|
||||
|
||||
class WixAuthRequest(BaseModel):
|
||||
"""Request model for Wix authentication"""
|
||||
code: str
|
||||
state: str
|
||||
state: Optional[str] = None
|
||||
|
||||
|
||||
class WixPublishRequest(BaseModel):
|
||||
@@ -106,13 +36,10 @@ class WixPublishRequest(BaseModel):
|
||||
content: str
|
||||
cover_image_url: Optional[str] = None
|
||||
category_ids: Optional[list] = None
|
||||
category_names: Optional[list] = None
|
||||
tag_ids: Optional[list] = None
|
||||
tag_names: Optional[list] = None
|
||||
publish: bool = True
|
||||
# Optional access token for test-real publish flow
|
||||
access_token: Optional[str] = None
|
||||
member_id: Optional[str] = None
|
||||
seo_metadata: Optional[Dict[str, Any]] = None
|
||||
class WixCreateCategoryRequest(BaseModel):
|
||||
access_token: str
|
||||
label: str
|
||||
@@ -135,41 +62,8 @@ class WixConnectionStatus(BaseModel):
|
||||
error: Optional[str] = None
|
||||
|
||||
|
||||
def _is_wix_test_mode_enabled() -> bool:
|
||||
return os.getenv("WIX_TEST_ROUTES_ENABLED", "false").lower() in {"1", "true", "yes", "on"}
|
||||
|
||||
|
||||
def _is_admin_user(current_user: Dict[str, Any]) -> bool:
|
||||
email = (current_user.get("email") or "").lower()
|
||||
role = current_user.get("role")
|
||||
public_metadata = current_user.get("public_metadata")
|
||||
if isinstance(public_metadata, dict):
|
||||
role = public_metadata.get("role") or role
|
||||
|
||||
admin_emails = {
|
||||
e.strip().lower()
|
||||
for e in os.getenv("ADMIN_EMAILS", "").split(",")
|
||||
if e.strip()
|
||||
}
|
||||
admin_domain = (os.getenv("ADMIN_EMAIL_DOMAIN") or "").lower().strip()
|
||||
|
||||
return bool(
|
||||
role == "admin"
|
||||
or (email and email in admin_emails)
|
||||
or (email and admin_domain and email.endswith(f"@{admin_domain}"))
|
||||
)
|
||||
|
||||
|
||||
def _require_wix_test_access(current_user: Dict[str, Any] = Depends(get_current_user)) -> Dict[str, Any]:
|
||||
if not _is_wix_test_mode_enabled():
|
||||
raise HTTPException(status_code=404, detail="Not found")
|
||||
if not _is_admin_user(current_user):
|
||||
raise HTTPException(status_code=403, detail="Admin access required")
|
||||
return current_user
|
||||
|
||||
|
||||
@router.get("/auth/url")
|
||||
async def get_authorization_url(state: Optional[str] = None, current_user: dict = Depends(get_current_user)) -> Dict[str, str]:
|
||||
async def get_authorization_url(state: Optional[str] = None) -> Dict[str, str]:
|
||||
"""
|
||||
Get Wix OAuth authorization URL
|
||||
|
||||
@@ -180,21 +74,8 @@ async def get_authorization_url(state: Optional[str] = None, current_user: dict
|
||||
Authorization URL
|
||||
"""
|
||||
try:
|
||||
user_id = current_user.get('id') if current_user else None
|
||||
if not user_id:
|
||||
raise HTTPException(status_code=401, detail="Authentication required")
|
||||
|
||||
oauth_state = state or str(uuid.uuid4())
|
||||
oauth_payload = wix_service.get_authorization_url(oauth_state)
|
||||
saved = wix_oauth_service.store_pkce_verifier(
|
||||
user_id=user_id,
|
||||
state=oauth_state,
|
||||
code_verifier=oauth_payload["code_verifier"],
|
||||
ttl_seconds=600
|
||||
)
|
||||
if not saved:
|
||||
raise HTTPException(status_code=500, detail="Failed to persist OAuth verifier state")
|
||||
return {"authorization_url": oauth_payload["authorization_url"], "state": oauth_state}
|
||||
url = wix_service.get_authorization_url(state)
|
||||
return {"authorization_url": url}
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to generate authorization URL: {e}")
|
||||
raise HTTPException(status_code=500, detail=str(e))
|
||||
@@ -217,16 +98,8 @@ async def handle_oauth_callback(request: WixAuthRequest, current_user: dict = De
|
||||
if not user_id:
|
||||
raise HTTPException(status_code=400, detail="User ID not found")
|
||||
|
||||
if not request.state:
|
||||
raise HTTPException(status_code=400, detail="Missing OAuth state")
|
||||
code_verifier = wix_oauth_service.consume_pkce_verifier(user_id=user_id, state=request.state)
|
||||
if not code_verifier:
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail="Invalid or expired OAuth state. Please restart Wix connection."
|
||||
)
|
||||
# Exchange code for tokens
|
||||
tokens = wix_service.exchange_code_for_tokens(request.code, code_verifier=code_verifier)
|
||||
tokens = wix_service.exchange_code_for_tokens(request.code)
|
||||
|
||||
# Get site information to extract site_id and member_id
|
||||
site_info = wix_service.get_site_info(tokens['access_token'])
|
||||
@@ -279,38 +152,32 @@ async def handle_oauth_callback(request: WixAuthRequest, current_user: dict = De
|
||||
async def handle_oauth_callback_get(code: str, state: Optional[str] = None, request: Request = None, current_user: dict = Depends(get_current_user)):
|
||||
"""HTML callback page for Wix OAuth that exchanges code and notifies opener via postMessage."""
|
||||
try:
|
||||
user_id = current_user.get('id') if current_user else None
|
||||
if not user_id:
|
||||
raise HTTPException(status_code=401, detail="Authentication required")
|
||||
if not state:
|
||||
raise HTTPException(status_code=400, detail="Missing OAuth state")
|
||||
code_verifier = wix_oauth_service.consume_pkce_verifier(user_id=user_id, state=state)
|
||||
if not code_verifier:
|
||||
raise HTTPException(status_code=400, detail="Invalid or expired OAuth state. Please reconnect Wix.")
|
||||
tokens = wix_service.exchange_code_for_tokens(code, code_verifier=code_verifier)
|
||||
tokens = wix_service.exchange_code_for_tokens(code)
|
||||
site_info = wix_service.get_site_info(tokens['access_token'])
|
||||
permissions = wix_service.check_blog_permissions(tokens['access_token'])
|
||||
|
||||
# Store tokens in database if we have user_id
|
||||
site_id = site_info.get('siteId') or site_info.get('site_id')
|
||||
member_id = None
|
||||
try:
|
||||
member_id = wix_service.extract_member_id_from_access_token(tokens['access_token'])
|
||||
except Exception:
|
||||
pass
|
||||
user_id = current_user.get('id') if current_user else None
|
||||
if user_id:
|
||||
site_id = site_info.get('siteId') or site_info.get('site_id')
|
||||
member_id = None
|
||||
try:
|
||||
member_id = wix_service.extract_member_id_from_access_token(tokens['access_token'])
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
stored = wix_oauth_service.store_tokens(
|
||||
user_id=user_id,
|
||||
access_token=tokens['access_token'],
|
||||
refresh_token=tokens.get('refresh_token'),
|
||||
expires_in=tokens.get('expires_in'),
|
||||
token_type=tokens.get('token_type', 'Bearer'),
|
||||
scope=tokens.get('scope'),
|
||||
site_id=site_id,
|
||||
member_id=member_id
|
||||
)
|
||||
if not stored:
|
||||
logger.warning(f"Failed to store Wix tokens for user {user_id} in GET callback")
|
||||
stored = wix_oauth_service.store_tokens(
|
||||
user_id=user_id,
|
||||
access_token=tokens['access_token'],
|
||||
refresh_token=tokens.get('refresh_token'),
|
||||
expires_in=tokens.get('expires_in'),
|
||||
token_type=tokens.get('token_type', 'Bearer'),
|
||||
scope=tokens.get('scope'),
|
||||
site_id=site_id,
|
||||
member_id=member_id
|
||||
)
|
||||
if not stored:
|
||||
logger.warning(f"Failed to store Wix tokens for user {user_id} in GET callback")
|
||||
|
||||
# Build success payload for postMessage
|
||||
payload = {
|
||||
@@ -326,24 +193,45 @@ async def handle_oauth_callback_get(code: str, state: Optional[str] = None, requ
|
||||
"permissions": permissions
|
||||
}
|
||||
|
||||
html = build_oauth_callback_html(
|
||||
payload=payload,
|
||||
title="Wix Connected",
|
||||
heading="Connection Successful",
|
||||
message="Your Wix account was connected. You can close this window."
|
||||
)
|
||||
html = f"""
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head><title>Wix Connected</title></head>
|
||||
<body>
|
||||
<script>
|
||||
(function() {{
|
||||
try {{
|
||||
var payload = {payload};
|
||||
(window.opener || window.parent).postMessage(payload, '*');
|
||||
}} catch (e) {{}}
|
||||
window.close();
|
||||
}})();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
"""
|
||||
return HTMLResponse(content=html, headers={
|
||||
"Cross-Origin-Opener-Policy": "unsafe-none",
|
||||
"Cross-Origin-Embedder-Policy": "unsafe-none"
|
||||
})
|
||||
except Exception as e:
|
||||
logger.error(f"Wix OAuth GET callback failed: {e}")
|
||||
html = build_oauth_callback_html(
|
||||
payload={"type": "WIX_OAUTH_ERROR", "success": False, "error": sanitize_error(e)},
|
||||
title="Wix Connection Failed",
|
||||
heading="Connection Failed",
|
||||
message="There was an issue connecting your Wix account. You can close this window and try again."
|
||||
)
|
||||
html = f"""
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head><title>Wix Connection Failed</title></head>
|
||||
<body>
|
||||
<script>
|
||||
(function() {{
|
||||
try {{
|
||||
(window.opener || window.parent).postMessage({{ type: 'WIX_OAUTH_ERROR', success: false, error: '{str(e)}' }}, '*');
|
||||
}} catch (e) {{}}
|
||||
window.close();
|
||||
}})();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
"""
|
||||
return HTMLResponse(content=html, headers={
|
||||
"Cross-Origin-Opener-Policy": "unsafe-none",
|
||||
"Cross-Origin-Embedder-Policy": "unsafe-none"
|
||||
@@ -351,134 +239,130 @@ async def handle_oauth_callback_get(code: str, state: Optional[str] = None, requ
|
||||
|
||||
|
||||
@router.get("/connection/status")
|
||||
async def get_connection_status(current_user: dict = Depends(get_current_user)) -> Dict[str, Any]:
|
||||
async def get_connection_status(current_user: dict = Depends(get_current_user)) -> WixConnectionStatus:
|
||||
"""
|
||||
Check Wix connection status and permissions.
|
||||
Returns connected: false when no tokens are stored (instead of 401).
|
||||
Check Wix connection status and permissions
|
||||
|
||||
Args:
|
||||
current_user: Current authenticated user
|
||||
|
||||
Returns:
|
||||
Connection status and permissions
|
||||
"""
|
||||
try:
|
||||
token_info = _resolve_valid_wix_token(current_user)
|
||||
access_token = token_info["access_token"]
|
||||
site_info = wix_service.get_site_info(access_token)
|
||||
permissions = wix_service.check_blog_permissions(access_token)
|
||||
return {
|
||||
"connected": True,
|
||||
"has_permissions": permissions.get("has_permissions", False),
|
||||
"site_info": site_info,
|
||||
"permissions": permissions
|
||||
}
|
||||
except HTTPException as e:
|
||||
if e.status_code == 401:
|
||||
return {"connected": False, "has_permissions": False, "error": "Wix account not connected"}
|
||||
raise
|
||||
# Check if user has Wix tokens stored in sessionStorage (frontend approach)
|
||||
# This is a simplified check - in production you'd store tokens in database
|
||||
return WixConnectionStatus(
|
||||
connected=False,
|
||||
has_permissions=False,
|
||||
error="No Wix connection found. Please connect your Wix account first."
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to check connection status: {e}")
|
||||
return {"connected": False, "has_permissions": False, "error": "Unable to check Wix connection"}
|
||||
return WixConnectionStatus(
|
||||
connected=False,
|
||||
has_permissions=False,
|
||||
error=str(e)
|
||||
)
|
||||
|
||||
|
||||
@router.get("/status")
|
||||
async def get_wix_status(current_user: dict = Depends(get_current_user)) -> Dict[str, Any]:
|
||||
"""
|
||||
Get Wix connection status (similar to GSC/WordPress pattern)
|
||||
Note: Wix tokens are stored in frontend sessionStorage, so we can't directly check them here.
|
||||
The frontend will check sessionStorage and update the UI accordingly.
|
||||
"""
|
||||
try:
|
||||
token_info = _resolve_valid_wix_token(current_user)
|
||||
site_info = wix_service.get_site_info(token_info["access_token"])
|
||||
# Since Wix tokens are stored in frontend sessionStorage (not backend database),
|
||||
# we return a default response. The frontend will check sessionStorage directly.
|
||||
return {
|
||||
"connected": True,
|
||||
"sites": [site_info],
|
||||
"total_sites": 1,
|
||||
"site_info": site_info
|
||||
"connected": False,
|
||||
"sites": [],
|
||||
"total_sites": 0,
|
||||
"error": "Wix connection status managed by frontend sessionStorage"
|
||||
}
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to get Wix status: {e}")
|
||||
mapped = _map_wix_error(e, "Failed to get Wix status")
|
||||
raise mapped
|
||||
return {
|
||||
"connected": False,
|
||||
"sites": [],
|
||||
"total_sites": 0,
|
||||
"error": str(e)
|
||||
}
|
||||
|
||||
|
||||
@router.post("/publish")
|
||||
async def publish_to_wix(request: WixPublishRequest, current_user: dict = Depends(get_current_user)) -> Dict[str, Any]:
|
||||
"""
|
||||
Publish blog post to Wix using server-stored OAuth tokens.
|
||||
Publish blog post to Wix
|
||||
|
||||
The backend resolves the access token from the database (via
|
||||
_resolve_valid_wix_token), so callers do NOT need to pass
|
||||
access_token unless they want to override the stored one.
|
||||
Args:
|
||||
request: Blog post data
|
||||
current_user: Current authenticated user
|
||||
|
||||
Returns:
|
||||
Published blog post information
|
||||
"""
|
||||
try:
|
||||
if request.access_token:
|
||||
from services.integrations.wix.utils import normalize_token_string
|
||||
access_token = normalize_token_string(request.access_token)
|
||||
else:
|
||||
try:
|
||||
token_info = _resolve_valid_wix_token(current_user)
|
||||
access_token = token_info["access_token"]
|
||||
except HTTPException:
|
||||
access_token = None
|
||||
# TODO: Retrieve stored access token from database for current_user
|
||||
# For now, we'll return an error asking user to connect first
|
||||
|
||||
if not access_token:
|
||||
return {
|
||||
"success": False,
|
||||
"error": "Wix account not connected. Connect your Wix account first.",
|
||||
}
|
||||
|
||||
member_id = request.member_id
|
||||
if not member_id:
|
||||
member_id = wix_service.extract_member_id_from_access_token(access_token)
|
||||
if not member_id:
|
||||
member_info = wix_service.get_current_member(access_token)
|
||||
member_id = (member_info.get("member") or {}).get("id") or member_info.get("id")
|
||||
if not member_id:
|
||||
return {
|
||||
"success": False,
|
||||
"error": "Unable to resolve Wix member ID. Please reconnect your Wix account.",
|
||||
}
|
||||
|
||||
# Resolve categories: accept IDs or names (looked up/created)
|
||||
category_ids = request.category_ids or request.category_names
|
||||
tag_ids = request.tag_ids or request.tag_names
|
||||
|
||||
seo_metadata = request.seo_metadata
|
||||
if seo_metadata:
|
||||
if not category_ids and seo_metadata.get("blog_categories"):
|
||||
category_ids = seo_metadata.get("blog_categories")
|
||||
if not tag_ids and seo_metadata.get("blog_tags"):
|
||||
tag_ids = seo_metadata.get("blog_tags")
|
||||
|
||||
# Ensure category_ids and tag_ids are lists of strings (not ints)
|
||||
if category_ids:
|
||||
category_ids = [str(c) for c in category_ids if c is not None]
|
||||
if tag_ids:
|
||||
tag_ids = [str(t) for t in tag_ids if t is not None]
|
||||
|
||||
result = wix_service.create_blog_post(
|
||||
access_token=access_token,
|
||||
title=request.title,
|
||||
content=request.content,
|
||||
cover_image_url=request.cover_image_url,
|
||||
category_ids=category_ids,
|
||||
tag_ids=tag_ids,
|
||||
publish=request.publish,
|
||||
member_id=member_id,
|
||||
seo_metadata=seo_metadata,
|
||||
)
|
||||
post = result.get("draftPost") or result.get("post") or result
|
||||
raw_url = post.get("url")
|
||||
if isinstance(raw_url, dict):
|
||||
post_url = raw_url.get("base", "").rstrip("/") + "/" + raw_url.get("path", "").lstrip("/")
|
||||
elif isinstance(raw_url, str):
|
||||
post_url = raw_url
|
||||
else:
|
||||
post_url = None
|
||||
return {
|
||||
"success": True,
|
||||
"post_id": str(post.get("id", "")),
|
||||
"url": post_url,
|
||||
"publish_state": "PUBLISHED" if request.publish else "DRAFT"
|
||||
"success": False,
|
||||
"error": "Wix account not connected. Please connect your Wix account first.",
|
||||
"message": "Use the /api/wix/auth/url endpoint to get the authorization URL"
|
||||
}
|
||||
|
||||
# Example of what the actual implementation would look like:
|
||||
# access_token = get_stored_access_token(current_user['id'])
|
||||
#
|
||||
# if not access_token:
|
||||
# raise HTTPException(status_code=401, detail="Wix account not connected")
|
||||
#
|
||||
# # Check if token is still valid, refresh if needed
|
||||
# try:
|
||||
# site_info = wix_service.get_site_info(access_token)
|
||||
# except:
|
||||
# # Token expired, try to refresh
|
||||
# refresh_token = get_stored_refresh_token(current_user['id'])
|
||||
# if refresh_token:
|
||||
# new_tokens = wix_service.refresh_access_token(refresh_token)
|
||||
# access_token = new_tokens['access_token']
|
||||
# # Store new tokens
|
||||
# else:
|
||||
# raise HTTPException(status_code=401, detail="Wix session expired. Please reconnect.")
|
||||
#
|
||||
# # Get current member ID (required for third-party apps)
|
||||
# member_info = wix_service.get_current_member(access_token)
|
||||
# member_id = member_info.get('member', {}).get('id')
|
||||
#
|
||||
# if not member_id:
|
||||
# raise HTTPException(status_code=400, detail="Could not retrieve member ID")
|
||||
#
|
||||
# # Create blog post
|
||||
# result = wix_service.create_blog_post(
|
||||
# access_token=access_token,
|
||||
# title=request.title,
|
||||
# content=request.content,
|
||||
# cover_image_url=request.cover_image_url,
|
||||
# category_ids=request.category_ids,
|
||||
# tag_ids=request.tag_ids,
|
||||
# publish=request.publish,
|
||||
# member_id=member_id # Required for third-party apps
|
||||
# )
|
||||
#
|
||||
# return {
|
||||
# "success": True,
|
||||
# "post_id": result.get('draftPost', {}).get('id'),
|
||||
# "url": result.get('draftPost', {}).get('url'),
|
||||
# "message": "Blog post published successfully to Wix"
|
||||
# }
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to publish to Wix: {e}")
|
||||
raise _map_wix_error(e, "Failed to publish to Wix")
|
||||
raise HTTPException(status_code=500, detail=str(e))
|
||||
|
||||
|
||||
@router.get("/categories")
|
||||
@@ -493,15 +377,23 @@ async def get_blog_categories(current_user: dict = Depends(get_current_user)) ->
|
||||
List of blog categories
|
||||
"""
|
||||
try:
|
||||
token_info = _resolve_valid_wix_token(current_user)
|
||||
categories = wix_service.get_blog_categories(token_info["access_token"])
|
||||
# TODO: Retrieve stored access token from database for current_user
|
||||
return {
|
||||
"success": True,
|
||||
"categories": categories
|
||||
"success": False,
|
||||
"error": "Wix account not connected. Please connect your Wix account first."
|
||||
}
|
||||
|
||||
# Example implementation:
|
||||
# access_token = get_stored_access_token(current_user['id'])
|
||||
# if not access_token:
|
||||
# raise HTTPException(status_code=401, detail="Wix account not connected")
|
||||
#
|
||||
# categories = wix_service.get_blog_categories(access_token)
|
||||
# return {"categories": categories}
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to get blog categories: {e}")
|
||||
raise _map_wix_error(e, "Failed to fetch Wix blog categories")
|
||||
raise HTTPException(status_code=500, detail=str(e))
|
||||
|
||||
|
||||
@router.get("/tags")
|
||||
@@ -516,15 +408,23 @@ async def get_blog_tags(current_user: dict = Depends(get_current_user)) -> Dict[
|
||||
List of blog tags
|
||||
"""
|
||||
try:
|
||||
token_info = _resolve_valid_wix_token(current_user)
|
||||
tags = wix_service.get_blog_tags(token_info["access_token"])
|
||||
# TODO: Retrieve stored access token from database for current_user
|
||||
return {
|
||||
"success": True,
|
||||
"tags": tags
|
||||
"success": False,
|
||||
"error": "Wix account not connected. Please connect your Wix account first."
|
||||
}
|
||||
|
||||
# Example implementation:
|
||||
# access_token = get_stored_access_token(current_user['id'])
|
||||
# if not access_token:
|
||||
# raise HTTPException(status_code=401, detail="Wix account not connected")
|
||||
#
|
||||
# tags = wix_service.get_blog_tags(access_token)
|
||||
# return {"tags": tags}
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to get blog tags: {e}")
|
||||
raise _map_wix_error(e, "Failed to fetch Wix blog tags")
|
||||
raise HTTPException(status_code=500, detail=str(e))
|
||||
|
||||
|
||||
@router.post("/disconnect")
|
||||
@@ -539,30 +439,23 @@ async def disconnect_wix(current_user: dict = Depends(get_current_user)) -> Dict
|
||||
Disconnection status
|
||||
"""
|
||||
try:
|
||||
user_id = _get_current_user_id(current_user)
|
||||
token_status = wix_oauth_service.get_user_token_status(user_id)
|
||||
all_tokens = token_status.get("active_tokens", []) + token_status.get("expired_tokens", [])
|
||||
for token in all_tokens:
|
||||
token_id = token.get("id")
|
||||
if token_id:
|
||||
wix_oauth_service.revoke_token(user_id, token_id)
|
||||
# TODO: Remove stored tokens from database for current_user
|
||||
return {
|
||||
"success": True,
|
||||
"connected": False,
|
||||
"message": "Wix account disconnected successfully"
|
||||
}
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to disconnect Wix: {e}")
|
||||
raise _map_wix_error(e, "Failed to disconnect Wix account")
|
||||
raise HTTPException(status_code=500, detail=str(e))
|
||||
|
||||
|
||||
# =============================================================================
|
||||
# TEST ENDPOINTS - No authentication required for testing
|
||||
# =============================================================================
|
||||
|
||||
@qa_router.get("/connection/status")
|
||||
async def get_test_connection_status(_: Dict[str, Any] = Depends(_require_wix_test_access)) -> WixConnectionStatus:
|
||||
@router.get("/test/connection/status")
|
||||
async def get_test_connection_status() -> WixConnectionStatus:
|
||||
"""
|
||||
TEST ENDPOINT: Check Wix connection status without authentication
|
||||
|
||||
@@ -587,8 +480,8 @@ async def get_test_connection_status(_: Dict[str, Any] = Depends(_require_wix_te
|
||||
)
|
||||
|
||||
|
||||
@qa_router.get("/auth/url")
|
||||
async def get_test_authorization_url(state: Optional[str] = None, _: Dict[str, Any] = Depends(_require_wix_test_access)) -> Dict[str, str]:
|
||||
@router.get("/test/auth/url")
|
||||
async def get_test_authorization_url(state: Optional[str] = None) -> Dict[str, str]:
|
||||
"""
|
||||
TEST ENDPOINT: Get Wix OAuth authorization URL without authentication
|
||||
|
||||
@@ -618,15 +511,15 @@ async def get_test_authorization_url(state: Optional[str] = None, _: Dict[str, A
|
||||
"message": "WIX_CLIENT_ID not configured. Please set it in your .env file to get a real authorization URL."
|
||||
}
|
||||
|
||||
auth_payload = wix_service.get_authorization_url(state)
|
||||
return {"url": auth_payload.get("authorization_url", ""), "state": state or "test_state"}
|
||||
auth_url = wix_service.get_authorization_url(state)
|
||||
return {"url": auth_url, "state": state or "test_state"}
|
||||
except Exception as e:
|
||||
logger.error(f"TEST: Failed to generate authorization URL: {e}")
|
||||
raise HTTPException(status_code=500, detail=str(e))
|
||||
|
||||
|
||||
@qa_router.post("/publish")
|
||||
async def test_publish_to_wix(request: WixPublishRequest, _: Dict[str, Any] = Depends(_require_wix_test_access)) -> Dict[str, Any]:
|
||||
@router.post("/test/publish")
|
||||
async def test_publish_to_wix(request: WixPublishRequest) -> Dict[str, Any]:
|
||||
"""
|
||||
TEST ENDPOINT: Simulate publishing a blog post to Wix without authentication.
|
||||
|
||||
@@ -646,44 +539,28 @@ async def test_publish_to_wix(request: WixPublishRequest, _: Dict[str, Any] = De
|
||||
|
||||
|
||||
@router.post("/refresh-token")
|
||||
async def refresh_wix_token(current_user: dict = Depends(get_current_user)) -> Dict[str, Any]:
|
||||
async def refresh_wix_token(request: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""
|
||||
Refresh Wix access token using stored refresh token.
|
||||
Refresh Wix access token using refresh token
|
||||
|
||||
Args:
|
||||
current_user: Current authenticated user
|
||||
request: Dict containing refresh_token
|
||||
|
||||
Returns:
|
||||
New token information with access_token, refresh_token, expires_in
|
||||
"""
|
||||
try:
|
||||
user_id = _get_current_user_id(current_user)
|
||||
token_status = wix_oauth_service.get_user_token_status(user_id)
|
||||
all_tokens = token_status.get("active_tokens", []) + token_status.get("expired_tokens", [])
|
||||
|
||||
refresh_token = None
|
||||
token_id = None
|
||||
for t in all_tokens:
|
||||
if t.get("refresh_token"):
|
||||
refresh_token = t["refresh_token"]
|
||||
token_id = t["id"]
|
||||
break
|
||||
|
||||
refresh_token = request.get("refresh_token")
|
||||
if not refresh_token:
|
||||
raise HTTPException(status_code=400, detail="No refresh token found. Please reconnect your Wix account.")
|
||||
raise HTTPException(status_code=400, detail="Missing refresh_token")
|
||||
|
||||
# Refresh the token
|
||||
new_tokens = wix_service.refresh_access_token(refresh_token)
|
||||
|
||||
wix_oauth_service.update_tokens(
|
||||
user_id=user_id,
|
||||
access_token=new_tokens.get("access_token"),
|
||||
refresh_token=new_tokens.get("refresh_token", refresh_token),
|
||||
expires_in=new_tokens.get("expires_in"),
|
||||
token_id=token_id,
|
||||
)
|
||||
|
||||
return {
|
||||
"success": True,
|
||||
"access_token": new_tokens.get("access_token"),
|
||||
"refresh_token": new_tokens.get("refresh_token"),
|
||||
"expires_in": new_tokens.get("expires_in"),
|
||||
"token_type": new_tokens.get("token_type", "Bearer")
|
||||
}
|
||||
@@ -691,11 +568,11 @@ async def refresh_wix_token(current_user: dict = Depends(get_current_user)) -> D
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to refresh Wix token: {e}")
|
||||
raise _map_wix_error(e, "Failed to refresh token")
|
||||
raise HTTPException(status_code=500, detail=f"Failed to refresh token: {str(e)}")
|
||||
|
||||
|
||||
@qa_router.post("/publish/real")
|
||||
async def test_publish_real(payload: Dict[str, Any], _: Dict[str, Any] = Depends(_require_wix_test_access)) -> Dict[str, Any]:
|
||||
@router.post("/test/publish/real")
|
||||
async def test_publish_real(payload: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""
|
||||
TEST ENDPOINT: Perform a real publish to Wix using a provided access token.
|
||||
|
||||
@@ -763,6 +640,7 @@ async def test_publish_real(payload: Dict[str, Any], _: Dict[str, Any] = Depends
|
||||
"post_id": (result.get("draftPost") or result.get("post") or {}).get("id"),
|
||||
"url": (result.get("draftPost") or result.get("post") or {}).get("url"),
|
||||
"message": "Blog post published to Wix",
|
||||
"raw": result,
|
||||
}
|
||||
except HTTPException:
|
||||
raise
|
||||
@@ -771,8 +649,8 @@ async def test_publish_real(payload: Dict[str, Any], _: Dict[str, Any] = Depends
|
||||
raise HTTPException(status_code=500, detail=str(e))
|
||||
|
||||
|
||||
@qa_router.post("/category")
|
||||
async def test_create_category(request: WixCreateCategoryRequest, _: Dict[str, Any] = Depends(_require_wix_test_access)) -> Dict[str, Any]:
|
||||
@router.post("/test/category")
|
||||
async def test_create_category(request: WixCreateCategoryRequest) -> Dict[str, Any]:
|
||||
try:
|
||||
result = wix_service.create_category(
|
||||
access_token=request.access_token,
|
||||
@@ -786,8 +664,8 @@ async def test_create_category(request: WixCreateCategoryRequest, _: Dict[str, A
|
||||
raise HTTPException(status_code=500, detail=str(e))
|
||||
|
||||
|
||||
@qa_router.post("/tag")
|
||||
async def test_create_tag(request: WixCreateTagRequest, _: Dict[str, Any] = Depends(_require_wix_test_access)) -> Dict[str, Any]:
|
||||
@router.post("/test/tag")
|
||||
async def test_create_tag(request: WixCreateTagRequest) -> Dict[str, Any]:
|
||||
try:
|
||||
result = wix_service.create_tag(
|
||||
access_token=request.access_token,
|
||||
|
||||
@@ -12,7 +12,6 @@ router = APIRouter(prefix="/api/writing-assistant", tags=["writing-assistant"])
|
||||
|
||||
class SuggestRequest(BaseModel):
|
||||
text: str
|
||||
cursor_position: int | None = None
|
||||
|
||||
|
||||
class SourceModel(BaseModel):
|
||||
@@ -33,7 +32,6 @@ class SuggestionModel(BaseModel):
|
||||
class SuggestResponse(BaseModel):
|
||||
success: bool
|
||||
suggestions: List[SuggestionModel]
|
||||
message: str = ""
|
||||
|
||||
|
||||
assistant_service = WritingAssistantService()
|
||||
@@ -43,9 +41,9 @@ assistant_service = WritingAssistantService()
|
||||
async def suggest_endpoint(req: SuggestRequest, current_user: Dict[str, Any] = Depends(get_current_user)) -> SuggestResponse:
|
||||
try:
|
||||
user_id = current_user.get("id")
|
||||
suggestions = await assistant_service.suggest(req.text, user_id=user_id, cursor_position=req.cursor_position)
|
||||
suggestions = await assistant_service.suggest(req.text, user_id=user_id)
|
||||
return SuggestResponse(
|
||||
success=len(suggestions) > 0,
|
||||
success=True,
|
||||
suggestions=[
|
||||
SuggestionModel(
|
||||
text=s.text,
|
||||
@@ -57,8 +55,6 @@ async def suggest_endpoint(req: SuggestRequest, current_user: Dict[str, Any] = D
|
||||
for s in suggestions
|
||||
],
|
||||
)
|
||||
except HTTPException:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error(f"Writing assistant error: {e}")
|
||||
raise HTTPException(status_code=500, detail=str(e))
|
||||
|
||||
@@ -459,7 +459,14 @@ async def start_video_render(
|
||||
try:
|
||||
user_id = require_authenticated_user(current_user)
|
||||
|
||||
# Filter enabled scenes FIRST so we can validate credits for the actual count
|
||||
# Validate subscription limits
|
||||
pricing_service = PricingService(db)
|
||||
validate_scene_animation_operation(
|
||||
pricing_service=pricing_service,
|
||||
user_id=user_id
|
||||
)
|
||||
|
||||
# Filter enabled scenes
|
||||
enabled_scenes = [s for s in request.scenes if s.get("enabled", True)]
|
||||
if not enabled_scenes:
|
||||
return VideoRenderResponse(
|
||||
@@ -467,14 +474,6 @@ async def start_video_render(
|
||||
message="No enabled scenes to render"
|
||||
)
|
||||
|
||||
# Validate subscription limits for ALL scenes in the batch
|
||||
pricing_service = PricingService(db)
|
||||
validate_scene_animation_operation(
|
||||
pricing_service=pricing_service,
|
||||
user_id=user_id,
|
||||
scene_count=len(enabled_scenes),
|
||||
)
|
||||
|
||||
# VALIDATION: Pre-validate scenes before creating task to prevent wasted API calls
|
||||
validation_errors = []
|
||||
for scene in enabled_scenes:
|
||||
|
||||
@@ -138,7 +138,6 @@ if _is_full_mode():
|
||||
from routers.image_studio import router as image_studio_router
|
||||
from routers.product_marketing import router as product_marketing_router
|
||||
from routers.campaign_creator import router as campaign_creator_router
|
||||
from routers.backlink_outreach import router as backlink_outreach_router
|
||||
else:
|
||||
# In feature-only modes, only load essential assets router
|
||||
from api.assets_serving import router as assets_serving_router
|
||||
@@ -147,28 +146,14 @@ else:
|
||||
image_studio_router = None
|
||||
product_marketing_router = None
|
||||
campaign_creator_router = None
|
||||
backlink_outreach_router = None
|
||||
|
||||
# Import hallucination detector router
|
||||
try:
|
||||
# Import hallucination detector router (skip in feature-only modes - triggers heavy ML)
|
||||
if _is_full_mode():
|
||||
from api.hallucination_detector import router as hallucination_detector_router
|
||||
except Exception as e:
|
||||
logger.warning(f"Failed to import hallucination_detector router: {e}")
|
||||
from api.writing_assistant import router as writing_assistant_router
|
||||
else:
|
||||
hallucination_detector_router = None
|
||||
|
||||
# Import charts router (shared chart generation for blog writer, podcast, etc.)
|
||||
try:
|
||||
from api.charts import router as charts_router
|
||||
except Exception as e:
|
||||
logger.warning(f"Failed to import charts router: {e}")
|
||||
charts_router = None
|
||||
|
||||
# Import links router (internal & external link search and rewording)
|
||||
try:
|
||||
from api.links import router as links_router
|
||||
except Exception as e:
|
||||
logger.warning(f"Failed to import links router: {e}")
|
||||
links_router = None
|
||||
writing_assistant_router = None
|
||||
|
||||
# Import research configuration router (skip in feature-only modes)
|
||||
if _is_full_mode():
|
||||
@@ -501,18 +486,10 @@ else:
|
||||
"reason": f"Feature-only mode: {enabled_features}",
|
||||
}
|
||||
|
||||
# Safety net: explicitly include hallucination detector (import may fail gracefully)
|
||||
# Safety net: explicitly include hallucination detector (router_manager may skip silently)
|
||||
if hallucination_detector_router:
|
||||
router_manager.include_router_safely(hallucination_detector_router, "hallucination_detector")
|
||||
|
||||
# Include charts router (shared chart generation)
|
||||
if charts_router:
|
||||
router_manager.include_router_safely(charts_router, "charts")
|
||||
|
||||
# Include links router (internal & external link search)
|
||||
if links_router:
|
||||
router_manager.include_router_safely(links_router, "links")
|
||||
|
||||
# Log startup summary
|
||||
router_manager.log_startup_summary()
|
||||
|
||||
@@ -672,9 +649,6 @@ if _is_full_mode():
|
||||
# Include Bing Analytics Storage router to expose storage-backed endpoints
|
||||
from routers.bing_analytics_storage import router as bing_analytics_storage_router
|
||||
app.include_router(bing_analytics_storage_router)
|
||||
# Include SEO Tools router with enterprise audit and GSC analysis
|
||||
if seo_tools_router:
|
||||
app.include_router(seo_tools_router)
|
||||
if images_router:
|
||||
app.include_router(images_router)
|
||||
if image_studio_router:
|
||||
@@ -683,9 +657,10 @@ if _is_full_mode():
|
||||
app.include_router(product_marketing_router)
|
||||
if campaign_creator_router:
|
||||
app.include_router(campaign_creator_router)
|
||||
if backlink_outreach_router:
|
||||
app.include_router(backlink_outreach_router)
|
||||
|
||||
# Include content assets router
|
||||
from api.content_assets.router import router as content_assets_router
|
||||
app.include_router(content_assets_router)
|
||||
router_group_status["platform_extensions"] = {
|
||||
"mounted": True,
|
||||
"reason": "Full mode",
|
||||
@@ -696,10 +671,6 @@ else:
|
||||
"reason": "Skipped in feature-only mode",
|
||||
}
|
||||
|
||||
# Include content assets router (always — core utility, not feature-specific)
|
||||
from api.content_assets.router import router as content_assets_router
|
||||
app.include_router(content_assets_router)
|
||||
|
||||
# Include Podcast Maker router (only when podcast feature is enabled)
|
||||
if _is_feature_enabled("podcast") and "all" not in get_enabled_features():
|
||||
from api.podcast.router import router as podcast_router
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
# Backlink Migration Audit (Legacy vs Current)
|
||||
|
||||
Legacy prototype reference:
|
||||
- `ToBeMigrated/ai_marketing_tools/ai_backlinker/ai_backlinking.py`
|
||||
- `ToBeMigrated/ai_marketing_tools/ai_backlinker/backlinking_ui_streamlit.py`
|
||||
|
||||
## Implemented in current branch
|
||||
|
||||
- Canonical backend entrypoint with backlink-specific naming:
|
||||
- `backend/routers/backlink_outreach.py`
|
||||
- `backend/services/backlink_outreach_service.py`
|
||||
- Legacy-style guest-post query template generation exposed over API:
|
||||
- `GET /api/backlink-outreach/query-templates?keyword=<keyword>`
|
||||
- Migration traceability metadata endpoints:
|
||||
- `GET /api/backlink-outreach/modules`
|
||||
- `GET /api/backlink-outreach/migration-coverage`
|
||||
- Frontend integration points with backlink-specific naming:
|
||||
- `frontend/src/api/backlinkOutreachApi.ts`
|
||||
- `frontend/src/stores/backlinkOutreachStore.ts`
|
||||
- `frontend/src/components/SEODashboard/BacklinkOutreachModuleList.tsx`
|
||||
|
||||
## Not yet migrated (planned)
|
||||
|
||||
- Live web prospect discovery / scraping execution loop (`find_backlink_opportunities`).
|
||||
- Outreach email sending + reply monitoring loop (`send_email`, IMAP checks).
|
||||
- End-to-end campaign orchestration from keyword batch -> outreach -> follow-up.
|
||||
|
||||
## Notes
|
||||
|
||||
This branch intentionally provides a clean migration seam and auditable entrypoints first.
|
||||
Feature-complete parity can now be implemented incrementally behind these stable backend and frontend contracts.
|
||||
@@ -16,15 +16,6 @@ EXA_API_KEY=your_exa_api_key_here
|
||||
|
||||
# Frontend URL for OAuth callbacks
|
||||
FRONTEND_URL=https://alwrity-ai.vercel.app
|
||||
# Optional comma-separated allowlist of trusted frontend origins used for OAuth callback postMessage targetOrigin.
|
||||
# If unset, FRONTEND_URL origin is used.
|
||||
# Example: OAUTH_CALLBACK_ALLOWED_ORIGINS=https://alwrity-ai.vercel.app,http://localhost:3000
|
||||
OAUTH_CALLBACK_ALLOWED_ORIGINS=
|
||||
|
||||
# OAuth Token Encryption (Fernet key - generate with: python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())")
|
||||
# Used by both WordPress and Wix OAuth token encryption at rest.
|
||||
# WORDPRESS_TOKEN_ENCRYPTION_KEY and WIX_TOKEN_ENCRYPTION_KEY can override per-provider.
|
||||
OAUTH_TOKEN_ENCRYPTION_KEY=
|
||||
|
||||
# OAuth Redirect URIs (Using environment variable for flexibility)
|
||||
GSC_REDIRECT_URI=${FRONTEND_URL}/gsc/callback
|
||||
|
||||
@@ -77,13 +77,10 @@ from api.images import router as images_router
|
||||
from routers.image_studio import router as image_studio_router
|
||||
from routers.product_marketing import router as product_marketing_router
|
||||
from routers.campaign_creator import router as campaign_creator_router
|
||||
from routers.backlink_outreach import router as backlink_outreach_router
|
||||
|
||||
# Import hallucination detector router
|
||||
from api.hallucination_detector import router as hallucination_detector_router
|
||||
from api.writing_assistant import router as writing_assistant_router
|
||||
from api.charts import router as charts_router
|
||||
from api.links import router as links_router
|
||||
|
||||
# Import research configuration router
|
||||
from api.research_config import router as research_config_router
|
||||
@@ -257,10 +254,6 @@ router_manager.include_core_routers()
|
||||
router_manager.include_router_safely(subscription_router, "subscription")
|
||||
# Include hallucination detector explicitly (router_manager may skip silently on import failure)
|
||||
router_manager.include_router_safely(hallucination_detector_router, "hallucination_detector")
|
||||
# Include charts router (shared chart generation for blog writer, podcast, etc.)
|
||||
router_manager.include_router_safely(charts_router, "charts")
|
||||
# Include links router (internal & external link search and rewording)
|
||||
router_manager.include_router_safely(links_router, "links")
|
||||
router_manager.include_optional_routers()
|
||||
|
||||
# SEO Dashboard endpoints
|
||||
@@ -403,7 +396,6 @@ app.include_router(images_router)
|
||||
app.include_router(image_studio_router)
|
||||
app.include_router(product_marketing_router)
|
||||
app.include_router(campaign_creator_router)
|
||||
app.include_router(backlink_outreach_router)
|
||||
|
||||
# Include content assets router
|
||||
from api.content_assets.router import router as content_assets_router
|
||||
|
||||
@@ -1,134 +0,0 @@
|
||||
"""DB models for production backlink outreach tracking."""
|
||||
|
||||
from datetime import datetime
|
||||
from sqlalchemy import Column, String, Integer, Float, DateTime, Text, ForeignKey, Index, Boolean, Date
|
||||
from sqlalchemy.ext.declarative import declarative_base
|
||||
|
||||
Base = declarative_base()
|
||||
|
||||
|
||||
class BacklinkCampaign(Base):
|
||||
__tablename__ = "backlink_campaigns"
|
||||
id = Column(String(64), primary_key=True)
|
||||
user_id = Column(String(255), nullable=False, index=True)
|
||||
workspace_id = Column(String(255), nullable=False, index=True)
|
||||
name = Column(String(255), nullable=False)
|
||||
status = Column(String(32), nullable=False, default="drafted", index=True)
|
||||
created_at = Column(DateTime, default=datetime.utcnow, index=True)
|
||||
|
||||
|
||||
class BacklinkLead(Base):
|
||||
__tablename__ = "backlink_leads"
|
||||
id = Column(String(64), primary_key=True)
|
||||
campaign_id = Column(String(64), ForeignKey("backlink_campaigns.id"), nullable=False, index=True)
|
||||
url = Column(String(1024), nullable=True)
|
||||
domain = Column(String(255), nullable=False, index=True)
|
||||
page_title = Column(String(512), nullable=True)
|
||||
snippet = Column(Text, nullable=True)
|
||||
email = Column(String(255), nullable=True, index=True)
|
||||
confidence_score = Column(Float, nullable=True, default=0.0)
|
||||
discovery_source = Column(String(32), nullable=True, default="duckduckgo")
|
||||
status = Column(String(32), nullable=False, default="discovered", index=True)
|
||||
notes = Column(Text, nullable=True)
|
||||
created_at = Column(DateTime, default=datetime.utcnow, index=True)
|
||||
|
||||
|
||||
class OutreachAttempt(Base):
|
||||
__tablename__ = "backlink_outreach_attempts"
|
||||
id = Column(String(64), primary_key=True)
|
||||
lead_id = Column(String(64), ForeignKey("backlink_leads.id"), nullable=False, index=True)
|
||||
campaign_id = Column(String(64), ForeignKey("backlink_campaigns.id"), nullable=False, index=True)
|
||||
idempotency_key = Column(String(128), nullable=False, unique=True, index=True)
|
||||
sender_email = Column(String(255), nullable=True)
|
||||
subject = Column(String(512), nullable=True)
|
||||
body = Column(Text, nullable=True)
|
||||
status = Column(String(32), nullable=False, default="queued", index=True)
|
||||
decision_reason = Column(Text, nullable=True)
|
||||
sent_at = Column(DateTime, nullable=True)
|
||||
created_at = Column(DateTime, default=datetime.utcnow, index=True)
|
||||
|
||||
|
||||
class OutreachReply(Base):
|
||||
__tablename__ = "backlink_replies"
|
||||
id = Column(String(64), primary_key=True)
|
||||
attempt_id = Column(String(64), ForeignKey("backlink_outreach_attempts.id"), nullable=False, index=True)
|
||||
from_email = Column(String(255), nullable=True)
|
||||
subject = Column(String(512), nullable=True)
|
||||
received_at = Column(DateTime, default=datetime.utcnow, index=True)
|
||||
classification = Column(String(32), nullable=False, default="replied")
|
||||
body = Column(Text, nullable=True)
|
||||
|
||||
|
||||
class FollowUpSchedule(Base):
|
||||
__tablename__ = "backlink_followup_schedules"
|
||||
id = Column(String(64), primary_key=True)
|
||||
attempt_id = Column(String(64), ForeignKey("backlink_outreach_attempts.id"), nullable=False, index=True)
|
||||
subject = Column(String(512), nullable=True)
|
||||
body = Column(Text, nullable=True)
|
||||
scheduled_for = Column(DateTime, nullable=False, index=True)
|
||||
sent = Column(Boolean, default=False, index=True)
|
||||
|
||||
|
||||
class EmailTemplate(Base):
|
||||
__tablename__ = "backlink_email_templates"
|
||||
id = Column(String(64), primary_key=True)
|
||||
user_id = Column(String(255), nullable=False, index=True)
|
||||
name = Column(String(128), nullable=False)
|
||||
subject_template = Column(String(512), nullable=False)
|
||||
body_template = Column(Text, nullable=False)
|
||||
variables = Column(Text, nullable=True)
|
||||
created_at = Column(DateTime, default=datetime.utcnow)
|
||||
|
||||
|
||||
class SuppressedRecipient(Base):
|
||||
__tablename__ = "backlink_suppressed_recipients"
|
||||
id = Column(String(64), primary_key=True)
|
||||
email = Column(String(255), nullable=False, index=True)
|
||||
domain = Column(String(255), nullable=True)
|
||||
reason = Column(String(128), nullable=True)
|
||||
user_id = Column(String(255), nullable=True)
|
||||
created_at = Column(DateTime, default=datetime.utcnow)
|
||||
|
||||
|
||||
class SentIdempotencyKey(Base):
|
||||
__tablename__ = "backlink_sent_idempotency_keys"
|
||||
id = Column(String(64), primary_key=True)
|
||||
idempotency_key = Column(String(128), nullable=False, unique=True, index=True)
|
||||
user_id = Column(String(255), nullable=False)
|
||||
created_at = Column(DateTime, default=datetime.utcnow)
|
||||
|
||||
|
||||
class AuditLogEntry(Base):
|
||||
__tablename__ = "backlink_audit_logs"
|
||||
id = Column(String(64), primary_key=True)
|
||||
user_id = Column(String(255), nullable=False, index=True)
|
||||
campaign_id = Column(String(64), nullable=True)
|
||||
event = Column(String(64), nullable=False, index=True)
|
||||
recipient = Column(String(255), nullable=True)
|
||||
allowed = Column(Boolean, nullable=True)
|
||||
reasons = Column(Text, nullable=True)
|
||||
override = Column(Boolean, default=False)
|
||||
created_at = Column(DateTime, default=datetime.utcnow, index=True)
|
||||
|
||||
|
||||
class SendCounterUser(Base):
|
||||
__tablename__ = "backlink_send_counters_user"
|
||||
id = Column(String(64), primary_key=True)
|
||||
user_id = Column(String(255), nullable=False, index=True)
|
||||
date = Column(Date, nullable=False, index=True)
|
||||
count = Column(Integer, default=0)
|
||||
|
||||
|
||||
class SendCounterDomain(Base):
|
||||
__tablename__ = "backlink_send_counters_domain"
|
||||
id = Column(String(64), primary_key=True)
|
||||
domain = Column(String(255), nullable=False, index=True)
|
||||
date = Column(Date, nullable=False, index=True)
|
||||
count = Column(Integer, default=0)
|
||||
|
||||
|
||||
Index("idx_backlink_campaign_user_date", BacklinkCampaign.user_id, BacklinkCampaign.created_at)
|
||||
Index("idx_backlink_attempt_campaign_date", OutreachAttempt.campaign_id, OutreachAttempt.created_at)
|
||||
Index("idx_backlink_suppressed_email", SuppressedRecipient.email, SuppressedRecipient.user_id)
|
||||
Index("idx_backlink_counter_user_date", SendCounterUser.user_id, SendCounterUser.date, unique=True)
|
||||
Index("idx_backlink_counter_domain_date", SendCounterDomain.domain, SendCounterDomain.date, unique=True)
|
||||
@@ -157,9 +157,6 @@ class BlogOutlineSection(BaseModel):
|
||||
references: List[ResearchSource] = []
|
||||
target_words: Optional[int] = None
|
||||
keywords: List[str] = []
|
||||
chart_data: Optional[Dict[str, Any]] = None
|
||||
chart_url: Optional[str] = None
|
||||
chart_id: Optional[str] = None
|
||||
|
||||
|
||||
class BlogOutlineRequest(BaseModel):
|
||||
|
||||
@@ -1,663 +0,0 @@
|
||||
"""Backlink outreach router with Clerk auth."""
|
||||
|
||||
from typing import Dict, Any
|
||||
from fastapi import APIRouter, Depends, Query, HTTPException
|
||||
from fastapi.responses import Response
|
||||
|
||||
from services.backlink_outreach_models import (
|
||||
BacklinkDiscoveryResponse, BacklinkKeywordInput, DeepKeywordInput,
|
||||
LeadCreateRequest, LeadStatusUpdateRequest,
|
||||
PolicyValidationRequest, PolicyValidationResponse,
|
||||
SendOutreachRequest, SendOutreachResponse,
|
||||
OutreachAttemptListResponse, OutreachAttemptRecord,
|
||||
OutreachReplyListResponse, OutreachReplyRecord,
|
||||
ScheduleFollowUpRequest, FollowUpScheduleRecord,
|
||||
EmailTemplateRequest, EmailTemplateRecord,
|
||||
GenerateEmailRequest, GeneratedEmailResponse,
|
||||
PersonalizeEmailRequest, SubjectLinesRequest, SubjectLinesResponse,
|
||||
FollowUpRequest,
|
||||
BacklinkReportingSnapshot,
|
||||
CampaignAnalyticsResponse, CampaignVolumeResponse,
|
||||
ConversionFunnelResponse, BulkStatusUpdateRequest, BulkStatusUpdateResponse,
|
||||
SuppressionAddRequest,
|
||||
)
|
||||
from services.backlink_outreach_service import backlink_outreach_service
|
||||
from services.backlink_outreach_storage import BacklinkOutreachStorageService
|
||||
from services.backlink_outreach_sender import backlink_outreach_sender
|
||||
from services.backlink_outreach_reply_monitor import backlink_outreach_reply_monitor
|
||||
from services.backlink_outreach_template_generator import (
|
||||
generate_outreach_email,
|
||||
generate_personalized_email,
|
||||
generate_subject_lines,
|
||||
generate_follow_up,
|
||||
)
|
||||
from middleware.auth_middleware import get_current_user
|
||||
from pydantic import BaseModel, Field
|
||||
|
||||
router = APIRouter(prefix="/api/backlink-outreach", tags=["backlink-outreach"])
|
||||
|
||||
|
||||
class BacklinkCampaignCreateRequest(BaseModel):
|
||||
workspace_id: str = Field(..., min_length=1)
|
||||
name: str = Field(..., min_length=3)
|
||||
|
||||
|
||||
def _resolve_user_id(current_user: Dict[str, Any]) -> str:
|
||||
return current_user.get("id") or current_user.get("clerk_user_id") or "default"
|
||||
|
||||
|
||||
# -- Auth-Required Endpoints --
|
||||
|
||||
@router.get("/modules")
|
||||
async def get_backlink_module_registry(
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
return {"feature": "backlink_outreach", "modules": backlink_outreach_service.list_backlink_modules()}
|
||||
|
||||
|
||||
@router.get("/query-templates")
|
||||
async def get_backlink_query_templates(
|
||||
keyword: str = Query(..., min_length=1),
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
return {"keyword": keyword, "queries": backlink_outreach_service.generate_guest_post_queries(keyword)}
|
||||
|
||||
|
||||
@router.post("/discover", response_model=BacklinkDiscoveryResponse)
|
||||
async def discover_backlink_opportunities(
|
||||
payload: BacklinkKeywordInput,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
return backlink_outreach_service.discover_opportunities(payload.keyword, payload.max_results)
|
||||
|
||||
|
||||
@router.get("/migration-coverage")
|
||||
async def get_backlink_migration_coverage(
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
return backlink_outreach_service.get_migration_coverage()
|
||||
|
||||
|
||||
# -- Auth-Required Endpoints --
|
||||
|
||||
@router.post("/discover/deep")
|
||||
async def discover_deep_backlink_opportunities(
|
||||
payload: DeepKeywordInput,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Enhanced discovery using Exa neural search + DuckDuckGo with full-page scraping."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
result = await backlink_outreach_service.deep_discover(payload.keyword, payload.max_results)
|
||||
if payload.campaign_id:
|
||||
storage = BacklinkOutreachStorageService()
|
||||
saved = 0
|
||||
save_failed = 0
|
||||
for opp in result.get("opportunities", []):
|
||||
try:
|
||||
storage.add_lead(
|
||||
campaign_id=payload.campaign_id,
|
||||
user_id=user_id,
|
||||
url=opp["url"],
|
||||
domain=opp["domain"],
|
||||
page_title=opp.get("page_title", ""),
|
||||
snippet=opp.get("snippet", ""),
|
||||
email=opp.get("email"),
|
||||
confidence_score=opp.get("confidence_score", 0.0),
|
||||
discovery_source=opp.get("discovery_source", "duckduckgo"),
|
||||
)
|
||||
saved += 1
|
||||
except Exception:
|
||||
save_failed += 1
|
||||
result["saved_to_campaign"] = saved
|
||||
result["save_failed"] = save_failed
|
||||
return result
|
||||
|
||||
|
||||
@router.post("/campaigns")
|
||||
async def create_backlink_campaign(
|
||||
payload: BacklinkCampaignCreateRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
return storage.create_campaign(user_id, payload.workspace_id, payload.name)
|
||||
|
||||
|
||||
@router.get("/campaigns")
|
||||
async def list_backlink_campaigns(
|
||||
workspace_id: str = Query(None),
|
||||
limit: int = 50,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
return {"campaigns": storage.list_campaigns(user_id, workspace_id or user_id, limit)}
|
||||
|
||||
|
||||
@router.get("/campaigns/{campaign_id}")
|
||||
async def get_backlink_campaign(
|
||||
campaign_id: str,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Get campaign detail with leads."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
campaign = storage.get_campaign(campaign_id, user_id)
|
||||
if not campaign:
|
||||
raise HTTPException(status_code=404, detail="Campaign not found")
|
||||
return campaign
|
||||
|
||||
|
||||
@router.get("/campaigns/{campaign_id}/leads")
|
||||
async def list_campaign_leads(
|
||||
campaign_id: str,
|
||||
status: str = Query(None),
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""List leads for a campaign, optionally filtered by status."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
leads = storage.list_leads(campaign_id, user_id, status=status or None)
|
||||
return {"leads": leads, "total": len(leads)}
|
||||
|
||||
|
||||
@router.post("/campaigns/{campaign_id}/leads")
|
||||
async def add_campaign_lead(
|
||||
campaign_id: str,
|
||||
payload: LeadCreateRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Add a single lead to a campaign."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
try:
|
||||
lead = storage.add_lead(
|
||||
campaign_id=campaign_id,
|
||||
user_id=user_id,
|
||||
url=payload.url,
|
||||
domain=payload.domain,
|
||||
page_title=payload.page_title or "",
|
||||
snippet=payload.snippet or "",
|
||||
email=payload.email,
|
||||
confidence_score=payload.confidence_score,
|
||||
notes=payload.notes,
|
||||
)
|
||||
return lead
|
||||
except Exception as e:
|
||||
raise HTTPException(status_code=500, detail="Failed to add lead")
|
||||
|
||||
|
||||
@router.post("/leads/bulk-status", response_model=BulkStatusUpdateResponse)
|
||||
async def bulk_update_lead_status(
|
||||
payload: BulkStatusUpdateRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Bulk update lead statuses."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
updated = 0
|
||||
failed: list[str] = []
|
||||
for lid in payload.lead_ids:
|
||||
try:
|
||||
lead = storage.update_lead_status(lid, user_id, payload.status, payload.notes)
|
||||
if lead:
|
||||
updated += 1
|
||||
else:
|
||||
failed.append(lid)
|
||||
except Exception:
|
||||
failed.append(lid)
|
||||
return BulkStatusUpdateResponse(updated=updated, failed=failed)
|
||||
|
||||
|
||||
@router.patch("/leads/{lead_id}/status")
|
||||
async def update_lead_status(
|
||||
lead_id: str,
|
||||
payload: LeadStatusUpdateRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Update lead status (discovered -> contacted -> replied -> placed)."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
lead = storage.update_lead_status(lead_id, user_id, payload.status, payload.notes)
|
||||
if not lead:
|
||||
raise HTTPException(status_code=404, detail="Lead not found")
|
||||
return lead
|
||||
|
||||
|
||||
@router.post("/policy-validate", response_model=PolicyValidationResponse)
|
||||
async def validate_outreach_policy(
|
||||
payload: PolicyValidationRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
return backlink_outreach_service.validate_send_policy(payload)
|
||||
|
||||
|
||||
@router.get("/reporting", response_model=BacklinkReportingSnapshot)
|
||||
async def get_backlink_reporting_snapshot(
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
user_id = _resolve_user_id(current_user)
|
||||
return backlink_outreach_service.get_reporting_snapshot(user_id=user_id)
|
||||
|
||||
|
||||
# -- Outreach Attempts --
|
||||
|
||||
@router.post("/send-outreach", response_model=SendOutreachResponse)
|
||||
async def send_outreach(
|
||||
payload: SendOutreachRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Validate policy, record attempt, personalize, and send email."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
subject = payload.subject
|
||||
body = payload.body
|
||||
|
||||
if payload.template_id:
|
||||
tmpl = storage.get_template(payload.template_id, user_id)
|
||||
if tmpl:
|
||||
variables = payload.template_variables or {}
|
||||
subject = backlink_outreach_sender.personalize(tmpl.get("subject_template", subject), variables)
|
||||
body = backlink_outreach_sender.personalize(tmpl.get("body_template", body), variables)
|
||||
|
||||
result = backlink_outreach_service.send_outreach(
|
||||
SendOutreachRequest(
|
||||
lead_id=payload.lead_id,
|
||||
campaign_id=payload.campaign_id,
|
||||
user_id=user_id,
|
||||
workspace_id=payload.workspace_id,
|
||||
sender_email=payload.sender_email,
|
||||
subject=subject,
|
||||
body=body,
|
||||
idempotency_key=payload.idempotency_key,
|
||||
)
|
||||
)
|
||||
|
||||
lead_email = ""
|
||||
if result.attempt_id:
|
||||
lead = storage.get_lead(payload.lead_id, user_id=user_id)
|
||||
lead_email = (lead.get("email") or "") if lead else ""
|
||||
|
||||
if result.policy_allowed and lead_email:
|
||||
sent = await backlink_outreach_sender.send_email(
|
||||
to_email=lead_email,
|
||||
subject=subject,
|
||||
body=body,
|
||||
)
|
||||
status = "sent" if sent else "failed"
|
||||
storage.update_attempt_status(result.attempt_id, status, user_id=user_id)
|
||||
result.status = status
|
||||
if sent:
|
||||
storage.mark_idempotency(payload.idempotency_key, user_id)
|
||||
storage.increment_user_send_counter(user_id)
|
||||
domain = lead_email.split("@")[-1] if "@" in lead_email else "unknown"
|
||||
storage.increment_domain_send_counter(domain, user_id=user_id)
|
||||
elif result.policy_allowed and not lead_email:
|
||||
storage.update_attempt_status(result.attempt_id, "failed", user_id=user_id)
|
||||
result.status = "failed"
|
||||
result.policy_reasons = (result.policy_reasons or []) + ["lead_has_no_email"]
|
||||
|
||||
return result
|
||||
|
||||
|
||||
@router.get("/campaigns/{campaign_id}/attempts", response_model=OutreachAttemptListResponse)
|
||||
async def list_campaign_attempts(
|
||||
campaign_id: str,
|
||||
limit: int = Query(50),
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""List outreach attempts for a campaign."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
attempts = storage.list_attempts(campaign_id, limit, user_id=user_id)
|
||||
return {"attempts": attempts, "total": len(attempts)}
|
||||
|
||||
|
||||
# -- Replies --
|
||||
|
||||
@router.get("/campaigns/{campaign_id}/replies", response_model=OutreachReplyListResponse)
|
||||
async def list_campaign_replies(
|
||||
campaign_id: str,
|
||||
limit: int = Query(50),
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""List received replies for a campaign."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
replies = storage.list_replies(campaign_id, limit, user_id=user_id)
|
||||
return {"replies": replies, "total": len(replies)}
|
||||
|
||||
|
||||
@router.post("/replies/poll")
|
||||
async def poll_replies(
|
||||
sent_from_email: str = Query(..., min_length=3),
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Poll IMAP inbox for new replies and store them."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
if not backlink_outreach_reply_monitor.is_configured():
|
||||
raise HTTPException(status_code=503, detail="IMAP not configured")
|
||||
|
||||
storage = BacklinkOutreachStorageService()
|
||||
raw_replies = await backlink_outreach_reply_monitor.poll_replies(sent_from_email)
|
||||
stored = []
|
||||
skipped = 0
|
||||
failed = 0
|
||||
for raw in raw_replies:
|
||||
try:
|
||||
from_email = raw.get("from_email", "")
|
||||
subject = raw.get("subject", "")
|
||||
if storage.reply_exists(from_email, subject, user_id=user_id):
|
||||
skipped += 1
|
||||
continue
|
||||
attempt_id = storage.find_attempt_by_from_email(from_email, user_id=user_id) or ""
|
||||
reply = storage.add_reply(
|
||||
attempt_id=attempt_id,
|
||||
from_email=from_email,
|
||||
subject=subject,
|
||||
body=raw.get("body", ""),
|
||||
classification=raw.get("classification", "replied"),
|
||||
user_id=user_id,
|
||||
)
|
||||
stored.append(reply)
|
||||
except Exception:
|
||||
failed += 1
|
||||
return {"polled": len(raw_replies), "stored": len(stored), "skipped": skipped, "failed": failed, "replies": stored}
|
||||
|
||||
|
||||
# -- Follow-ups --
|
||||
|
||||
@router.post("/campaigns/{campaign_id}/schedule-followup")
|
||||
async def schedule_followup(
|
||||
campaign_id: str,
|
||||
payload: ScheduleFollowUpRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Schedule a follow-up for an outreach attempt."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
sched = storage.schedule_followup(
|
||||
attempt_id=payload.attempt_id,
|
||||
scheduled_for=payload.scheduled_for,
|
||||
subject=payload.subject or "",
|
||||
body=payload.body or "",
|
||||
user_id=user_id,
|
||||
)
|
||||
return {"campaign_id": campaign_id, "schedule": sched}
|
||||
|
||||
|
||||
@router.get("/campaigns/{campaign_id}/followups")
|
||||
async def list_followups(
|
||||
campaign_id: str,
|
||||
limit: int = Query(50),
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""List scheduled follow-ups for a campaign."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
followups = storage.list_followups(campaign_id, limit, user_id=user_id)
|
||||
return {"followups": followups, "total": len(followups)}
|
||||
|
||||
|
||||
# -- Email Templates --
|
||||
|
||||
@router.post("/templates")
|
||||
async def create_template(
|
||||
payload: EmailTemplateRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Create an email template."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
return storage.create_template(
|
||||
user_id=user_id,
|
||||
name=payload.name,
|
||||
subject_template=payload.subject_template,
|
||||
body_template=payload.body_template,
|
||||
variables=payload.variables,
|
||||
)
|
||||
|
||||
|
||||
@router.get("/templates")
|
||||
async def list_templates(
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""List email templates for the authenticated user."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
return {"templates": storage.list_templates(user_id)}
|
||||
|
||||
|
||||
@router.get("/templates/{template_id}")
|
||||
async def get_template(
|
||||
template_id: str,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Get a specific email template."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
tmpl = storage.get_template(template_id, user_id)
|
||||
if not tmpl:
|
||||
raise HTTPException(status_code=404, detail="Template not found")
|
||||
return tmpl
|
||||
|
||||
|
||||
@router.delete("/templates/{template_id}")
|
||||
async def delete_template(
|
||||
template_id: str,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Delete an email template."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
if not storage.delete_template(template_id, user_id):
|
||||
raise HTTPException(status_code=404, detail="Template not found")
|
||||
return {"deleted": True}
|
||||
|
||||
|
||||
@router.post("/templates/generate", response_model=GeneratedEmailResponse)
|
||||
async def generate_email_template(
|
||||
payload: GenerateEmailRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Generate an outreach email using AI."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
existing_body = None
|
||||
if payload.existing_template_id:
|
||||
storage = BacklinkOutreachStorageService()
|
||||
tmpl = storage.get_template(payload.existing_template_id, user_id)
|
||||
if tmpl:
|
||||
existing_body = tmpl.get("body_template")
|
||||
|
||||
result = generate_outreach_email(
|
||||
topic=payload.topic,
|
||||
target_site=payload.target_site,
|
||||
tone=payload.tone,
|
||||
user_id=user_id,
|
||||
existing_body=existing_body,
|
||||
)
|
||||
return result
|
||||
|
||||
|
||||
@router.post("/generate/personalized", response_model=GeneratedEmailResponse)
|
||||
async def generate_personalized_email_endpoint(
|
||||
payload: PersonalizeEmailRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Personalize an outreach email for a specific lead."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
result = generate_personalized_email(
|
||||
lead_name=payload.lead_name,
|
||||
lead_site=payload.lead_site,
|
||||
lead_content_topic=payload.lead_content_topic,
|
||||
pitch_topic=payload.pitch_topic,
|
||||
existing_body=payload.existing_body,
|
||||
user_id=user_id,
|
||||
)
|
||||
return result
|
||||
|
||||
|
||||
@router.post("/generate/subject-lines", response_model=SubjectLinesResponse)
|
||||
async def generate_subject_lines_endpoint(
|
||||
payload: SubjectLinesRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Generate subject line suggestions for an email body."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
subjects = generate_subject_lines(
|
||||
body=payload.body,
|
||||
count=payload.count,
|
||||
user_id=user_id,
|
||||
)
|
||||
return {"subjects": subjects}
|
||||
|
||||
|
||||
@router.post("/generate/follow-up", response_model=GeneratedEmailResponse)
|
||||
async def generate_follow_up_endpoint(
|
||||
payload: FollowUpRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Generate a follow-up email for an outreach attempt."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
result = generate_follow_up(
|
||||
original_subject=payload.original_subject,
|
||||
original_body=payload.original_body,
|
||||
days_elapsed=payload.days_elapsed,
|
||||
reply_context=payload.reply_context,
|
||||
user_id=user_id,
|
||||
)
|
||||
return result
|
||||
|
||||
|
||||
# -- Suppression --
|
||||
|
||||
@router.get("/suppression")
|
||||
async def list_suppression(
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""List suppressed recipients."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
return {"suppressed": storage.list_suppressed(user_id)}
|
||||
|
||||
|
||||
@router.post("/suppression")
|
||||
async def add_suppression(
|
||||
payload: SuppressionAddRequest,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Add a recipient to the suppression list."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
return storage.add_suppressed(email=payload.email, domain=payload.domain, reason=payload.reason, user_id=user_id)
|
||||
|
||||
|
||||
@router.get("/campaigns/{campaign_id}/analytics/volume", response_model=CampaignVolumeResponse)
|
||||
async def get_campaign_analytics_volume(
|
||||
campaign_id: str,
|
||||
days: int = Query(30, ge=1, le=365),
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Get daily send volume for a campaign over the last N days."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
return backlink_outreach_service.get_campaign_volume(campaign_id, days, user_id=user_id)
|
||||
|
||||
|
||||
@router.get("/campaigns/{campaign_id}/analytics/funnel", response_model=ConversionFunnelResponse)
|
||||
async def get_campaign_analytics_funnel(
|
||||
campaign_id: str,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Get conversion funnel (lead status breakdown) for a campaign."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
return backlink_outreach_service.get_campaign_funnel(campaign_id, user_id=user_id)
|
||||
|
||||
|
||||
@router.get("/campaigns/{campaign_id}/export/leads")
|
||||
async def export_campaign_leads_csv(
|
||||
campaign_id: str,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Export campaign leads as CSV."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
csv_content = backlink_outreach_service.export_leads_csv(campaign_id, user_id=user_id)
|
||||
return Response(content=csv_content, media_type="text/csv",
|
||||
headers={"Content-Disposition": f"attachment; filename=leads_{campaign_id}.csv"})
|
||||
|
||||
|
||||
@router.get("/campaigns/{campaign_id}/export/attempts")
|
||||
async def export_campaign_attempts_csv(
|
||||
campaign_id: str,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Export campaign outreach attempts as CSV."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
csv_content = backlink_outreach_service.export_attempts_csv(campaign_id, user_id=user_id)
|
||||
return Response(content=csv_content, media_type="text/csv",
|
||||
headers={"Content-Disposition": f"attachment; filename=attempts_{campaign_id}.csv"})
|
||||
|
||||
|
||||
@router.get("/campaigns/{campaign_id}/export/replies")
|
||||
async def export_campaign_replies_csv(
|
||||
campaign_id: str,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Export campaign replies as CSV."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
csv_content = backlink_outreach_service.export_replies_csv(campaign_id, user_id=user_id)
|
||||
return Response(content=csv_content, media_type="text/csv",
|
||||
headers={"Content-Disposition": f"attachment; filename=replies_{campaign_id}.csv"})
|
||||
|
||||
|
||||
# -- Audit Log --
|
||||
|
||||
@router.get("/audit-logs")
|
||||
async def list_audit_logs(
|
||||
campaign_id: str = Query(None),
|
||||
limit: int = Query(100),
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""List audit log entries, optionally filtered by campaign."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
return {"logs": storage.list_audit_logs(campaign_id or None, limit, user_id=user_id)}
|
||||
|
||||
|
||||
# -- Analytics --
|
||||
|
||||
@router.get("/campaigns/{campaign_id}/analytics", response_model=CampaignAnalyticsResponse)
|
||||
async def get_campaign_analytics(
|
||||
campaign_id: str,
|
||||
current_user: Dict[str, Any] = Depends(get_current_user),
|
||||
):
|
||||
"""Get campaign analytics: send volume, response/placement rates, reply breakdown."""
|
||||
user_id = _resolve_user_id(current_user)
|
||||
storage = BacklinkOutreachStorageService()
|
||||
campaign = storage.get_campaign(campaign_id, user_id)
|
||||
if not campaign:
|
||||
raise HTTPException(status_code=404, detail="Campaign not found")
|
||||
|
||||
attempts = storage.list_attempts(campaign_id, user_id=user_id)
|
||||
replies = storage.list_replies(campaign_id, user_id=user_id)
|
||||
leads = storage.list_leads_all(campaign_id, user_id=user_id)
|
||||
|
||||
total_sent = sum(1 for a in attempts if a.get("status") == "sent")
|
||||
total_blocked = sum(1 for a in attempts if a.get("status") == "blocked")
|
||||
total_replied = len(replies)
|
||||
total_placed = sum(1 for l in leads if l.get("status") == "placed")
|
||||
|
||||
reply_classification = {}
|
||||
for r in replies:
|
||||
cls = r.get("classification", "replied")
|
||||
reply_classification[cls] = reply_classification.get(cls, 0) + 1
|
||||
|
||||
return CampaignAnalyticsResponse(
|
||||
campaign_id=campaign_id,
|
||||
lead_count=campaign.get("lead_count", 0),
|
||||
send_volume=total_sent,
|
||||
blocked_count=total_blocked,
|
||||
reply_count=total_replied,
|
||||
response_rate=round(total_replied / total_sent, 4) if total_sent > 0 else 0.0,
|
||||
placement_rate=round(total_placed / campaign.get("lead_count", 1), 4) if campaign.get("lead_count", 0) > 0 else 0.0,
|
||||
reply_classification=reply_classification,
|
||||
)
|
||||
@@ -8,7 +8,6 @@ from loguru import logger
|
||||
import os
|
||||
|
||||
from services.gsc_service import GSCService
|
||||
from services.gsc_brainstorm_service import GSCBrainstormService
|
||||
from middleware.auth_middleware import get_current_user
|
||||
|
||||
# Initialize router
|
||||
@@ -16,7 +15,6 @@ router = APIRouter(prefix="/gsc", tags=["Google Search Console"])
|
||||
|
||||
# Initialize GSC service
|
||||
gsc_service = GSCService()
|
||||
brainstorm_service = GSCBrainstormService(gsc_service)
|
||||
|
||||
# Pydantic models
|
||||
class GSCAnalyticsRequest(BaseModel):
|
||||
@@ -24,10 +22,6 @@ class GSCAnalyticsRequest(BaseModel):
|
||||
start_date: Optional[str] = None
|
||||
end_date: Optional[str] = None
|
||||
|
||||
class GSCBrainstormRequest(BaseModel):
|
||||
keywords: str
|
||||
site_url: Optional[str] = None
|
||||
|
||||
class GSCStatusResponse(BaseModel):
|
||||
connected: bool
|
||||
sites: Optional[List[Dict[str, Any]]] = None
|
||||
@@ -76,22 +70,12 @@ async def handle_gsc_callback(
|
||||
|
||||
success = gsc_service.handle_oauth_callback(code, state)
|
||||
|
||||
# If state verification failed, check if user is already connected
|
||||
# (handles duplicate callbacks where state was consumed by a prior request)
|
||||
if not success:
|
||||
user_id_from_state = state.split(':')[0] if ':' in state else None
|
||||
if user_id_from_state:
|
||||
existing_creds = gsc_service.load_user_credentials(user_id_from_state)
|
||||
if existing_creds:
|
||||
logger.info(f"GSC OAuth state already consumed, but user {user_id_from_state} has valid credentials — treating as success")
|
||||
success = True
|
||||
|
||||
if success:
|
||||
logger.info("GSC OAuth callback handled successfully")
|
||||
|
||||
# Create GSC insights task immediately after successful connection
|
||||
try:
|
||||
from services.database import get_session_for_user
|
||||
from services.database import SessionLocal
|
||||
from services.platform_insights_monitoring_service import create_platform_insights_task
|
||||
|
||||
# Get user_id from state (stored during OAuth flow)
|
||||
@@ -99,24 +83,23 @@ async def handle_gsc_callback(
|
||||
user_id = state.split(':')[0] if ':' in state else None
|
||||
|
||||
if user_id:
|
||||
db = get_session_for_user(user_id)
|
||||
if db:
|
||||
try:
|
||||
task_result = create_platform_insights_task(
|
||||
user_id=user_id,
|
||||
platform='gsc',
|
||||
site_url=None,
|
||||
db=db
|
||||
)
|
||||
db = SessionLocal()
|
||||
try:
|
||||
# Create insights task without site_url to avoid API calls
|
||||
# The executor will fetch it when the task runs (weekly)
|
||||
task_result = create_platform_insights_task(
|
||||
user_id=user_id,
|
||||
platform='gsc',
|
||||
site_url=None, # Will be fetched by executor when task runs
|
||||
db=db
|
||||
)
|
||||
|
||||
if task_result.get('success'):
|
||||
logger.info(f"Created GSC insights task for user {user_id}")
|
||||
else:
|
||||
logger.warning(f"Failed to create GSC insights task: {task_result.get('error')}")
|
||||
finally:
|
||||
db.close()
|
||||
else:
|
||||
logger.warning(f"Could not create DB session for user {user_id}")
|
||||
if task_result.get('success'):
|
||||
logger.info(f"Created GSC insights task for user {user_id}")
|
||||
else:
|
||||
logger.warning(f"Failed to create GSC insights task: {task_result.get('error')}")
|
||||
finally:
|
||||
db.close()
|
||||
else:
|
||||
logger.warning(f"Could not extract user_id from state: {state}")
|
||||
except Exception as e:
|
||||
@@ -136,10 +119,7 @@ async def handle_gsc_callback(
|
||||
</body>
|
||||
</html>
|
||||
"""
|
||||
return HTMLResponse(
|
||||
content=html,
|
||||
headers={"Cross-Origin-Opener-Policy": "unsafe-none"},
|
||||
)
|
||||
return HTMLResponse(content=html)
|
||||
else:
|
||||
logger.error("Failed to handle GSC OAuth callback")
|
||||
html = """
|
||||
@@ -154,11 +134,7 @@ async def handle_gsc_callback(
|
||||
</body>
|
||||
</html>
|
||||
"""
|
||||
return HTMLResponse(
|
||||
status_code=400,
|
||||
content=html,
|
||||
headers={"Cross-Origin-Opener-Policy": "unsafe-none"},
|
||||
)
|
||||
return HTMLResponse(status_code=400, content=html)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Error handling GSC OAuth callback: {e}")
|
||||
@@ -175,11 +151,7 @@ async def handle_gsc_callback(
|
||||
</body>
|
||||
</html>
|
||||
"""
|
||||
return HTMLResponse(
|
||||
status_code=500,
|
||||
content=html,
|
||||
headers={"Cross-Origin-Opener-Policy": "unsafe-none"},
|
||||
)
|
||||
return HTMLResponse(status_code=500, content=html)
|
||||
|
||||
@router.get("/sites")
|
||||
async def get_gsc_sites(user: dict = Depends(get_current_user)):
|
||||
@@ -227,49 +199,6 @@ async def get_gsc_analytics(
|
||||
logger.error(f"Error getting GSC analytics: {e}")
|
||||
raise HTTPException(status_code=500, detail=f"Error getting analytics: {str(e)}")
|
||||
|
||||
@router.post("/brainstorm")
|
||||
async def brainstorm_topics(
|
||||
request: GSCBrainstormRequest,
|
||||
user: dict = Depends(get_current_user),
|
||||
):
|
||||
"""Brainstorm blog topic suggestions based on the user's GSC data.
|
||||
|
||||
The user must have GSC connected. If no site_url is provided,
|
||||
the first verified site is used automatically.
|
||||
"""
|
||||
try:
|
||||
user_id = user.get('id')
|
||||
if not user_id:
|
||||
raise HTTPException(status_code=400, detail="User ID not found")
|
||||
|
||||
tokens = request.keywords.strip().split()
|
||||
if len(tokens) < 3:
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail="Please provide at least 3 words for brainstorming topic suggestions.",
|
||||
)
|
||||
|
||||
logger.info(f"GSC brainstorm for user: {user_id}, keywords: {request.keywords!r}")
|
||||
|
||||
result = brainstorm_service.brainstorm_topics(
|
||||
user_id=user_id,
|
||||
keywords=request.keywords,
|
||||
site_url=request.site_url,
|
||||
)
|
||||
|
||||
if "error" in result and not result.get("content_opportunities"):
|
||||
status = 400 if "No GSC sites" in result["error"] else 500
|
||||
raise HTTPException(status_code=status, detail=result["error"])
|
||||
|
||||
logger.info(f"GSC brainstorm completed for user: {user_id}")
|
||||
return result
|
||||
|
||||
except HTTPException:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error(f"Error in GSC brainstorm: {e}")
|
||||
raise HTTPException(status_code=500, detail=f"Error brainstorming topics: {str(e)}")
|
||||
|
||||
@router.get("/sitemaps/{site_url:path}")
|
||||
async def get_gsc_sitemaps(
|
||||
site_url: str,
|
||||
|
||||
@@ -63,8 +63,8 @@ async def save_to_library(
|
||||
file_path = assets_dir / filename
|
||||
file_path.write_bytes(image_bytes)
|
||||
|
||||
# Build serving URL (assets_serving.py serves /{user_id}/images/{filename})
|
||||
file_url = f"/api/assets/{safe_user}/images/{filename}"
|
||||
# Build serving URL (assets_serving.py serves /{user_id}/avatars/{filename})
|
||||
file_url = f"/api/assets/{safe_user}/avatars/{filename}"
|
||||
|
||||
# Save to unified asset library via existing utility
|
||||
from utils.asset_tracker import save_asset_to_library
|
||||
|
||||
@@ -142,11 +142,11 @@ async def serve_transform_video(
|
||||
detail="Invalid video path: path traversal detected"
|
||||
)
|
||||
|
||||
if not resolved_video_path.exists():
|
||||
if not video_path.exists():
|
||||
raise HTTPException(status_code=404, detail="Video not found")
|
||||
|
||||
return FileResponse(
|
||||
path=str(resolved_video_path),
|
||||
path=str(video_path),
|
||||
media_type="video/mp4",
|
||||
filename=video_filename
|
||||
)
|
||||
|
||||
@@ -29,9 +29,7 @@ from services.seo_tools.opengraph_service import OpenGraphService
|
||||
from services.seo_tools.on_page_seo_service import OnPageSEOService
|
||||
from services.seo_tools.technical_seo_service import TechnicalSEOService
|
||||
from services.seo_tools.enterprise_seo_service import EnterpriseSEOService
|
||||
from services.seo_tools.gsc_analyzer_service import GSCAnalyzerService
|
||||
from services.seo_tools.content_strategy_service import ContentStrategyService
|
||||
from services.seo_tools.llm_insights_service import LLMInsightsService
|
||||
from services.database import get_session_for_user
|
||||
from api.content_planning.services.content_strategy.onboarding import OnboardingDataIntegrationService
|
||||
from middleware.logging_middleware import log_api_call, save_to_file
|
||||
@@ -130,75 +128,6 @@ class CompetitiveSitemapBenchmarkingRunRequest(BaseModel):
|
||||
max_competitors: int = Field(default=5, ge=1, le=10, description="Max competitors to analyze")
|
||||
competitors: Optional[List[HttpUrl]] = Field(None, description="Optional explicit competitor URLs")
|
||||
|
||||
class EnterpriseAuditRequest(BaseModel):
|
||||
"""Request model for complete enterprise SEO audit"""
|
||||
website_url: HttpUrl = Field(..., description="Primary website URL to audit")
|
||||
competitors: Optional[List[HttpUrl]] = Field(None, description="Competitor URLs for benchmarking (max 5)")
|
||||
target_keywords: Optional[List[str]] = Field(None, description="Target keywords for analysis")
|
||||
include_content_analysis: bool = Field(default=True, description="Include content strategy analysis")
|
||||
include_competitive_analysis: bool = Field(default=True, description="Include competitive benchmarking")
|
||||
generate_executive_report: bool = Field(default=True, description="Generate executive summary")
|
||||
|
||||
class GSCAnalysisRequest(BaseModel):
|
||||
"""Request model for advanced GSC analysis"""
|
||||
site_url: HttpUrl = Field(..., description="Website URL registered in Google Search Console")
|
||||
date_range_days: int = Field(default=90, ge=7, le=365, description="Number of days to analyze")
|
||||
include_opportunities: bool = Field(default=True, description="Include content opportunity analysis")
|
||||
include_competitive: bool = Field(default=True, description="Include competitive positioning")
|
||||
|
||||
class ContentOpportunitiesRequest(BaseModel):
|
||||
"""Request model for content opportunities report"""
|
||||
site_url: HttpUrl = Field(..., description="Website URL registered in GSC")
|
||||
min_impressions: int = Field(default=100, ge=10, description="Minimum impressions threshold")
|
||||
date_range_days: int = Field(default=90, ge=7, le=365, description="Number of days to analyze")
|
||||
|
||||
# ==================== LLM INSIGHTS REQUEST MODELS ====================
|
||||
|
||||
class EnterpriseAuditInsightsRequest(BaseModel):
|
||||
"""Request model for AI insights from enterprise audit"""
|
||||
audit_results: Dict[str, Any] = Field(..., description="Complete audit results")
|
||||
website_url: str = Field(..., description="Website being audited")
|
||||
target_keywords: Optional[List[str]] = Field(None, description="Target keywords")
|
||||
|
||||
class GSCAnalysisInsightsRequest(BaseModel):
|
||||
"""Request model for AI insights from GSC analysis"""
|
||||
gsc_analysis: Dict[str, Any] = Field(..., description="Complete GSC analysis data")
|
||||
website_url: str = Field(..., description="Website being analyzed")
|
||||
|
||||
class ContentStrategyRequest(BaseModel):
|
||||
"""Request model for content strategy generation"""
|
||||
current_content: Dict[str, Any] = Field(..., description="Current content analysis")
|
||||
content_gaps: List[str] = Field(..., description="Identified content gaps")
|
||||
target_keywords: List[str] = Field(..., description="Target keywords")
|
||||
competitor_content: Optional[Dict[str, Any]] = Field(None, description="Competitor content analysis")
|
||||
|
||||
class TrafficRoadmapRequest(BaseModel):
|
||||
"""Request model for traffic improvement roadmap"""
|
||||
current_metrics: Dict[str, Any] = Field(..., description="Current traffic metrics")
|
||||
identified_opportunities: List[Dict[str, Any]] = Field(..., description="Improvement opportunities")
|
||||
implementation_timeline_weeks: int = Field(default=12, ge=4, le=52, description="Implementation timeline")
|
||||
|
||||
class CompetitiveInsightsRequest(BaseModel):
|
||||
"""Request model for competitive insights generation"""
|
||||
primary_site_analysis: Dict[str, Any] = Field(..., description="Primary site analysis")
|
||||
competitor_analyses: List[Dict[str, Any]] = Field(..., description="Competitor analyses")
|
||||
|
||||
class PrioritizedRecommendationsRequest(BaseModel):
|
||||
"""Request model for prioritized recommendations"""
|
||||
all_recommendations: List[Dict[str, Any]] = Field(..., description="All recommendations to prioritize")
|
||||
business_context: Dict[str, Any] = Field(..., description="Business goals and constraints")
|
||||
|
||||
class QuickWinsRequest(BaseModel):
|
||||
"""Request model for quick wins identification"""
|
||||
audit_data: Dict[str, Any] = Field(..., description="Complete audit data")
|
||||
max_days_to_implement: int = Field(default=7, ge=1, le=30, description="Maximum days to implement")
|
||||
|
||||
class KeywordExpansionRequest(BaseModel):
|
||||
"""Request model for keyword expansion"""
|
||||
current_keywords: List[str] = Field(..., description="Current target keywords")
|
||||
content_analysis: Dict[str, Any] = Field(..., description="Content analysis data")
|
||||
target_difficulty: Optional[str] = Field(None, description="Target difficulty (low/medium/high)")
|
||||
|
||||
# Exception Handler
|
||||
async def handle_seo_tool_exception(func_name: str, error: Exception, request_data: Dict) -> ErrorResponse:
|
||||
"""Handle exceptions from SEO tools with intelligent logging"""
|
||||
@@ -907,688 +836,3 @@ async def get_tools_status() -> BaseResponse:
|
||||
"timestamp": datetime.utcnow().isoformat()
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
# ==================== ENTERPRISE AUDIT ENDPOINTS ====================
|
||||
|
||||
@router.post("/enterprise/complete-audit", response_model=BaseResponse)
|
||||
@log_api_call
|
||||
async def execute_enterprise_audit(
|
||||
request: EnterpriseAuditRequest,
|
||||
background_tasks: BackgroundTasks,
|
||||
current_user: dict = Depends(get_current_user)
|
||||
) -> Union[BaseResponse, ErrorResponse]:
|
||||
"""
|
||||
Execute comprehensive enterprise SEO audit with full orchestration.
|
||||
|
||||
Combines multiple SEO analysis tools into an intelligent workflow:
|
||||
- Technical SEO audit with issue severity classification
|
||||
- On-page SEO analysis with keyword optimization
|
||||
- PageSpeed Insights with Core Web Vitals analysis
|
||||
- Sitemap analysis with trend detection
|
||||
- Content strategy with competitive comparison
|
||||
- Competitive benchmarking across specified competitors
|
||||
- AI-powered insights and recommendations
|
||||
|
||||
Returns prioritized action items with implementation roadmap.
|
||||
"""
|
||||
start_time = datetime.utcnow()
|
||||
|
||||
try:
|
||||
logger.info(f"Starting enterprise audit for {request.website_url}")
|
||||
|
||||
# Initialize service
|
||||
enterprise_service = EnterpriseSEOService()
|
||||
|
||||
# Execute audit
|
||||
audit_result = await enterprise_service.execute_complete_audit(
|
||||
website_url=str(request.website_url),
|
||||
competitors=[str(c) for c in request.competitors] if request.competitors else [],
|
||||
target_keywords=request.target_keywords or [],
|
||||
include_content_analysis=request.include_content_analysis,
|
||||
include_competitive_analysis=request.include_competitive_analysis,
|
||||
generate_executive_report=request.generate_executive_report
|
||||
)
|
||||
|
||||
execution_time = (datetime.utcnow() - start_time).total_seconds()
|
||||
|
||||
return BaseResponse(
|
||||
success=True,
|
||||
message="Complete enterprise audit executed successfully",
|
||||
execution_time=execution_time,
|
||||
data=audit_result
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Enterprise audit failed: {str(e)}", exc_info=True)
|
||||
return await handle_seo_tool_exception("execute_enterprise_audit", e, request.dict())
|
||||
|
||||
|
||||
@router.post("/enterprise/quick-audit", response_model=BaseResponse)
|
||||
@log_api_call
|
||||
async def execute_quick_enterprise_audit(
|
||||
website_url: HttpUrl,
|
||||
current_user: dict = Depends(get_current_user)
|
||||
) -> Union[BaseResponse, ErrorResponse]:
|
||||
"""
|
||||
Execute quick 5-minute enterprise audit focusing on critical issues.
|
||||
|
||||
Provides rapid assessment of most critical SEO problems:
|
||||
- Technical SEO critical issues
|
||||
- PageSpeed performance bottlenecks
|
||||
- Top 3 actionable recommendations
|
||||
- Estimated business impact
|
||||
"""
|
||||
start_time = datetime.utcnow()
|
||||
|
||||
try:
|
||||
logger.info(f"Starting quick audit for {website_url}")
|
||||
|
||||
enterprise_service = EnterpriseSEOService()
|
||||
audit_result = await enterprise_service.execute_quick_audit(str(website_url))
|
||||
|
||||
execution_time = (datetime.utcnow() - start_time).total_seconds()
|
||||
|
||||
return BaseResponse(
|
||||
success=True,
|
||||
message="Quick audit completed",
|
||||
execution_time=execution_time,
|
||||
data=audit_result
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
return await handle_seo_tool_exception("execute_quick_enterprise_audit", e, {"website_url": str(website_url)})
|
||||
|
||||
|
||||
# ==================== ADVANCED GSC ANALYSIS ENDPOINTS ====================
|
||||
|
||||
@router.post("/gsc/analyze-search-performance", response_model=BaseResponse)
|
||||
@log_api_call
|
||||
async def analyze_gsc_search_performance(
|
||||
request: GSCAnalysisRequest,
|
||||
current_user: dict = Depends(get_current_user)
|
||||
) -> Union[BaseResponse, ErrorResponse]:
|
||||
"""
|
||||
Advanced Google Search Console analysis with comprehensive insights.
|
||||
|
||||
Provides deep dive into search performance:
|
||||
- Performance overview with aggregated metrics
|
||||
- Keyword analysis with trend detection
|
||||
- Page-level performance breakdown
|
||||
- Content opportunity identification (15+ opportunities scored)
|
||||
- Technical SEO signal analysis
|
||||
- Competitive positioning assessment
|
||||
- AI-powered strategic recommendations
|
||||
|
||||
Each analysis component includes:
|
||||
- Current metrics and trends
|
||||
- Performance scores (0-100)
|
||||
- Actionable recommendations
|
||||
- Implementation priority
|
||||
"""
|
||||
start_time = datetime.utcnow()
|
||||
|
||||
try:
|
||||
logger.info(f"Starting GSC analysis for {request.site_url}")
|
||||
|
||||
user_id = str(current_user.get("id")) if current_user else None
|
||||
|
||||
gsc_service = GSCAnalyzerService()
|
||||
analysis_result = await gsc_service.analyze_search_performance(
|
||||
site_url=str(request.site_url),
|
||||
date_range_days=request.date_range_days,
|
||||
user_id=user_id
|
||||
)
|
||||
|
||||
execution_time = (datetime.utcnow() - start_time).total_seconds()
|
||||
|
||||
return BaseResponse(
|
||||
success=True,
|
||||
message="GSC search performance analysis completed",
|
||||
execution_time=execution_time,
|
||||
data=analysis_result
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"GSC analysis failed: {str(e)}", exc_info=True)
|
||||
return await handle_seo_tool_exception("analyze_gsc_search_performance", e, request.dict())
|
||||
|
||||
|
||||
@router.post("/gsc/content-opportunities", response_model=BaseResponse)
|
||||
@log_api_call
|
||||
async def get_content_opportunities_report(
|
||||
request: ContentOpportunitiesRequest,
|
||||
current_user: dict = Depends(get_current_user)
|
||||
) -> Union[BaseResponse, ErrorResponse]:
|
||||
"""
|
||||
Generate detailed content opportunities report from GSC data.
|
||||
|
||||
Identifies high-priority content gaps and optimization opportunities:
|
||||
- Queries with high volume but low CTR (meta/title optimization)
|
||||
- Keywords ranking 4-10 (ready for ranking improvement)
|
||||
- Long-tail keywords with expansion potential
|
||||
- Competitive white space analysis
|
||||
|
||||
For each opportunity includes:
|
||||
- Current position and metrics
|
||||
- Estimated traffic gain
|
||||
- Optimization strategy
|
||||
- Implementation difficulty
|
||||
- Phased roadmap (Phase 1, 2, 3)
|
||||
"""
|
||||
start_time = datetime.utcnow()
|
||||
|
||||
try:
|
||||
logger.info(f"Generating content opportunities for {request.site_url}")
|
||||
|
||||
gsc_service = GSCAnalyzerService()
|
||||
report = await gsc_service.get_content_opportunities_report(
|
||||
site_url=str(request.site_url),
|
||||
min_impressions=request.min_impressions,
|
||||
date_range_days=request.date_range_days
|
||||
)
|
||||
|
||||
execution_time = (datetime.utcnow() - start_time).total_seconds()
|
||||
|
||||
return BaseResponse(
|
||||
success=True,
|
||||
message="Content opportunities report generated",
|
||||
execution_time=execution_time,
|
||||
data=report
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Content opportunities report failed: {str(e)}", exc_info=True)
|
||||
return await handle_seo_tool_exception("get_content_opportunities_report", e, request.dict())
|
||||
|
||||
|
||||
@router.get("/enterprise/health", response_model=BaseResponse)
|
||||
@log_api_call
|
||||
async def check_enterprise_services_health() -> BaseResponse:
|
||||
"""Health check for enterprise services"""
|
||||
try:
|
||||
enterprise_service = EnterpriseSEOService()
|
||||
gsc_service = GSCAnalyzerService()
|
||||
|
||||
enterprise_health = await enterprise_service.health_check()
|
||||
gsc_health = await gsc_service.health_check()
|
||||
|
||||
return BaseResponse(
|
||||
success=True,
|
||||
message="Enterprise services health check completed",
|
||||
data={
|
||||
"enterprise_seo_service": enterprise_health,
|
||||
"gsc_analyzer_service": gsc_health,
|
||||
"timestamp": datetime.utcnow().isoformat()
|
||||
}
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error(f"Enterprise health check failed: {str(e)}")
|
||||
return BaseResponse(
|
||||
success=False,
|
||||
message="Enterprise health check failed",
|
||||
data={"error": str(e)}
|
||||
)
|
||||
|
||||
|
||||
# ==================== LLM INSIGHTS ENDPOINTS (Phase 2A.2) ====================
|
||||
|
||||
@router.post("/llm/generate-audit-insights", response_model=BaseResponse)
|
||||
@log_api_call
|
||||
async def generate_audit_insights(
|
||||
request: EnterpriseAuditInsightsRequest,
|
||||
background_tasks: BackgroundTasks,
|
||||
current_user: dict = Depends(get_current_user)
|
||||
) -> Union[BaseResponse, ErrorResponse]:
|
||||
"""
|
||||
Generate AI-powered insights from enterprise SEO audit results.
|
||||
|
||||
Analyzes audit findings and produces strategic, actionable insights with:
|
||||
- Priority scoring (1-10 scale)
|
||||
- Traffic impact projections
|
||||
- Implementation difficulty assessments
|
||||
- Step-by-step action guides
|
||||
- Required tools and resources
|
||||
"""
|
||||
start_time = datetime.utcnow()
|
||||
|
||||
try:
|
||||
logger.info(f"Generating audit insights for {request.website_url}")
|
||||
|
||||
llm_service = LLMInsightsService()
|
||||
insights = await llm_service.generate_enterprise_audit_insights(
|
||||
audit_results=request.audit_results,
|
||||
website_url=request.website_url,
|
||||
target_keywords=request.target_keywords
|
||||
)
|
||||
|
||||
execution_time = (datetime.utcnow() - start_time).total_seconds()
|
||||
|
||||
# Log successful operation
|
||||
log_data = {
|
||||
"operation": "audit_insights_generation",
|
||||
"website_url": request.website_url,
|
||||
"insights_generated": len(insights.get('insights', [])),
|
||||
"execution_time": execution_time,
|
||||
"success": True
|
||||
}
|
||||
background_tasks.add_task(save_to_file, f"{LOG_DIR}/llm_operations.jsonl", log_data)
|
||||
|
||||
return BaseResponse(
|
||||
success=True,
|
||||
message="Audit insights generated successfully",
|
||||
execution_time=execution_time,
|
||||
data=insights
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Audit insights generation failed: {str(e)}", exc_info=True)
|
||||
return await handle_seo_tool_exception("generate_audit_insights", e, {"website_url": request.website_url})
|
||||
|
||||
|
||||
@router.post("/llm/generate-gsc-insights", response_model=BaseResponse)
|
||||
@log_api_call
|
||||
async def generate_gsc_insights(
|
||||
request: GSCAnalysisInsightsRequest,
|
||||
background_tasks: BackgroundTasks,
|
||||
current_user: dict = Depends(get_current_user)
|
||||
) -> Union[BaseResponse, ErrorResponse]:
|
||||
"""
|
||||
Generate strategic insights from GSC search performance analysis.
|
||||
|
||||
Produces targeted, actionable insights including:
|
||||
- Keyword optimization opportunities
|
||||
- Content ranking improvement strategies
|
||||
- CTR enhancement tactics
|
||||
- Competitive positioning analysis
|
||||
- Quick-win identification
|
||||
"""
|
||||
start_time = datetime.utcnow()
|
||||
|
||||
try:
|
||||
logger.info(f"Generating GSC insights for {request.website_url}")
|
||||
|
||||
llm_service = LLMInsightsService()
|
||||
insights = await llm_service.generate_gsc_analysis_insights(
|
||||
gsc_analysis=request.gsc_analysis,
|
||||
website_url=request.website_url
|
||||
)
|
||||
|
||||
execution_time = (datetime.utcnow() - start_time).total_seconds()
|
||||
|
||||
log_data = {
|
||||
"operation": "gsc_insights_generation",
|
||||
"website_url": request.website_url,
|
||||
"insights_generated": len(insights.get('insights', [])),
|
||||
"execution_time": execution_time,
|
||||
"success": True
|
||||
}
|
||||
background_tasks.add_task(save_to_file, f"{LOG_DIR}/llm_operations.jsonl", log_data)
|
||||
|
||||
return BaseResponse(
|
||||
success=True,
|
||||
message="GSC insights generated successfully",
|
||||
execution_time=execution_time,
|
||||
data=insights
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"GSC insights generation failed: {str(e)}", exc_info=True)
|
||||
return await handle_seo_tool_exception("generate_gsc_insights", e, {"website_url": request.website_url})
|
||||
|
||||
|
||||
@router.post("/llm/generate-content-strategy", response_model=BaseResponse)
|
||||
@log_api_call
|
||||
async def generate_content_strategy(
|
||||
request: ContentStrategyRequest,
|
||||
background_tasks: BackgroundTasks,
|
||||
current_user: dict = Depends(get_current_user)
|
||||
) -> Union[BaseResponse, ErrorResponse]:
|
||||
"""
|
||||
Generate comprehensive content strategy with AI recommendations.
|
||||
|
||||
Creates detailed strategy including:
|
||||
- Content gap analysis and solutions
|
||||
- Content calendar recommendations
|
||||
- Keyword-to-content mapping
|
||||
- Competitive content benchmarking
|
||||
- Topic cluster suggestions
|
||||
- Publishing frequency recommendations
|
||||
"""
|
||||
start_time = datetime.utcnow()
|
||||
|
||||
try:
|
||||
logger.info(f"Generating content strategy ({len(request.content_gaps)} gaps)")
|
||||
|
||||
llm_service = LLMInsightsService()
|
||||
strategy = await llm_service.generate_content_strategy_insights(
|
||||
current_content=request.current_content,
|
||||
content_gaps=request.content_gaps,
|
||||
target_keywords=request.target_keywords,
|
||||
competitor_content=request.competitor_content
|
||||
)
|
||||
|
||||
execution_time = (datetime.utcnow() - start_time).total_seconds()
|
||||
|
||||
log_data = {
|
||||
"operation": "content_strategy_generation",
|
||||
"gaps_addressed": len(request.content_gaps),
|
||||
"keywords_analyzed": len(request.target_keywords),
|
||||
"execution_time": execution_time,
|
||||
"success": True
|
||||
}
|
||||
background_tasks.add_task(save_to_file, f"{LOG_DIR}/llm_operations.jsonl", log_data)
|
||||
|
||||
return BaseResponse(
|
||||
success=True,
|
||||
message="Content strategy generated successfully",
|
||||
execution_time=execution_time,
|
||||
data=strategy
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Content strategy generation failed: {str(e)}", exc_info=True)
|
||||
return await handle_seo_tool_exception("generate_content_strategy", e, {"gaps_count": len(request.content_gaps)})
|
||||
|
||||
|
||||
@router.post("/llm/generate-traffic-roadmap", response_model=BaseResponse)
|
||||
@log_api_call
|
||||
async def generate_traffic_roadmap(
|
||||
request: TrafficRoadmapRequest,
|
||||
background_tasks: BackgroundTasks,
|
||||
current_user: dict = Depends(get_current_user)
|
||||
) -> Union[BaseResponse, ErrorResponse]:
|
||||
"""
|
||||
Generate phased traffic improvement roadmap with projections.
|
||||
|
||||
Produces detailed roadmap with:
|
||||
- Phased implementation plan (Week 1, 2, 3+)
|
||||
- Traffic gain projections per phase
|
||||
- Priority-ordered action items
|
||||
- Resource requirements per phase
|
||||
- Key performance indicators (KPIs)
|
||||
- Success metrics and validation points
|
||||
- Risk mitigation strategies
|
||||
"""
|
||||
start_time = datetime.utcnow()
|
||||
|
||||
try:
|
||||
logger.info(f"Generating traffic roadmap ({request.implementation_timeline_weeks} weeks)")
|
||||
|
||||
llm_service = LLMInsightsService()
|
||||
roadmap = await llm_service.generate_traffic_improvement_roadmap(
|
||||
current_metrics=request.current_metrics,
|
||||
identified_opportunities=request.identified_opportunities,
|
||||
implementation_timeline_weeks=request.implementation_timeline_weeks
|
||||
)
|
||||
|
||||
execution_time = (datetime.utcnow() - start_time).total_seconds()
|
||||
|
||||
log_data = {
|
||||
"operation": "traffic_roadmap_generation",
|
||||
"timeline_weeks": request.implementation_timeline_weeks,
|
||||
"opportunities_count": len(request.identified_opportunities),
|
||||
"execution_time": execution_time,
|
||||
"success": True
|
||||
}
|
||||
background_tasks.add_task(save_to_file, f"{LOG_DIR}/llm_operations.jsonl", log_data)
|
||||
|
||||
return BaseResponse(
|
||||
success=True,
|
||||
message="Traffic roadmap generated successfully",
|
||||
execution_time=execution_time,
|
||||
data=roadmap
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Traffic roadmap generation failed: {str(e)}", exc_info=True)
|
||||
return await handle_seo_tool_exception("generate_traffic_roadmap", e,
|
||||
{"opportunities_count": len(request.identified_opportunities)})
|
||||
|
||||
|
||||
@router.post("/llm/generate-competitive-insights", response_model=BaseResponse)
|
||||
@log_api_call
|
||||
async def generate_competitive_insights(
|
||||
request: CompetitiveInsightsRequest,
|
||||
background_tasks: BackgroundTasks,
|
||||
current_user: dict = Depends(get_current_user)
|
||||
) -> Union[BaseResponse, ErrorResponse]:
|
||||
"""
|
||||
Generate competitive positioning and intelligence insights.
|
||||
|
||||
Analyzes competitive landscape and provides:
|
||||
- Competitive advantage identification
|
||||
- Competitive gap analysis
|
||||
- Market opportunity identification
|
||||
- Threat assessment
|
||||
- Win strategy recommendations
|
||||
- Differentiation recommendations
|
||||
- Market position recommendations
|
||||
"""
|
||||
start_time = datetime.utcnow()
|
||||
|
||||
try:
|
||||
logger.info(f"Generating competitive insights ({len(request.competitor_analyses)} competitors)")
|
||||
|
||||
llm_service = LLMInsightsService()
|
||||
insights = await llm_service.generate_competitive_insights(
|
||||
primary_site_analysis=request.primary_site_analysis,
|
||||
competitor_analyses=request.competitor_analyses
|
||||
)
|
||||
|
||||
execution_time = (datetime.utcnow() - start_time).total_seconds()
|
||||
|
||||
log_data = {
|
||||
"operation": "competitive_insights_generation",
|
||||
"competitors_analyzed": len(request.competitor_analyses),
|
||||
"execution_time": execution_time,
|
||||
"success": True
|
||||
}
|
||||
background_tasks.add_task(save_to_file, f"{LOG_DIR}/llm_operations.jsonl", log_data)
|
||||
|
||||
return BaseResponse(
|
||||
success=True,
|
||||
message="Competitive insights generated successfully",
|
||||
execution_time=execution_time,
|
||||
data=insights
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Competitive insights generation failed: {str(e)}", exc_info=True)
|
||||
return await handle_seo_tool_exception("generate_competitive_insights", e,
|
||||
{"competitors_count": len(request.competitor_analyses)})
|
||||
|
||||
|
||||
@router.post("/llm/prioritized-recommendations", response_model=BaseResponse)
|
||||
@log_api_call
|
||||
async def get_prioritized_recommendations(
|
||||
request: PrioritizedRecommendationsRequest,
|
||||
background_tasks: BackgroundTasks,
|
||||
current_user: dict = Depends(get_current_user)
|
||||
) -> Union[BaseResponse, ErrorResponse]:
|
||||
"""
|
||||
Get AI-prioritized recommendations ranked by business impact.
|
||||
|
||||
Scores and prioritizes recommendations by:
|
||||
- Traffic impact potential
|
||||
- Implementation effort required
|
||||
- Resource requirements
|
||||
- Timeline to implementation
|
||||
- Business alignment
|
||||
- Risk level
|
||||
- ROI potential
|
||||
|
||||
Returns categorized as: Quick Wins | High Impact | Long-term
|
||||
"""
|
||||
start_time = datetime.utcnow()
|
||||
|
||||
try:
|
||||
logger.info(f"Prioritizing {len(request.all_recommendations)} recommendations")
|
||||
|
||||
llm_service = LLMInsightsService()
|
||||
prioritized = await llm_service.generate_prioritized_recommendations(
|
||||
all_recommendations=request.all_recommendations,
|
||||
business_context=request.business_context
|
||||
)
|
||||
|
||||
execution_time = (datetime.utcnow() - start_time).total_seconds()
|
||||
|
||||
log_data = {
|
||||
"operation": "prioritized_recommendations_generation",
|
||||
"total_recommendations": len(request.all_recommendations),
|
||||
"quick_wins": len(prioritized.get('quick_wins', [])),
|
||||
"execution_time": execution_time,
|
||||
"success": True
|
||||
}
|
||||
background_tasks.add_task(save_to_file, f"{LOG_DIR}/llm_operations.jsonl", log_data)
|
||||
|
||||
return BaseResponse(
|
||||
success=True,
|
||||
message="Recommendations prioritized successfully",
|
||||
execution_time=execution_time,
|
||||
data=prioritized
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Recommendation prioritization failed: {str(e)}", exc_info=True)
|
||||
return await handle_seo_tool_exception("get_prioritized_recommendations", e,
|
||||
{"recommendations_count": len(request.all_recommendations)})
|
||||
|
||||
|
||||
@router.post("/llm/quick-wins", response_model=BaseResponse)
|
||||
@log_api_call
|
||||
async def identify_quick_wins(
|
||||
request: QuickWinsRequest,
|
||||
background_tasks: BackgroundTasks,
|
||||
current_user: dict = Depends(get_current_user)
|
||||
) -> Union[BaseResponse, ErrorResponse]:
|
||||
"""
|
||||
Identify quick wins - high-impact actions implementable in short timeframe.
|
||||
|
||||
Finds high-ROI quick wins including:
|
||||
- Meta tag optimization opportunities
|
||||
- URL structure improvements
|
||||
- On-page optimization quick fixes
|
||||
- Internal linking recommendations
|
||||
- Content formatting improvements
|
||||
- Technical SEO quick fixes
|
||||
- Performance optimization opportunities
|
||||
|
||||
Each with: estimated traffic gain, implementation time, tools needed, expected outcomes
|
||||
"""
|
||||
start_time = datetime.utcnow()
|
||||
|
||||
try:
|
||||
logger.info(f"Identifying quick wins (max {request.max_days_to_implement} days)")
|
||||
|
||||
llm_service = LLMInsightsService()
|
||||
quick_wins = await llm_service.generate_quick_wins(
|
||||
audit_data=request.audit_data,
|
||||
max_days_to_implement=request.max_days_to_implement
|
||||
)
|
||||
|
||||
execution_time = (datetime.utcnow() - start_time).total_seconds()
|
||||
|
||||
log_data = {
|
||||
"operation": "quick_wins_identification",
|
||||
"max_days": request.max_days_to_implement,
|
||||
"quick_wins_found": len(quick_wins.get('quick_wins', [])),
|
||||
"total_potential_traffic": quick_wins.get('total_potential_traffic', 0),
|
||||
"execution_time": execution_time,
|
||||
"success": True
|
||||
}
|
||||
background_tasks.add_task(save_to_file, f"{LOG_DIR}/llm_operations.jsonl", log_data)
|
||||
|
||||
return BaseResponse(
|
||||
success=True,
|
||||
message="Quick wins identified successfully",
|
||||
execution_time=execution_time,
|
||||
data=quick_wins
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Quick wins identification failed: {str(e)}", exc_info=True)
|
||||
return await handle_seo_tool_exception("identify_quick_wins", e,
|
||||
{"max_days": request.max_days_to_implement})
|
||||
|
||||
|
||||
@router.post("/llm/keyword-expansion", response_model=BaseResponse)
|
||||
@log_api_call
|
||||
async def expand_keywords(
|
||||
request: KeywordExpansionRequest,
|
||||
background_tasks: BackgroundTasks,
|
||||
current_user: dict = Depends(get_current_user)
|
||||
) -> Union[BaseResponse, ErrorResponse]:
|
||||
"""
|
||||
Expand keyword list with AI-generated related and long-tail keywords.
|
||||
|
||||
Generates 15-20 additional keywords including:
|
||||
- Long-tail keyword variations
|
||||
- Question-based keywords (People Also Ask)
|
||||
- Local keyword variations
|
||||
- Intent-based keywords (commercial, informational, navigational)
|
||||
- Seasonal keyword variants
|
||||
|
||||
Each keyword includes: search volume estimate, difficulty score, relevance, content opportunity
|
||||
"""
|
||||
start_time = datetime.utcnow()
|
||||
|
||||
try:
|
||||
logger.info(f"Expanding keywords from {len(request.current_keywords)} base keywords")
|
||||
|
||||
llm_service = LLMInsightsService()
|
||||
expansion = await llm_service.generate_keyword_expansion(
|
||||
current_keywords=request.current_keywords,
|
||||
content_analysis=request.content_analysis,
|
||||
target_difficulty=request.target_difficulty
|
||||
)
|
||||
|
||||
execution_time = (datetime.utcnow() - start_time).total_seconds()
|
||||
|
||||
log_data = {
|
||||
"operation": "keyword_expansion",
|
||||
"original_keywords": len(request.current_keywords),
|
||||
"expanded_keywords": expansion.get('expanded_keywords', 0),
|
||||
"execution_time": execution_time,
|
||||
"success": True
|
||||
}
|
||||
background_tasks.add_task(save_to_file, f"{LOG_DIR}/llm_operations.jsonl", log_data)
|
||||
|
||||
return BaseResponse(
|
||||
success=True,
|
||||
message="Keyword expansion completed successfully",
|
||||
execution_time=execution_time,
|
||||
data=expansion
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Keyword expansion failed: {str(e)}", exc_info=True)
|
||||
return await handle_seo_tool_exception("expand_keywords", e,
|
||||
{"keywords_count": len(request.current_keywords)})
|
||||
|
||||
|
||||
@router.get("/llm/health", response_model=BaseResponse)
|
||||
@log_api_call
|
||||
async def check_llm_insights_health() -> BaseResponse:
|
||||
"""Health check for LLM insights service"""
|
||||
try:
|
||||
llm_service = LLMInsightsService()
|
||||
health = await llm_service.health_check()
|
||||
|
||||
return BaseResponse(
|
||||
success=True,
|
||||
message="LLM insights service is healthy",
|
||||
data={
|
||||
"service": health.get('service'),
|
||||
"version": health.get('version'),
|
||||
"llm_integration": health.get('llm_integration'),
|
||||
"timestamp": health.get('last_check')
|
||||
}
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error(f"LLM insights health check failed: {str(e)}")
|
||||
return BaseResponse(
|
||||
success=False,
|
||||
message="LLM insights service health check failed",
|
||||
data={"error": str(e)}
|
||||
)
|
||||
|
||||
@@ -14,7 +14,7 @@ from services.integrations.wordpress_publisher import WordPressPublisher
|
||||
from middleware.auth_middleware import get_current_user
|
||||
|
||||
|
||||
router = APIRouter(prefix="/api/wordpress", tags=["WordPress"])
|
||||
router = APIRouter(prefix="/wordpress", tags=["WordPress"])
|
||||
|
||||
|
||||
# Pydantic Models
|
||||
@@ -87,9 +87,10 @@ async def get_wordpress_status(user: dict = Depends(get_current_user)):
|
||||
logger.info(f"Checking WordPress status for user: {user_id}")
|
||||
|
||||
# Get user's WordPress sites
|
||||
sites = wp_service.get_user_sites(user_id)
|
||||
sites = wp_service.get_all_sites(user_id)
|
||||
|
||||
if sites:
|
||||
# Convert to response format
|
||||
site_responses = [
|
||||
WordPressSiteResponse(
|
||||
id=site['id'],
|
||||
@@ -103,12 +104,14 @@ async def get_wordpress_status(user: dict = Depends(get_current_user)):
|
||||
for site in sites
|
||||
]
|
||||
|
||||
logger.info(f"Found {len(sites)} WordPress sites for user {user_id}")
|
||||
return WordPressStatusResponse(
|
||||
connected=True,
|
||||
sites=site_responses,
|
||||
total_sites=len(sites)
|
||||
)
|
||||
else:
|
||||
logger.info(f"No WordPress sites found for user {user_id}")
|
||||
return WordPressStatusResponse(
|
||||
connected=False,
|
||||
sites=[],
|
||||
@@ -149,7 +152,7 @@ async def add_wordpress_site(
|
||||
)
|
||||
|
||||
# Get the added site info
|
||||
sites = wp_service.get_user_sites(user_id)
|
||||
sites = wp_service.get_all_sites(user_id)
|
||||
if sites:
|
||||
latest_site = sites[0] # Most recent site
|
||||
return WordPressSiteResponse(
|
||||
@@ -181,7 +184,7 @@ async def get_wordpress_sites(user: dict = Depends(get_current_user)):
|
||||
|
||||
logger.info(f"Getting WordPress sites for user: {user_id}")
|
||||
|
||||
sites = wp_service.get_user_sites(user_id)
|
||||
sites = wp_service.get_all_sites(user_id)
|
||||
|
||||
site_responses = [
|
||||
WordPressSiteResponse(
|
||||
|
||||
@@ -10,10 +10,6 @@ from pydantic import BaseModel
|
||||
from loguru import logger
|
||||
|
||||
from services.integrations.wordpress_oauth import WordPressOAuthService
|
||||
from services.integrations.oauth_callback_utils import (
|
||||
build_oauth_callback_html,
|
||||
sanitize_string,
|
||||
)
|
||||
from middleware.auth_middleware import get_current_user
|
||||
|
||||
router = APIRouter(prefix="/wp", tags=["WordPress OAuth"])
|
||||
@@ -82,12 +78,30 @@ async def handle_wordpress_callback(
|
||||
status_code=status.HTTP_400_BAD_REQUEST,
|
||||
content={"success": False, "error": error}
|
||||
)
|
||||
html_content = build_oauth_callback_html(
|
||||
payload={"type": "WPCOM_OAUTH_ERROR", "success": False, "error": sanitize_string(error)},
|
||||
title="WordPress.com Connection Failed",
|
||||
heading="Connection Failed",
|
||||
message="There was an error connecting to WordPress.com. You can close this window and try again."
|
||||
)
|
||||
html_content = f"""
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>WordPress.com Connection Failed</title>
|
||||
<script>
|
||||
// Send error message to parent window
|
||||
window.onload = function() {{
|
||||
(window.opener || window.parent).postMessage({{
|
||||
type: 'WPCOM_OAUTH_ERROR',
|
||||
success: false,
|
||||
error: '{error}'
|
||||
}}, '*');
|
||||
window.close();
|
||||
}};
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Connection Failed</h1>
|
||||
<p>There was an error connecting to WordPress.com.</p>
|
||||
<p>You can close this window and try again.</p>
|
||||
</body>
|
||||
</html>
|
||||
"""
|
||||
return HTMLResponse(content=html_content, headers={
|
||||
"Cross-Origin-Opener-Policy": "unsafe-none",
|
||||
"Cross-Origin-Embedder-Policy": "unsafe-none"
|
||||
@@ -100,12 +114,30 @@ async def handle_wordpress_callback(
|
||||
status_code=status.HTTP_400_BAD_REQUEST,
|
||||
content={"success": False, "error": "Missing parameters"}
|
||||
)
|
||||
html_content = build_oauth_callback_html(
|
||||
payload={"type": "WPCOM_OAUTH_ERROR", "success": False, "error": "Missing parameters"},
|
||||
title="WordPress.com Connection Failed",
|
||||
heading="Connection Failed",
|
||||
message="Missing required parameters. You can close this window and try again."
|
||||
)
|
||||
html_content = """
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>WordPress.com Connection Failed</title>
|
||||
<script>
|
||||
// Send error message to opener/parent window
|
||||
window.onload = function() {{
|
||||
(window.opener || window.parent).postMessage({{
|
||||
type: 'WPCOM_OAUTH_ERROR',
|
||||
success: false,
|
||||
error: 'Missing parameters'
|
||||
}}, '*');
|
||||
window.close();
|
||||
}};
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Connection Failed</h1>
|
||||
<p>Missing required parameters.</p>
|
||||
<p>You can close this window and try again.</p>
|
||||
</body>
|
||||
</html>
|
||||
"""
|
||||
return HTMLResponse(content=html_content, headers={
|
||||
"Cross-Origin-Opener-Policy": "unsafe-none",
|
||||
"Cross-Origin-Embedder-Policy": "unsafe-none"
|
||||
@@ -121,12 +153,30 @@ async def handle_wordpress_callback(
|
||||
status_code=status.HTTP_400_BAD_REQUEST,
|
||||
content={"success": False, "error": "Token exchange failed"}
|
||||
)
|
||||
html_content = build_oauth_callback_html(
|
||||
payload={"type": "WPCOM_OAUTH_ERROR", "success": False, "error": "Token exchange failed"},
|
||||
title="WordPress.com Connection Failed",
|
||||
heading="Connection Failed",
|
||||
message="Failed to exchange authorization code for access token. You can close this window and try again."
|
||||
)
|
||||
html_content = """
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>WordPress.com Connection Failed</title>
|
||||
<script>
|
||||
// Send error message to opener/parent window
|
||||
window.onload = function() {{
|
||||
(window.opener || window.parent).postMessage({{
|
||||
type: 'WPCOM_OAUTH_ERROR',
|
||||
success: false,
|
||||
error: 'Token exchange failed'
|
||||
}}, '*');
|
||||
window.close();
|
||||
}};
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Connection Failed</h1>
|
||||
<p>Failed to exchange authorization code for access token.</p>
|
||||
<p>You can close this window and try again.</p>
|
||||
</body>
|
||||
</html>
|
||||
"""
|
||||
return HTMLResponse(content=html_content)
|
||||
|
||||
# Return success page with postMessage script
|
||||
@@ -143,17 +193,31 @@ async def handle_wordpress_callback(
|
||||
}
|
||||
)
|
||||
|
||||
html_content = build_oauth_callback_html(
|
||||
payload={
|
||||
"type": "WPCOM_OAUTH_SUCCESS",
|
||||
"success": True,
|
||||
"blogUrl": sanitize_string(blog_url, 300),
|
||||
"blogId": sanitize_string(blog_id, 128)
|
||||
},
|
||||
title="WordPress.com Connection Successful",
|
||||
heading="Connection Successful",
|
||||
message="Your WordPress.com site has been connected successfully. You can close this window now."
|
||||
)
|
||||
html_content = f"""
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>WordPress.com Connection Successful</title>
|
||||
<script>
|
||||
// Send success message to opener/parent window
|
||||
window.onload = function() {{
|
||||
(window.opener || window.parent).postMessage({{
|
||||
type: 'WPCOM_OAUTH_SUCCESS',
|
||||
success: true,
|
||||
blogUrl: '{blog_url}',
|
||||
blogId: '{blog_id}'
|
||||
}}, '*');
|
||||
window.close();
|
||||
}};
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Connection Successful!</h1>
|
||||
<p>Your WordPress.com site has been connected successfully.</p>
|
||||
<p>You can close this window now.</p>
|
||||
</body>
|
||||
</html>
|
||||
"""
|
||||
|
||||
return HTMLResponse(content=html_content, headers={
|
||||
"Cross-Origin-Opener-Policy": "unsafe-none",
|
||||
@@ -162,12 +226,30 @@ async def handle_wordpress_callback(
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Error handling WordPress OAuth callback: {e}")
|
||||
html_content = build_oauth_callback_html(
|
||||
payload={"type": "WPCOM_OAUTH_ERROR", "success": False, "error": "Callback error"},
|
||||
title="WordPress.com Connection Failed",
|
||||
heading="Connection Failed",
|
||||
message="An unexpected error occurred during connection. You can close this window and try again."
|
||||
)
|
||||
html_content = """
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>WordPress.com Connection Failed</title>
|
||||
<script>
|
||||
// Send error message to opener/parent window
|
||||
window.onload = function() {{
|
||||
(window.opener || window.parent).postMessage({{
|
||||
type: 'WPCOM_OAUTH_ERROR',
|
||||
success: false,
|
||||
error: 'Callback error'
|
||||
}}, '*');
|
||||
window.close();
|
||||
}};
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Connection Failed</h1>
|
||||
<p>An unexpected error occurred during connection.</p>
|
||||
<p>You can close this window and try again.</p>
|
||||
</body>
|
||||
</html>
|
||||
"""
|
||||
return HTMLResponse(content=html_content, headers={
|
||||
"Cross-Origin-Opener-Policy": "unsafe-none",
|
||||
"Cross-Origin-Embedder-Policy": "unsafe-none"
|
||||
|
||||
@@ -43,7 +43,7 @@ def cap_basic_plan_usage():
|
||||
# New limits
|
||||
new_call_limit = basic_plan.gemini_calls_limit # Should be 10
|
||||
new_token_limit = basic_plan.gemini_tokens_limit # Should be 2000
|
||||
new_image_limit = basic_plan.stability_calls_limit # 25
|
||||
new_image_limit = basic_plan.stability_calls_limit # Should be 5
|
||||
|
||||
logger.info(f"📋 Basic Plan Limits:")
|
||||
logger.info(f" Calls: {new_call_limit}")
|
||||
|
||||
@@ -75,14 +75,8 @@ def update_basic_plan_limits():
|
||||
basic_plan.anthropic_tokens_limit = 20000
|
||||
basic_plan.mistral_tokens_limit = 20000
|
||||
|
||||
# Update image generation limit to 25 (minimum 10 for podcast workflows)
|
||||
basic_plan.stability_calls_limit = 25
|
||||
|
||||
# Update image edit limit to 25 (podcast episode covers + scene images)
|
||||
basic_plan.image_edit_calls_limit = 25
|
||||
|
||||
# Update audio generation limit to 100 (TTS for podcast narration)
|
||||
basic_plan.audio_calls_limit = 100
|
||||
# Update image generation limit to 5
|
||||
basic_plan.stability_calls_limit = 5
|
||||
|
||||
# Update timestamp
|
||||
basic_plan.updated_at = datetime.now(timezone.utc)
|
||||
@@ -90,9 +84,7 @@ def update_basic_plan_limits():
|
||||
logger.info("\n📝 New Basic plan limits:")
|
||||
logger.info(f" LLM Calls (all providers): 10")
|
||||
logger.info(f" LLM Tokens (all providers): 20000 (increased from 5000)")
|
||||
logger.info(f" Images (stability): 25")
|
||||
logger.info(f" Image Edits: 25")
|
||||
logger.info(f" Audio Calls: 100")
|
||||
logger.info(f" Images: 5")
|
||||
|
||||
# Count and get affected users
|
||||
user_subscriptions = db.query(UserSubscription).filter(
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user