project_info.py

"""
Project structure overview and usage instructions
"""
import os

def show_project_structure():
    """Display the project structure and usage instructions"""
    print("Excel to Database Processing Project")
    print("=" * 50)
    
    print("\n📁 Project Structure:")
    structure = """
carga_banco/
├── 📄 main.py                    # Main application entry point
├── ⚙️  config.py                 # Configuration settings
├── 🗃️  models.py                 # Database models (Area, Question, Item, Action)
├── 🔗 database.py                # Database connection and setup
├── 📊 excel_reader.py            # Excel file reading functionality
├── 🔄 data_processor.py          # Data processing and database operations
├── 📋 requirements.txt          # Python dependencies
├── 🔧 .env.example              # Environment variables template
├── 🧪 create_sample_excel.py     # Script to create sample Excel file
├── ✅ test_application.py        # Test script to verify functionality
├── 📖 README.md                 # Project documentation
└── 📁 data/
    ├── 📊 input.xlsx            # Your Excel file (create with create_sample_excel.py)
    └── 📝 sample_data.txt       # Sample data in text format
    """
    print(structure)
    
    print("\n🚀 Quick Start:")
    print("1. Install dependencies: pip install -r requirements.txt")
    print("2. Create sample Excel file: python create_sample_excel.py")
    print("3. Test the application: python test_application.py")
    print("4. Run main application: python main.py")
    
    print("\n📊 Excel File Structure:")
    print("Your Excel file should have these Portuguese columns:")
    columns = [
        ("Area", "Area name"),
        ("Questao", "Question description"),
        ("Questao Abreviada", "Question title"),
        ("Item Verificacao", "Item description"),
        ("Item Verificacao Abreviada", "Item title"),
        ("Questao Auxiliar", "Action description")
    ]
    
    for col, desc in columns:
        print(f"  • {col:<25} - {desc}")
    
    print("\n🔄 Data Hierarchy:")
    print("Area → Question → Item → Action")
    print("Each level is linked to the previous level")
    
    print("\n🗃️ Database Tables:")
    print("The application creates four related tables in PostgreSQL:")
    tables = [
        ("tb_area", "Stores area information with UUID primary key"),
        ("tb_questao_base", "Stores questions linked to areas"),
        ("tb_item_base", "Stores items linked to questions"),
        ("tb_acao_base", "Stores actions linked to items")
    ]
    
    for table, desc in tables:
        print(f"  • {table:<20} - {desc}")
    
    print("\n🔗 Database Connection:")
    print("Default PostgreSQL connection: postgresql://postgres:password@localhost:5432/excel_data")
    print("Update DATABASE_URL in .env file with your PostgreSQL credentials")

if __name__ == "__main__":
    show_project_structure()