# qiBuild documentation

# qiBuild Python documentation

## Important

qiBuild CMake API is very stable and retro-compatible. We try very hard not to change the API.

qibuild command line API is also quite stable, but we may change the command line syntax in the future.

The configuration files syntax changed a lot in the history of qibuild, and it is possible it will change again. Most of the time, we will provide an on-the-fly conversion of previous formats.

In comparison, the internal Python API is not at all frozen yet, and big refactorings occurs all the time.

Use this documentation as a way to understand qibuild source code, or hacking it, but please do not use qibuild as a Python library for your own code, or be prepared to API changes.

## qiBuild python packages

- qiBuild Python packages documentation
  - qisys modules
    - qisys.archive – Manage .tar.gz and .zip files
    - qisys.command - Launch processes
    - qisys.envsetter – controlling environment variables
    - qisys.interact – Interacting with the user
    - qisys.parsers – Generic command line parsing tools
    - qisys.project - Base project
    - qixml module
    - qisys.remote – Network operations
    - qisys.script – Tools for qibuild scripts
    - qisys.sh – Common filesystem operations
    - qisys.ui – Tools for the command line user interface
    - qisys.version – Managing packages versions
    - qisys.worktree - Registering project paths
  - qisrc modules
    - qisrc.git – Git related tools
    - qisrc.manifest – Parsing manifest files
    - qisrc.git_config – Handling git configurations
    - qisrc.project - git projects in a GitWorkTree
    - qisrc.worktree – Managing git projects
    - qisrc.sync – Synchronize a worktree with a manifest
    - qisrc.review – Using code review (gerrit)
  - qibuild modules
    - qibuild.build - Build tools
    - qibuild.build_config
    - qibuild.cmake - CMake tools
    - qibuild.cmake_builder - Building CMake projects
    - qibuild.cmake.modules - CMake module generation
    - qibuild.config – Managing qiBuild config files
    - qibuild.deps – Resolving dependencies
    - qibuild.deploy - Deploying code to remote targets
    - qibuild.find - Finding build products
    - qibuild.gdb - Tools for gdb
    - qibuild.parsers – Parsers for qibuild actions
    - qibuild.profile – Managing build profiles
    - qibuild.project – Managing `projects`
    - qibuild.test_runner – Running tests from a C++ project
    - qibuild.wizard – Configuration wizards
    - qibuild.worktree- The BuildWorkTree
  - qitest modules
    - qitest.conf – Reading qitest config files
    - qitest.result – Storing the result of a test
    - qitest.runner – Running the tests
    - qitest.test_queue – Coordinating test launchers
  - qitoolchain modules
    - qitoolchain.database – Binary packages storage
    - qitoolchain.feeds – Parsing toolchain feeds
    - qitoolchain.binary_package – 3rd party binary packages
    - qitoolchain.qipackage - Binary package for use with `qibuild`
    - qitoolchain.svn_package - Binary packages using subversion
    - qitoolchain.toolchain – Managing toolchains
  - qidoc modules
    - qidoc.builder - Building documentation
    - qidoc.doxygen - Doxygen tools
    - qidoc.doxygen_project - Doxygen project
    - qidoc.project - Base class for doxygen and sphinx projects
    - qidoc.sphinx_project - Sphinx projects
    - qidoc.template_project - Template project
    - qidoc.worktree - qidoc Worktree
  - qilinguist modules
    - qilinguist.builder - Translating projects
    - qilinguist.project - Translation projects
    - qilinguist.qigettext – Tools for gettext
    - qilinguist.qtlinguist - Tools for Qt’s linguist
    - qilinguist.worktree - Linguist worktree
  - qipy modules
    - qipy.project - Python projects
    - qipy.python_builder - Managing Python projects
    - qipy.venv - Managing virtualenvs
    - qipy.worktree - Python worktree
  - qipkg modules
    - qipkg.builder - Building packages
    - qipkg.metabuilder - Building meta packages
    - qipkg.metapackage - Meta packages

Changelog CMake index Python index Index