TOMLParams¶

Version 0.1.7

TOML-based parameter files made better

Authors

Smart Data Foundry Limited

Contents

  • 1. TOMLParams
    • 1.1. Key features
    • 1.2. Installation
  • 2. Sample Usage
    • 2.1. The Simplest Case (Defaults Only)
    • 2.2. Using a TOML file to override some parameter values
  • 3. Setting defaults from a TOML File
    • 3.1. Setting a custom TOML file name and Parameter (Key) Checking
  • 4. Hierarchical Inclusion
    • 4.1. Writing out the consolidated TOML file
  • 5. Determination of Name of TOML Parameters File
    • 5.1. Idiomatic command-line use
  • 6. Environment Variables
  • 7. Type Checking
  • 8. Command line tool tomlparams
  • 9. Documentation and API Help
  • 10. TOMLParams class
    • TOMLParams

Index • Search

Logo

TOMLParams

Navigation

  • 1. TOMLParams
  • 2. Sample Usage
  • 3. Setting defaults from a TOML File
  • 4. Hierarchical Inclusion
  • 5. Determination of Name of TOML Parameters File
  • 6. Environment Variables
  • 7. Type Checking
  • 8. Command line tool tomlparams
  • 9. Documentation and API Help
  • 10. TOMLParams class

Related Topics

  • Documentation overview
    • Next: 1. TOMLParams

Quick search

©2023, Smart Data Foundry Limited. | Powered by Sphinx 7.0.1 & Alabaster 0.7.13 | Page source