Skip to main content

Templater for app configuration files.

Project description

Config files templater

Package provides templating of mako-based templates of package config files.

Purpose

The main idea is, that config can be generated via console arguments of it`s required values. It is useful for deploy with configuration systems like ansible and others.

There is no more reason to keep config template itself separately from application (in deploy scripts/roles/whatever) or to define example with comments what config values require changing.

Besides that, package or program, as usual, is situated in system package directory (with config templates), that looks like one more problem during configuring.

Installation (standalone usage)

sudo -H python 3 -m pip install conf-templater

Usage (standalone)

conf_templater --help

or

config_templater --help

Usage (python package)

  • Add conf-templater to requirements.txt.

  • Create cli script file, for example mypackage/scripts/config.py, that contains:

from conf_templater import template_config


def run():
    template_config(package='mypackage', subpath='config')


if __name__ == '__main__':
    run()
  • Create config file in package structure, for example mypackage/config/development.mako

  • Define entry point in setup.py file:

from setuptools import setup

setup(
    name='mypackage',
    install_requires=[
        'conf_templater'
    ],
    entry_points={
        'console_scripts': [
            'mypackage_config = mypackage.scripts.config:run'
        ]
    }
)
  • Run for development
python3 -m pip install -e .
  • Run for help
mypackage_config --help

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

conf_templater-0.2.0-py3-none-any.whl (5.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page