envdot

Getting Started

  • Installation
    • Requirements
      • Optional Dependencies
    • Installing from PyPI
    • Installing with Extras
      • YAML Support
      • All Extras
    • Installing from Source
    • Development Installation
    • Verifying Installation
    • Upgrading
    • Uninstalling
    • Compatibility
  • Quickstart
    • Creating Your First .env File
    • Loading Environment Variables
    • Using the DotEnv Class
    • Automatic Type Detection
    • Setting Values
    • Attribute Access
    • Saving Changes
    • Method Chaining
    • Default Values
    • Using with os.getenv
    • Next Steps

User Guide

  • Basic Usage
    • Loading Environment Variables
      • Using Convenience Functions
      • Using the DotEnv Class
    • Getting Values
      • Using get() Method
      • Using Convenience Function
      • Dictionary-Style Access
      • Attribute Access
    • Setting Values
      • Using set() Method
      • Using Convenience Function
      • Dictionary-Style Assignment
    • Saving Variables
      • Save to File
    • Deleting Variables
    • Clearing Variables
    • Display Variables
    • Method Chaining
    • OS Environment Integration
    • Real-World Example
  • File Formats
    • Supported Formats
    • .env Format
    • JSON Format
    • YAML Format
    • INI Format
    • Auto-Detection
    • Converting Between Formats
    • Format Comparison
    • Nested Structure Handling
    • List Handling
    • Best Practices
  • Type Detection
    • How It Works
    • Type Detection Rules
      • Boolean Values
      • None Values
      • Integer Values
      • Float Values
      • String Values
    • Explicit Type Casting
      • List Values
      • Tuple Values
      • Type Conversion Errors
    • Using Helper Functions
    • Comparison with os.getenv
    • Patching os Module
    • TypeDetector Class
    • Best Practices
  • Advanced Features
    • Load Options
      • Override Behavior
      • OS Environment Sync
    • Multiple Configuration Files
    • Environment-Based Loading
    • Custom Type Handlers
    • Configuration Classes
    • Validation
      • Value Validation
    • Context Managers
    • Lazy Loading
    • Watching for Changes
    • Thread Safety
    • Testing with envdot

API Reference

  • DotEnv Class
    • Class Reference
      • DotEnv
    • Methods
      • load()
        • DotEnv.load()
      • get()
        • DotEnv.get()
      • set()
        • DotEnv.set()
      • save()
        • DotEnv.save()
      • delete()
        • DotEnv.delete()
      • all()
        • DotEnv.all()
      • keys()
        • DotEnv.keys()
      • clear()
        • DotEnv.clear()
      • show()
        • DotEnv.show()
    • Magic Methods
      • __getitem__
        • DotEnv.__getitem__()
      • __setitem__
        • DotEnv.__setitem__()
      • __contains__
        • DotEnv.__contains__()
      • __getattr__
        • DotEnv.__getattr__()
      • __setattr__
        • DotEnv.__setattr__()
      • __repr__
        • DotEnv.__repr__()
  • Convenience Functions
    • load_env()
      • load_env()
    • get_env()
      • get_env()
    • set_env()
      • set_env()
    • save_env()
      • save_env()
    • show()
      • show()
    • Combined Example
    • Comparison: Functions vs Class
  • Helper Functions
    • Typed Getters
      • getenv_typed()
        • getenv_typed()
      • getenv_int()
        • getenv_int()
      • getenv_bool()
        • getenv_bool()
      • getenv_float()
        • getenv_float()
      • getenv_str()
        • getenv_str()
    • Typed Setter
      • setenv_typed()
        • setenv_typed()
    • OS Module Patching
      • patch_os_module()
        • patch_os_module()
    • Comparison: Standard vs Typed
    • Complete Example
  • Exceptions
    • Exception Hierarchy
    • Base Exception
      • EnvDotError
        • EnvDotError
    • File Exceptions
      • FileNotFoundError
        • FileNotFoundError
    • Parsing Exceptions
      • ParseError
        • ParseError
    • Type Exceptions
      • TypeConversionError
        • TypeConversionError
    • Error Handling Patterns
      • Catching Specific Errors
      • Catching All envdot Errors
      • Safe Value Retrieval
      • Validation with Exceptions

Development

  • Contributing
    • Getting Started
      • Fork and Clone
      • Development Setup
    • Development Workflow
      • Creating a Branch
      • Making Changes
      • Committing
      • Submitting a Pull Request
    • Coding Standards
      • Code Style
      • Documentation
    • Testing
      • Writing Tests
      • Running Tests
    • Reporting Issues
      • Bug Reports
      • Feature Requests
    • Code of Conduct
    • Getting Help
  • Changelog
    • [1.0.14] - 2025
      • Current Release
    • [1.0.0] - Initial Release
    • Roadmap
      • Planned Features
      • Contributing
    • Versioning
    • Deprecation Policy
envdot
  • Search

© Copyright 2026, Hadi Cahyadi.

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