SheetAlchemy

User Guide

  • Installation
    • Requirements
    • Installing SheetAlchemy
      • From PyPI
      • From GitHub
      • For Development
    • Installing Dependencies
      • Core Dependencies
      • Optional Dependencies
    • Verifying Installation
    • Google Sheets API Setup
    • Next Steps
    • Troubleshooting
      • Common Issues
  • Quick Start Guide
    • Prerequisites
    • Step 1: Authentication
    • Step 2: Define Your Model
    • Step 3: Query Your Data
      • Get All Records
      • Filter Records
      • Get Single Record
    • Step 4: Working with Results
    • Complete Example
    • Example Google Sheet Structure
    • Next Steps
    • Common Patterns
      • Filter by Multiple Conditions
      • Case-Insensitive String Matching
      • Range Queries
      • Error Handling
  • Authentication
    • Overview
    • Authentication Methods
      • Method 1: Key File Path
      • Method 2: Key Object
      • Method 3: Environment Variable
    • Setting Up Google Sheets API
      • Step-by-Step Guide
    • Security Best Practices
      • Protecting Credentials
      • Example .gitignore Entry
      • Using Secret Managers
        • AWS Secrets Manager Example
    • Environment-Specific Configuration
      • Development
      • Production
      • Using .env Files
    • Troubleshooting
      • Common Authentication Errors
      • Checking Authentication Status
    • Advanced: Multiple Service Accounts
    • Next Steps
  • Models
    • Defining Models
      • Basic Model
    • Meta Configuration
      • Required Settings
        • sheet_name
        • tab_name
        • header_index
      • Optional Settings
        • load_policy
      • Example with All Settings
    • Load Policies
      • LAZY Loading (Default)
      • INIT Loading
    • Model Manager
      • Manager Methods
        • filter()
        • get()
        • reload_model()
        • initialise_model()
    • Working with Model Instances
      • Accessing Fields
      • Model Methods
        • to_json()
        • get_errors()
        • get_raw_data()
        • get_raw_value()
    • Model Inheritance
    • Multiple Models, Same Sheet
    • Best Practices
    • Common Patterns
      • Configuration Model
      • Lookup Tables
    • Next Steps
  • Fields
    • Field Types
      • StringField
      • IntegerField
      • DecimalField
      • BooleanField
      • DateField
      • ListField
      • CustomField
    • Field Parameters
      • Common Parameters
        • name
        • allow_empty_or_null
        • default_val
        • pre_transform
        • post_transform
      • Example Usage
    • Data Transformations
      • Pre-Transformations
      • Post-Transformations
      • Built-in Transformers
    • Field Validation
      • Checking for Errors
      • Common Validation Errors
      • Custom Validation
    • Query Operators Reference
      • String Operators
      • Numeric Operators
      • Date Operators
      • Boolean Operators
    • Best Practices
    • Common Patterns
      • Email Field
      • Percentage Field
      • Multi-Select Field
    • Next Steps
  • Querying
    • Manager Methods
      • filter()
      • get()
    • Working with Results
    • Query Operators
      • Field Lookups
        • Comparison Operators
        • String Operators
    • Complex Queries
      • Multiple Conditions
      • Chaining Filters
    • Error Handling
      • Handle Missing Records
      • Check for Empty Results
    • Best Practices
    • Next Steps
  • Advanced Usage
    • Custom Transformers
    • Model Reload
    • Performance Optimization
      • Load Policy Selection
    • Best Practices
    • Next Steps
SheetAlchemy
  • Search

© Copyright 2025, Devendra Pratap Singh.

Built with Sphinx using a theme provided by Read the Docs.