Getting Started

Getting Started

This guide will help you get up and running with pydantic-settings-export quickly.

Installation

Choose your preferred installation method:

# Using pip
pip install pydantic-settings-export

# Using pipx (recommended for CLI usage)
pipx install pydantic-settings-export

# Using uv
uv tool install pydantic-settings-export

Basic Usage

1. Create Your Settings Model

   from pydantic import BaseSettings
   
   class AppSettings(BaseSettings):
       """Application settings."""
   
       debug: bool = False
       api_key: str
       port: int = 8000
   
       class Config:
           env_prefix = "APP_"

2. Generate Documentation

   # Generate all documentation
   pydantic-settings-export your_app.settings:AppSettings
   
   # Generate specific formats
   pydantic-settings-export --generator markdown your_app.settings:AppSettings

3. Configure Output

   Create or update your pyproject.toml:

   # pyproject.toml
   [tool.pydantic_settings_export]
   project_dir = "."
   default_settings = ["your_app.settings:AppSettings"]
   
   [[tool.pydantic_settings_export.generators.markdown]]
   paths = ["docs/settings.md"]
   
   [[tool.pydantic_settings_export.generators.dotenv]]
   paths = [".env.example"]

Next Steps

• Learn about Configuration options
• Explore available Generators
• Check out CLI Usage for more commands
• Read more about Integration Guide for CI/CD, pre-commit, and other tools

Common Issues

1. Import Errors

   • Ensure your Python path includes your modules
   • Check an import string format
   • Verify file paths

2. Configuration Issues

   • Validate pyproject.toml syntax
   • Check file permissions
   • Verify directory structure

Getting Help

• Check Troubleshooting guide
• Search for existing issues
• Start a discussion