Skip to main content

inicheck is an high level configuration file checker enabling developers tight control over their users configuration files

Project description

Welcome to inicheck

https://img.shields.io/pypi/v/inicheck.svg Documentation Status https://travis-ci.com/USDA-ARS-NWRC/inicheck.svg?branch=master https://coveralls.io/repos/github/USDA-ARS-NWRC/inicheck/badge.svg?branch=master

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.

History

0.1.0 (2018-01-05)

  • First release on PyPI.

0.2.0 (2018-04-11)

  • Recipes were added in
  • Custom Checkers
  • Multiple master files can be used
  • Module associated files to find master configs
  • Detail finding in cli to get help on the fly

0.3.0 (2018-08-10)

  • Added the ability require an config entry be a list
  • Added significant unit tests

0.4.0 (2019-07-19)

  • Added in url datatype
  • Added Datetime Ordered data type for start stop options
  • Added in an inidiff script for comparing config files

0.5.0 (2019-08-22)

  • Fixed bug relating to Datetime Ordered Pairs
  • Added in inimake script for creating scripts from scratch
  • Added in more unittests (54% coverage)

0.6.0 (2019-10-16)

  • Built in a brand new feature for migrating large changes in configs
  • Added bounds checking for type checking allowing for continuous types
  • Fixes for issues: 25 , 27 , 31 , 32

0.7.0 (2019-10-22)

  • Restructure the checkers some to better handle types
  • Fixed several broken tests.

0.8.0 (05-29-2020)

  • Increased unittest coverage from ~57% to ~83%)
  • Added in a CLI tool to find changelog impacts in python files
  • Switch from pandas to_datetime to dateparser to reduce package size
  • Added inicheck to traviCI and Coveralls
  • Fixes for 35 , 38 , 39, 40, 41, 42 43, 44, 45
  • Added in linting with isort and autopep8
  • Hardcoded parse_date to always use UTC and return timezone unaware object. 51
  • Updated release to use setuptools_scm. 52

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for inicheck, version 0.9.1
Filename, size File type Python version Upload date Hashes
Filename, size inicheck-0.9.1-py3-none-any.whl (41.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size inicheck-0.9.1.tar.gz (79.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page