Welcome to pytoolconfig’s documentation!

Python Tool Configuration

The goal of this project is to manage configuration for python tools, such as rope and add support for a pyproject.toml configuration file.

• Configuration file autodetection. (Searches for the .git and .hg directories (and others as configured)).

• Optional global configuration

• Optional command line overwrites

• Optional Pydantic data validation and output.

• Universal Configuration keys

• Documentation Generation

Configuration Sources

• Pyproject.toml - default, mandatory

• Ini files

• setup.cfg

• Command line arguments

• Custom sources

Usage

1. Define a pydantic model

2. Initialize pytoolconfig

3. (Optional) Add custom configuration sources

4. Parse configuration

5. (Optional) Generate schema.json and Configuration.md

Configuration Load Order

1. Command Line - overwrites selected configuration properties individually

2. pyproject.toml (mandatory, automatic) if tool.rope (or your tool) is present

3. additional sources configured in order they were added.

4. global configuration from pytool.toml global file

5. configured global configurations

Contents

• Command Line Overwrites
• Universal Configuration
  • Available configuration keys:
• Documentation
  • Table Documentation
• Global Configuration
• Pydantic
  • Fields
• API
  • pytoolconfig
  • pytoolconfig.PyToolConfig
  • pytoolconfig.sources.Source
  • pytoolconfig.sources.IniConfig
  • pytoolconfig.sources.SetupConfig
  • pytoolconfig.sources.PyProject
  • pytoolconfig.sources.PyTool

Indices and tables

• Index

• Module Index

• Search Page