7000pctAUTO/confdoc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

1 Release 1 Tag

RSS Feed
  • v0.1.0 83fed49c44
    Compare

    v0.1.0
    Some checks failed
    CI / test (push) Failing after 14s
    Details
    Stable

    7000pctAUTO released this 2026-01-31 07:10:40 +00:00 | 26 commits to main since this release

    Initial Release v0.1.0

    ConfDoc is a CLI tool for validating JSON/YAML/TOML configuration files against a schema with clear error messages, and auto-generating human-readable markdown documentation from your schemas.

    Features

    • Multi-format Support: Parse and validate JSON, YAML, and TOML configuration files
    • Schema Validation: Validate configurations against JSON Schema with detailed error messages
    • Auto-generated Documentation: Generate clean markdown documentation from schemas
    • Environment Profiles: Built-in development, staging, and production profiles
    • Type Inference: Automatically infer schema from existing configurations
    • CLI Interface: Easy-to-use commands for validation, documentation, and schema initialization

    Installation

    pip install confdoc

    Quick Start

    # Validate a config
confdoc validate config.json --schema schema.json

# Generate documentation
confdoc doc schema.json --output CONFIGURATION.md

# Initialize a new schema
confdoc init schema.json

    Files

    • Source code in src/confdoc/
    • Tests in tests/
    • Examples in examples/
    Downloads