Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

This project was born to generate dhcp/dns configuration files on a machine which resources are too limited to run a LDAP server.

What it basically does is:

  • Load a bunch of files from a directory, and make them accessible in a dictionary.

  • Render a bunch of files through some template engine, passing the context.

Build status

Installation

Production version:

$ pip install config-gen

Development version:

$ pip install -e git+git@github.com:rshk/config-gen.git#egg=config-gen

Or just run python setup.py install from the source directory.

Trying out

The fastest way to get started with config-gen is the quickstart script, that takes care of creating all the needed directories plus a Makefile, in the current directory:

$ confgen-quickstart
$ make
$ cat build/example.html
<h1>Hello, world!</h1>

How does it work?

In a very simple way: all files in the templates directory are built into files in build, with the original extension stripped. Eg:

templates/hello.jinja -> build/hello
templates/hello.html.jinja -> build/hello.html
templates/example.html.jinja -> build/example.html

The context for rendered files is built from files in the data directory. To each file in that directory, a “reader” is associated, by reading the file extension.

Then, a context variable with the same name of the file (without extension) will be made available in the template.

Included readers

Readers are used to read data files and make them accessible in the template context.

Their name (without extension) must be unique all around the data directory, to prevent conflicts.

txt (config_gen.readers.read_txt.txt_reader)

Loads a plain text file, returning its raw content directly.

py (config_gen.readers.read_py.PyFileAccessor)

Loads and returns a Python module.

The module content will then be fully accessible from the template.

json (config_gen.readers.read_json.json_reader)

Reads a JSON file and returns it directly. It will then be accessible as usual from the template.

csv (config_gen.readers.read_csv.csv_reader)

Reads a Comma-Separated Values file into a list of tuples.

The CSV file must be comma-separated (semicolons are not supported). Fields containing commas must be enclosed in double quotes.

ini (config_gen.readers.read_ini.IniFileReader)

Reader for configuration/.ini files.

Files will be accessible as:

{{ filename.section.option }}

Or, for sections/options containing dots:

{{ filename["my.sect.ion"]["my.opt.ion"] }}

Template engines

To render the templates into configuration files, the awesome Jinja2 template engine has been used.

I once thought about allowing pluggable template engines, but the awesomeness of Jinja made me rethink that decision :)

(By the way, just let me know if you’d absolutely need support for another template engine, and why..)

Testing

To run the complete test suite:

$ python -m unittest discover -s tests

To run only tests in a specific sub-module:

$ python -m unittest tests.test_something

TODO-List

  • Add support for XML/YAML files

  • Add support for database connections (sqlite, mysql, postgres, mongo..)

  • Add support for “custom cases”, through some kind of configuration file * Eg. for semicolon-separated CSV files

  • Add support for importing external readers (add a --load option?)

  • Write the missing test cases

Metadata

Release files for Config-gen 1.0-alpha6

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

Source distribution (sdist)

Source distribution for Config-gen 1.0-alpha6
File Size Uploaded Provenance Actions
Config-gen-1.0-alpha6.tar.gz 7.1 kB Without provenance Details for Config-gen-1.0-alpha6.tar.gz

Release files / Config-gen-1.0-alpha6.tar.gz

Download URL Config-gen-1.0-alpha6.tar.gz
Size 7.1 kB
Tags Source
SHA-256 checksum
How to use checksums
e409e8c42dbb2a58123735c176826612a9a79f532298c4fc45f472ec997cad8c
BLAKE2b-256 checksum
How to use checksums
849aec8327b904fad4a37a485d301e8226abe1ba81f410c6513f3c3935a7b405
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for Config-gen 1.0-alpha6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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