Skip to main content

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

Project description

jconfigpy

PyPI version Python 3.6+ License: MIT

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.

  • configuration should be less intrusive as possible to source code
  • configuration description (or meta data) should be distributed into directory where each configuration is related to
  • configuration should be isolated from each other (the change in one source directory doesn't affect to the other)
  • no additional script or language just for configuration.
  • 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 jconfigpy.py -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)
  4. Adding new module or dependency is simple and isolated from other source tree (improve project scalability)

Required

  1. python 3.6+
  2. GNU Make utility

Licnese

MIT

Project details


Download files

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

Source Distribution

jconfigpy-0.2.4.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jconfigpy-0.2.4-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

Details for the file jconfigpy-0.2.4.tar.gz.

File metadata

  • Download URL: jconfigpy-0.2.4.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for jconfigpy-0.2.4.tar.gz
Algorithm Hash digest
SHA256 bf0714fa995162fd06325ab38f3c243542309aefb8534d88c2bfd14c070e46f9
MD5 8f08ca6ce7758df8cf907b5d23b5445e
BLAKE2b-256 0bdd65483ca70837cc4d2ee5132cae3fe35ec2c9928ff182fdb3a0f48b14eb6c

See more details on using hashes here.

File details

Details for the file jconfigpy-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: jconfigpy-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 13.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for jconfigpy-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 591e0bd87e490128e44a8fbec15361020447b782d54d702929a3ff9a2209d0cc
MD5 2f059f50b43d34a8d85edb03a12502c5
BLAKE2b-256 3b7ffea81d2ebce0a5d98ed77615279868f9e83ca374de74346fcaa222161c0c

See more details on using hashes here.

Supported by

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