Skip to main content

Welcome to inicheck

https://img.shields.io/pypi/v/inicheck.svg Documentation Status Testing Status

What is inicheck?

inicheck is an advanced configuration file checker/manager enabling developers high end control over their users configuration files. inicheck is specifcially aimed at files that adhere to the .ini format. See wiki for more info on the file standards https://en.wikipedia.org/wiki/INI_file .

Objectives

The goal of inicheck was to reduce endless logic gates and repeat code for software that required complicated configuration files. We also wanted to centralize options for an ever changing repo. We have a lot of experience with codes that required config files that could easily have 1000 different configurations. So from that need inicheck has been born.

Basic Principles

inicheck requires a master config file to operate. The master config file is a gold standard files provided by the developer of a package. The master config (sometimes called the core config) provides the rules for every configuration file that is passed to the software. There the developer can set types, constrain options, documentation strings and defaults. The developer can also create recipes that can be triggered when a user has a specific combination of config file entries.

Once a master config file is created, all config files can be passed through the standards laid out in there. From there the software can provide feedback to the user about why their file is being rejected. The master file also enables the user to have really simple config files that have larger meaning. With recipes and defaults, a user can provide relatively little and the developer can still move forward without have a ridiculous amount of logic to handle scenarios.

Features

  • .ini file generating

  • Config file checking

  • Config file warning and error reporting

  • Command line interface

  • Apply defaults

  • Auto cast items into the correct types.

  • Constrain users by designated options

  • Create recipes to ensure the right settings are in place

  • Use custom types for your config file

  • Use multiple master config files for cleaner files

  • Auto config file documentation

  • Create changelogs to automatically manage deprecated config options

Credits

inicheck has been developed at the USDA-ARS-NWRC during efforts towards creating highly configurable, physically based watershed modeling software.

inicheck originally was based on config parser and with time went away from it. We would not be here with that base and for that were grateful.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Metadata

Release files for m3w-inicheck 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for m3w-inicheck 0.3.0
File Size Uploaded Provenance Actions
m3w_inicheck-0.3.0.tar.gz 73.2 kB With provenance Details for m3w_inicheck-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for m3w-inicheck 0.3.0
File Interpreter ABI Platform Actions
m3w_inicheck-0.3.0-py3-none-any.whl Python 3 none any Details for m3w_inicheck-0.3.0-py3-none-any.whl

Total release size: 113.0 kB

Release files / m3w_inicheck-0.3.0.tar.gz

Download URL m3w_inicheck-0.3.0.tar.gz
Size 73.2 kB
Tags Source
SHA-256 checksum
How to use checksums
ad43e131a5288e5e2629f41b569a3b84c8a45ec016d25d671e155788eb7656b3
BLAKE2b-256 checksum
How to use checksums
30688274ab7cdf3e7062e3cb7fce18e4aec52626789752e8515cb9d3ae253ce7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 28, 2026.

Transparency log

Release files / m3w_inicheck-0.3.0-py3-none-any.whl

Download URL m3w_inicheck-0.3.0-py3-none-any.whl
Size 39.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
750433d77ef0e4045c7e4c3d9d2a647c1d4185babc490df03f4e2c15e076118c
BLAKE2b-256 checksum
How to use checksums
732bc643594e4322d9c187e7c5f2569dd2f6412ca6811daa7b3860b03af8c73e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 28, 2026.

Transparency log

Security for m3w-inicheck 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for m3w_inicheck-0.3.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 28, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page