Skip to main content

configuration utility which easily integrated into project using gnu make as build system

Project description

# jconfigpy

[![Codacy Badge](](
configuration utility compatible to GNU Make

## Motivation
many C / C++ projects configured heavily based on macro variables and they make project readability worse.
If project scale is getting larger, macro variables are added much more and macro branch points also become too
complicated to manage project properly. and I really didn't like this kind of messy hell and started new project
inspired from kconfig used in linux kernel build system.

## About
jconfigpy is an implementation effort of a few points that are considered to be able to resolve many issues mentioned preceeding section.

1. configuration should be less intrusive as possible to source code
2. configuration description (or meta data) should be distributed into directory where each configuration is related to
3. configuration should be isolated from each other (the change in one source directory doesn't affect to the other)
4. no additional script or language just for configuration.
5. configuration utility should be able to resolve dependencies by itself.

jconfigpy is inspired from kconfig in linux in many parts. actually, I tried it first, however, it was less portable
and require another set of script language. it's quite simple though, we have a lots of familiar scripts or
markup language suitable for representing configuration description model. (and I choose JSON) so I decided to
rewrite old stuff using new tools

## Getting Started
you can see how it works by input following in command line
$ python jconfigpy -c -i ../example/config.json

or you can load configuration to generate header file and resolve dependencies
$ python -s -i ../configs/config -t ../example/config.json

## Feature
1. JSON based configuration script (ease of use)
2. Keep source code (even Makefile) simple (good readability)
3. dependencies resolution (git)
3. Adding new module or dependency is simple and isolated from other source tree (improve project scalability)

## Required
1. python 2.7
2. GNU Make utility

## Licnes

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 jconfigpy, version 0.1.3
Filename, size File type Python version Upload date Hashes
Filename, size jconfigpy-0.1.3-py2-none-any.whl (14.5 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size jconfigpy-0.1.3.tar.gz (9.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page