Configuration

Configuration uses a YAML file with PascalCase parameter names. You can reference other parameters with #[ParamName] syntax and environment variables with ${VAR} syntax.

See the examples for complete configuration examples.

pydantic model nameping.config.schema.Config

Nameping configuration schema.

Fields:

• CompanyRegistries (list[str])

• CompanyTypes (list[str])

• DelayMax (float)

• DelayMin (float)

• JsonIndent (int)

• OpenCorporatesApiKey (str | None)

• OutputFormat (Literal['json', 'csv', 'table'])

• RetryBackoffFactor (float)

• RetryMaxAttempts (int)

• TableStyle (Literal['ascii', 'rounded', 'minimal', 'markdown'])

• Timeout (int)

• TopLevelDomains (list[str])

field CompanyRegistries: list[str] = ['delaware']

Registry to check company names from.

field CompanyTypes: list[str] = ['llc']

Types of companies to check.

field DelayMax: float = 5.0

Maximum random delay in seconds between requests.

Constraints:

• ge = 0

field DelayMin: float = 1.0

Minimum random delay in seconds between requests.

Constraints:

• ge = 0

field JsonIndent: int = 2

JSON indentation

Constraints:

• ge = 0

field OpenCorporatesApiKey: str | None = None

API key for OpenCorporates

field OutputFormat: Literal['json', 'csv', 'table'] = 'json'

Default output format

field RetryBackoffFactor: float = 0.5

Retry backoff factor

Constraints:

• ge = 0

field RetryMaxAttempts: int = 3

Retry max attempts

Constraints:

• ge = 0

field TableStyle: Literal['ascii', 'rounded', 'minimal', 'markdown'] = 'rounded'

Table style

field Timeout: int = 10

Request timeout in seconds

Constraints:

• ge = 1

field TopLevelDomains: list[str] = ['com']

Top level domains to check.