Release v1.0.1 (What’s new?).

---

Welcome to configirl Documentation

If you are looking for technical support, click the badge below to join this gitter chat room and ask question to the author.

What is configirl

configirl is a single script, pure python, no dependencies, python2.7, 3.4+ compatible, drop in ready python library to help you manage complex config value logic. This devops solution applies to ANY PROJECT, ANY PROGRAMMING LANGUAGE.

from configirl import ConfigClass, Constant, Deriable

class Config(object):
    PROJECT_NAME = Constant()
    PROJECT_NAME_SLUG = Deriable()

    @PROJECT_NAME_SLUG.getter
    def get_project_name_slug(self):
        return self.PROJECT_NAME.get_value().replace("_", "-")

config = Config(PROJECT_NAME="my_project")

What problem does configirl solve

Devops Engineer has to deal with lots of config and parameters everyday. Some config value are just a constant value, like a integer and a string. Some config value can be derived from other config values, sometimes event requires the context.

There are lots of Devops tools available in the community, such as:

• Shell Script for command line tool, automation
• Jenkins groovy for CI/CD
• Cloudformation for Infrastructure as Code
• Terraform for Infrastructure as Code
• …

They all using different language and different syntax. The method of managing config value in different tools varies very much! If you have to manage a list of config values, and you are using multiple devops tools in the same project. Allow those tools talk to each other is NOT EASY at all. And the effort to manage config value in certain tools might be very difficult (like CloudFormation).

configirl provides a solution to manage complex logic for config values in an elegant way. Since Python is easy to learn and it is full featured programming language, you got the perfect balance of simplicity and flexibility. To integrate with any Devops tools, you just reference the value from the finalized config JSON file.

Table of Content

• Quick Start
  • Install configirl
  • Config Declaration
  • Initialize Config Object
  • Reference Config Value in Python Application Code
  • Dump Derived Config Value to Dict data or to File
  • Prevent Printing Sensitive Information to Console
  • Prevent Dump Sensitive Information to Json File
  • Cache Expensive Dynamic Field
  • Custom Validator
• configirl CLI
  • read-json-value sub command
  • get-config-value sub command
  • import-config-value sub command
• Integrate with Shell Script
• Integrate with other DevOps Tool
• Related DevOps Tool

Install

configirl is released on PyPI, so all you need is:

$ pip install configirl

To upgrade to latest version:

$ pip install --upgrade configirl

About the Author

(\ (\
( -.-)o    I am a lovely Rabbit!
o_(")(")

Sanhe Hu is a very active Python Developer Since 2010. Research area includes Machine Learning, Big Data Infrastructure, Block Chain, Business Intelligent, AWS, Distributive System. Love photography, outdoor, arts, game, and also the best Python.

• My Github: https://github.com/MacHu-GWU
• My HomePage: http://www.sanhehu.org/
• My Linkedin: https://www.linkedin.com/in/sanhehu/

API Document

• by Name
• by Structure