example_usage.py

#!/usr/bin/env python3
"""
Example usage of flatten_directory.py
This script demonstrates how to use the flatten directory functionality programmatically.
"""

import sys
import os
from pathlib import Path

# Add the current directory to the path so we can import our module
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))

# Import the functions from our flatten_directory module
from flatten_directory import collect_files, generate_output_content

def example_basic_usage():
    """Example of basic usage."""
    print("=== Basic Usage Example ===")
    
    # Get the test project directory
    test_dir = Path("test_project")
    
    if not test_dir.exists():
        print("Test project directory not found. Please run the basic test first.")
        return
    
    # Collect all files
    files = collect_files(test_dir)
    
    print(f"Found {len(files)} files in {test_dir}")
    
    # Generate the flattened content
    content = generate_output_content(files, test_dir.name)
    
    # Write to a file
    output_file = "example_output.txt"
    with open(output_file, 'w', encoding='utf-8') as f:
        f.write(content)
    
    print(f"Flattened content written to: {output_file}")
    print(f"Content length: {len(content)} characters")
    print()

def example_filtered_usage():
    """Example of filtered usage."""
    print("=== Filtered Usage Example ===")
    
    # Get the test project directory
    test_dir = Path("test_project")
    
    if not test_dir.exists():
        print("Test project directory not found. Please run the basic test first.")
        return
    
    # Collect all files
    files = collect_files(test_dir)
    
    # Filter to only include Python files
    python_files = [f for f in files if f['extension'] == '.py']
    
    print(f"Found {len(python_files)} Python files in {test_dir}")
    
    # Generate the flattened content
    content = generate_output_content(python_files, f"{test_dir.name}_python_only")
    
    # Write to a file
    output_file = "python_only_output.txt"
    with open(output_file, 'w', encoding='utf-8') as f:
        f.write(content)
    
    print(f"Python-only content written to: {output_file}")
    print(f"Content length: {len(content)} characters")
    print()

def example_custom_format():
    """Example of custom output format."""
    print("=== Custom Format Example ===")
    
    # Get the test project directory
    test_dir = Path("test_project")
    
    if not test_dir.exists():
        print("Test project directory not found. Please run the basic test first.")
        return
    
    # Collect all files
    files = collect_files(test_dir)
    
    # Create a custom format
    custom_content = []
    custom_content.append("# Custom Flattened Directory Report")
    custom_content.append(f"Directory: {test_dir.name}")
    custom_content.append(f"Total Files: {len(files)}")
    custom_content.append("")
    
    # Add file summary
    custom_content.append("## File Summary")
    total_size = 0
    for file_info in files:
        size = file_info['size']
        total_size += size
        size_str = f"{size} bytes" if size < 1024 else f"{size // 1024} KB"
        custom_content.append(f"- {file_info['path']} ({size_str})")
    
    custom_content.append(f"")
    custom_content.append(f"Total Size: {total_size} bytes ({total_size // 1024} KB)")
    custom_content.append("")
    
    # Add file contents with custom formatting
    custom_content.append("## File Contents")
    for i, file_info in enumerate(files, 1):
        custom_content.append(f"### {i}. {file_info['path']}")
        custom_content.append(f"**Size:** {file_info['size']} bytes")
        custom_content.append(f"**Type:** {file_info['extension']}")
        custom_content.append("")
        custom_content.append("```")
        custom_content.append(file_info['content'])
        custom_content.append("```")
        custom_content.append("")
    
    # Write to a file
    output_file = "custom_format_output.md"
    with open(output_file, 'w', encoding='utf-8') as f:
        f.write("\n".join(custom_content))
    
    print(f"Custom format content written to: {output_file}")
    content_str = '\n'.join(custom_content)
    print(f"Content length: {len(content_str)} characters")
    print()

def main():
    """Run all examples."""
    print("Flatten Directory - Example Usage")
    print("=" * 40)
    print()
    
    # Check if test project exists
    test_dir = Path("test_project")
    if not test_dir.exists():
        print("Test project directory not found.")
        print("Please run the basic test first to create the test project.")
        print("You can run: python3 flatten_directory.py test_project")
        return
    
    # Run examples
    example_basic_usage()
    example_filtered_usage()
    example_custom_format()
    
    print("All examples completed!")
    print("Check the generated output files:")
    print("- example_output.txt")
    print("- python_only_output.txt")
    print("- custom_format_output.md")

if __name__ == "__main__":
    main()