1. Boris Baldassari
  2. Alambic

Wiki

Clone wiki

Alambic / Home

Welcome to the Alambic project

Alambic is an open-source platform and service for the management and visualisation of software engineering data. This wiki specifically targets version 3.x of Alambic.

Codeship Status for BorisBaldassari/alambic

Alambic main features

  • Retrieves data from any source, aggregates and displays them in a custom dashboard.
  • Alambic is entirely Web-based, althought it is very easy to understand how files are organised.
  • Plugins can be used to add new automatic data sources, custom data sources and visualisation units.
  • Custom Data plugins allow to enter manual data (e.g. surveys) and compute custom metrics from them.

It basically retrieves data from many various repositories (code metrics, scm, its, mailing lists, stack overflow questions, etc.) and makes them available for custom plugins to produce analysis, numbers, graphics, and data sets.

A flexible plugin system allows to easily add new data sources (e.g. git or svn logs, bugzilla queries), analysis tools (including R scripts), visualisation and reporting (e.g. knitr or plotly graphs). Examples of plugins ready to use include PMD Results Analysis, StackOverflow questions and PMI Checks for Eclipse projects.

Measures are aggregated in a tree-like quality model structure to better organise and understand the information. The Quality Model can be entirely customised, and almost any type of data source can be added through plugins. Check this image for a visual example of the result.

Alambic notably runs the following web sites:

Where to go from here?

User documentation

Administrators documentation

Developer documentation

Also do not hesitate to read the code; a good part of the documentation is actually written in there.

Updated