Skip to main content

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

Metadata

Release files for jconfigpy 0.2.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jconfigpy 0.2.4
File Size Uploaded
jconfigpy-0.2.4.tar.gz 12.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for jconfigpy 0.2.4
File Interpreter ABI Platform
jconfigpy-0.2.4-py3-none-any.whl Python 3 none any Details

Total release size: 26.6 kB

Release files / jconfigpy-0.2.4.tar.gz

Download URL jconfigpy-0.2.4.tar.gz
Size 12.9 kB
Tags Source
SHA-256 checksum
How to use checksums
bf0714fa995162fd06325ab38f3c243542309aefb8534d88c2bfd14c070e46f9
BLAKE2b-256 checksum
How to use checksums
0bdd65483ca70837cc4d2ee5132cae3fe35ec2c9928ff182fdb3a0f48b14eb6c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.5

Release files / jconfigpy-0.2.4-py3-none-any.whl

Download URL jconfigpy-0.2.4-py3-none-any.whl
Size 13.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
591e0bd87e490128e44a8fbec15361020447b782d54d702929a3ff9a2209d0cc
BLAKE2b-256 checksum
How to use checksums
3b7ffea81d2ebce0a5d98ed77615279868f9e83ca374de74346fcaa222161c0c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.5

Release history Release notifications | RSS feed

This release

0.2.4 This release

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.9

3 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

1 release file

0.1.1

2 release files

0.0.9

1 release file

0.0.8

1 release file

0.0.7

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page