Refactor imports and enhance code quality across multiple files

[smirk-dev]

• Reordered and cleaned up import statements in ai_services.py, app.py, database.py, main.py (various starters).
• Fixed trailing whitespace and ensured newline at end of files in several Python scripts.
• Enhanced documentation in .env.example files for better clarity and guidance.
• Introduced a comprehensive code quality fixer script to automate whitespace, import sorting, and documentation enhancements.
• Addressed security issues and indentation errors in Python files.

🔗 Linked Issue

Closes #77

✅ Type of Change

• ✨ New Project/Feature
• 🐞 Bug Fix
• 📚 Documentation Update
• 🔨 Refactor or Other

📝 Summary

This pull request implements comprehensive code quality improvements across the entire awesome-ai-apps repository, addressing CI/CD pipeline failures and establishing consistent coding standards. The changes span 165 files with 3,662 insertions and 2,011 deletions, representing a massive cleanup and standardization effort.

Key Improvements:

🔧 Code Quality Fixes (298 total fixes)

• Import Organization: Fixed 129 files with I001 violations by implementing proper import sorting (standard library → third-party → local imports)
• Whitespace Cleanup: Resolved 145 files with W291/W292 violations by removing trailing whitespace and ensuring proper file endings
• Security & Indentation: Fixed 4 files with mixed tabs/spaces and potential security-related indentation issues

📚 Documentation Enhancement (20 .env.example files upgraded)

• Transformed basic API key templates into comprehensive configuration guides
• Added detailed setup instructions, troubleshooting sections, and security best practices
• Included Nebius API key links and usage guidelines for consistent onboarding experience

🛠️ New Tooling

• Created: comprehensive_code_quality_fixer.py - Automated tool for ongoing quality maintenance
• Enhanced: Existing code quality enhancer with improved functionality

🎯 Files Affected by Category

• GitHub Scripts & Tools: 7 files (workflow automation improvements)
• Advance AI Agents: 47 files (conference generators, finance agents, job finders, etc.)
• MCP AI Agents: 35 files (database agents, GitHub agents, documentation tools)
• Memory Agents: 11 files (blog writers, social media agents, research tools)
• RAG Applications: 10 files (chat interfaces, PDF analyzers, vector search)
• Simple AI Agents: 14 files (browser agents, finance tools, newsletter generators)
• Starter Templates: 13 files (LangChain, CrewAI, DSPy, OpenAI starters)

📖 README Checklist

• I have created a README.md file for my project.
• My README.md follows the official .github/README_TEMPLATE.md.
• I have included clear installation and usage instructions in my README.md.
• I have added a GIF or screenshot to the assets folder and included it in my README.md.

✔️ Contributor Checklist

• I have read the CONTRIBUTING.md document.
• My code follows the project's coding standards.
• I have placed my project in the correct directory (e.g., advance_ai_agents, rag_apps).
• I have included a requirements.txt or pyproject.toml for dependencies.
• I have added a .env.example file if environment variables are needed and ensured no secrets are committed.
• My pull request is focused on a single project or change.

💬 Additional Comments

Problem Solved: This PR resolves multiple GitHub Actions failures including:

• ❌ Ruff linting violations (W291, W292, I001)
• ❌ Documentation quality check failures (68+ issues)
• ❌ Security scan indentation errors
• ❌ Bandit report parsing issues

Impact & Benefits:

• ✅ Consistent Code Style: All Python files now follow standardized import ordering and whitespace conventions
• ✅ Professional Documentation: .env.example files provide comprehensive setup guidance for new contributors
• ✅ Automated Quality Assurance: New tooling ensures ongoing code quality maintenance
• ✅ CI/CD Pipeline Health: All quality checks now pass, enabling smooth development workflow

Sample Transformation:

Before:

# Unorganized imports with trailing whitespace
from openai import OpenAI   
import os
from crewai_tools import QdrantVectorSearchTool
import uuid

NEBIUS_API_KEY="Your Key"
After:

# Organized imports, clean formatting
import os
import uuid

from openai import OpenAI
from crewai_tools import QdrantVectorSearchTool

# =============================================================================
# project_name - Environment Configuration
# =============================================================================
# Copy this file to .env and fill in your actual values
# IMPORTANT: Never commit .env files to version control
#
# Quick setup: cp .env.example .env

# =============================================================================
# Required Configuration
# =============================================================================

# Nebius AI API Key (Required)
# Description: Primary LLM provider for project_name
# Get your key: https://studio.nebius.ai/api-keys
# Free tier: 100 requests/minute, perfect for learning
NEBIUS_API_KEY="Your Key"

Usage of New Quality Tool:

# Run the comprehensive fixer
python .github/tools/comprehensive_code_quality_fixer.py . --verbose

# Expected output:
# Trailing whitespace fixes: 145
# Import sorting fixes: 129  
# Environment documentation fixes: 20
# Security/indentation fixes: 4
# Total fixes applied: 298

@Arindam200

[coderabbitai]

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

86 files out of 194 files are above the max files limit of 100. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Arindam200]

Hey @smirk-dev

Can you push this to this branch: refactor

Also Only add the scripts, Not the changed files. it will be easier to review

[smirk-dev]

@Arindam200 refactor #92 created