Skip to main content

Buildout recipe for Qooxdoo projects.

Project description

Buildout recipe, that runs Qooxdoo generator script. It requires Qooxdoo SDK to run.

It supports two recipes, default (script) and run. Default generates script in your bin directory, so you can run the generator manually. Run runs the commands at the time of buildout processing, automating the process completely.


  • script - Name of the written script. Defaults to part name. Available only for default (script) recipe. Ignored by run recipe.
  • commands - Command executed by the generator. It must be exported by project config. If empty, either command-line arguments or default command from config.json will be used.
  • config - Path to the project configuration file, or directory containing config.json file.
  • qooxdoo-sdk - Path to the qooxdoo sdk. Fallbacks to ${buildout:qooxdoo-sdk} variable. SDK must exist. Corresponds to QOOXDOO_PATH macro.
  • cache - Qooxdoo cache path. If empty, ${buildout:cache-directory} will be used. If neither is specified, Qooxdoo default will be used. It corresponds to CACHE macro.
  • let - Qooxdoo environmental variables, as are under "let" keyword in config.json. It should be in key:value format since Qooxdoo generator expects it. It may contain multiple pairs. Optional.
  • remove-dirs - Directories that should be removed on script execution. Path is relative to buildout root. This can also remove files. Optional.
  • create-dirs - Directories that should be created on script execution. Path is relative to buildout root. Useful for jobs that require some path to exist. Optional.
  • clean-dirs - Directories which contents should be removed on script execution. Path is relative to buildout root. Useful for jobs that require some path to exist and yet you want their content to be recreated every time (like images creation). Optional.

Options commands and config can contain multiple entries. Projects are then built sequentially for each project, with each command executed as standalone process.

When commnads is omitted and command-line arguments are used as commands, they are split and executed sequentially as well. Therefore you can run e.g. translate lint build in one go, which generator itself does not support.


Example buildout.cfg:

parts =

qooxdoo-sdk = ${qooxdoo-sdk:destination}
cache-directory = cache

recipe =
url =
destination = qooxdoo-sdk
strip-top-level-dir = true

recipe = mdvorak.recipe.qooxdoo
commands = translation
config = src/config.json

recipe = mdvorak.recipe.qooxdoo
config = src/config.json

recipe = mdvorak.recipe.qooxdoo:run
commands = info
config = src/config.json

You can then execute translation job with ./bin/translate, or any command using ./bin/qx. Try ./bin/qx info to see how is Qooxdoo configured. In addition to that, info section is run during buildout execution, displaying Qooxdoo configuration immediately. This is not very useful, it’s just an example.

Create scripts for any jobs (and job sequences) you want.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date (12.4 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page