sample-env 1.0.0

A command line tool for generating sample env files from pydantic BaseSettings.

sample-env

A CLI tool for generating sample env files from pydantic_settings.BaseSettings.

Installation

pip install sample-env

Command-line usage

Let's assume the following BaseSettings.

from pydantic_settings import BaseSettings


class Environment(BaseSettings):
    DEBUG: bool = True
    POSTGRES_HOST: str = "localhost"
    POSTGRES_USER: str = "postgres"
    POSTGRES_DB: str = "db"
    POSTGRES_PASSWORD: str = "postgres"
    POSTGRES_PORT: str = "5432"

You can generate a .env.sample file with this command:

sample-env example.Environment

Output

DEBUG=True
POSTGRES_HOST=localhost
POSTGRES_USER=postgres
POSTGRES_DB=db
POSTGRES_PASSWORD=postgres
POSTGRES_PORT=5432