Skip to main content

Templating system/generator for distributions

Project description

Distribution oriented templating system

Copr package Fedora package Coverage Status Documentation Status

The problem this project tries to mitigate is "portable" scripting for variety of operating systems (currently Linux distributions only) in the wild. While writing an "universal" script, one needs to take into account small or bigger differences among operating systems (like package installation tools, versions of utilities, expected directories for binaries, libraries, etc.).

The distgen project is thus something like database of OS differences together with convenience tool-set that allows you to instantiate valid script for particular distribution. The concept is to have template file (mostly raw jinja2 template) together with "declarative" spec file (YAML file) that fulfils the needs of particular template.

You can find distgen documentation at http://distgen.readthedocs.io.

Download/Installation

Stable releases of distgen are available as RPMs in Fedora and EPEL repositories, and in pypi:

$ sudo dnf install distgen

$ pip install distgen

Development (git snapshot) RPMs are automatically built in Fedora Copr.

You can also run development version directly from git, simply use the dg shell wrapper available in this git root directory.

Example with Dockerfile

Typical example is the need to instantiate working FOO package oriented Dockerfiles for all supported Fedora/RHEL versions.

To achieve that goal with distgen, you need to write something like docker.tpl template and FOO.yaml spec file. If the system-default docker.tpl template is good enough, its enough to write proper spec file:

  1. create FOO.yaml spec:

    $ cat FOO.yaml
    maintainer: John Doe <jdoe@example.com>
    parts:
      pkginstall:
        data:
          - type: pkg
            action: install
            packages:
              - vim
      footer:
        cmd: ["vim"]
    
  2. Run dg tool to generate Fedora 22 Dockerfile:

    $ dg --template docker.tpl \
         --spec FOO.yaml \
         --distro fedora-22-x86_64.yaml \
    > Dockerfile
    $ cat Dockerfile
    FROM index.docker.io/fedora:22
    MAINTAINER John Doe <jdoe@example.com>
    
    ENV container="docker"
    
    RUN dnf -y --setopt=tsflags=nodocs install vim \
        && dnf -y --setopt=tsflags=nodocs clean all --enablerepo='*'
    
    CMD ["vim"]
    
  3. Run dg tool again to generate RHEL 7 dockerfile:

    $ dg --template docker.tpl \
         --spec FOO.yaml \
         --distro rhel-7-x86_64.yaml \
    > Dockerfile
    $ cat Dockerfile
    FROM registry.access.redhat.com/rhel7
    MAINTAINER John Doe <jdoe@example.com>
    
    ENV container="docker"
    
    RUN yum -y --setopt=tsflags=nodocs install vim \
        && yum -y --setopt=tsflags=nodocs clean all --enablerepo='*'
    
    CMD ["vim"]
    

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

distgen-2.0.tar.gz (85.3 kB view details)

Uploaded Source

Built Distribution

distgen-2.0-py3-none-any.whl (51.6 kB view details)

Uploaded Python 3

File details

Details for the file distgen-2.0.tar.gz.

File metadata

  • Download URL: distgen-2.0.tar.gz
  • Upload date:
  • Size: 85.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for distgen-2.0.tar.gz
Algorithm Hash digest
SHA256 e6dba27d994541ab83932c8475c21fa9eedede91fb0c20c3338ce6680dd43475
MD5 a8eb0342f8d084a1514a554cf6833fdb
BLAKE2b-256 4ce2a48bc8beacceecd2f132a40053a6efe1ad33e68f56f6ffd1f9c3b8a18fa8

See more details on using hashes here.

Provenance

File details

Details for the file distgen-2.0-py3-none-any.whl.

File metadata

  • Download URL: distgen-2.0-py3-none-any.whl
  • Upload date:
  • Size: 51.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for distgen-2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b2ceaa64656797d1d6dd83e9e9fb5b942cb9aa078c288045b001dc3058cad528
MD5 357e9cb9e6642385d0dfaf77c72d6881
BLAKE2b-256 d29ee352dbdf088e49c89d7e2b13d2d61b163cab557e24a9989a62793f53baff

See more details on using hashes here.

Provenance

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