collective.normalize_buildout 0.2.0

A buildout config file normalizer

collective.normalize_buildout

Do you have multiple buildouts and you want an easy way to apply new best practices to each buildout in a simple way, but you cannot, because every buildout file is configured slightly different?

Then this package is for you. The normalize_buildout is a script that will normalize your buildout file.

The tool sorts sections and the keys in each section alphabetically, also some special multi line values, like eggs.

Features

normalize_buildout by default will replace the given config file in place. It has a command line option for not changing the file and only reporting via exit code if the file is not normalized. This can easily be integrated in check tools or ci tools.

The script understands the special meaning of some sections and keys:

• buildout section is always the first

• versions section is always the last

• recipe key is always first

• eggs, and zcml values get sorted.

• keys of sources entries get sorted, values get indented so that branch settings are all on the same column.

Comments above sections and above keys get shuffled together with key or section. You can document why you need to pin a specific version of a package and after normalization, the comment is still above the right version specifier. - Can be bullet points

Installation

You can install the package with pip or zc.buildout.

PIP:

$ pip install collective.normalize_buildout

Buildout:

[buildout]

 ...
 [extras]
 recipe = zc.recipe.egg
 eggs =
     collective.normalize_buildout

and then running “bin/buildout”

Usage

You can do three things with this command.

1. Check if a config file is normalized (for CI):

   $ normalize_buildout -c buildout.cfg

   This will either return nothing, or a warning that the buildout is not normalized. It will have a falsy return code for CI.

2. Normalize a config file in place:

   $ normalize_buildout buildout.cfg

   This will normalize the buildout file.

3. Read a config file from stdin and print it on stdout, useful in vim:

   :%!normalize_buildout -

   On failure, this command will print out the config file unmodified.

Contribute

• Issue Tracker: https://github.com/collective/collective.normalize_buildout/issues

• Source Code: https://github.com/collective/collective.normalize_buildout

Contributors

• Patrick Gerken, [e-mail]

Changelog

0.2.0 (2015-09-11)

• Support piping. [do3cc]

• Remove unneeded dependency. [do3cc]

• Fix 3 bugs resulting in bad buildout.cfgs. [do3cc]

0.1 (2015-09-10)

• Initial release. [do3cc]