# salt.states.zcbuildout

## Management of zc.buildout

This module is inspired from minitage's buildout maker (https://github.com/minitage/minitage/blob/master/src/minitage/core/makers/buildout.py)

Added in version 2016.3.0.

Note

This state module is beta; the API is subject to change and no promise as to performance or functionality is yet present

### Available Functions

- built

      installed1
        buildout.installed:
          - name: /path/to/buildout

      installed2
        buildout.installed:
          - name: /path/to/buildout
          - parts:
            - a
            - b
          - python: /path/to/pythonpath/bin/python
          - unless: /bin/test_something_installed
          - onlyif: /bin/test_else_installed

salt.states.zcbuildout.installed(name, config='buildout.cfg', quiet=False, parts=None, user=None, env=(), buildout_ver=None, test_release=False, distribute=None, new_st=None, offline=False, newest=False, python='/usr/pkg/bin/python3.13', debug=False, verbose=False, unless=None, onlyif=None, use_vt=False, loglevel='debug', **kwargs)

  Install buildout in a specific directory

  It is a thin wrapper to modules.buildout.buildout

  name

    directory to execute in

  quiet

  > do not output console & logs

  config

    buildout config to use (default: buildout.cfg)

  parts

    specific buildout parts to run

  user

    user used to run buildout as

    Added in version 2014.1.4.

  env

    environment variables to set when running

  buildout_ver

    force a specific buildout version (1 | 2)

  test_release

    buildout accept test release

  new_st

    Forcing use of setuptools >= 0.7

  distribute

    use distribute over setuptools if possible

  offline

    does buildout run offline

  python

    python to use

  debug

    run buildout with -D debug flag

  onlyif

    Only execute cmd if statement on the host return 0

  unless

    Do not execute cmd if statement on the host return 0

  newest

    run buildout in newest mode

  verbose

    run buildout in verbose mode (-vvvvv)

  use_vt

    Use the new salt VT to stream output [experimental]

  loglevel

    loglevel for buildout commands