The Project object holds all of the project settings from the project configuration file including the project directory it was loaded from.


The base BuildStream format version

This version is bumped whenever enhancements are made to the project.conf format or the format in general.


The base BuildStream artifact version

The artifact version changes whenever the cache key calculation algorithm changes in an incompatible way or if buildstream was changed in a way which can cause the same cache key to produce something that is no longer the same.

class Project

Bases: object

The Project Configuration

name = None

str – The project name

directory = None

str – The project directory

element_path = None

str – Absolute path to where elements are loaded from within the project


Translates the given url which may be specified with an alias into a fully qualified url.

Parameters:url (str) – A url, which may be using an alias
Returns:The fully qualified url, with aliases resolved
Return type:str

This method is provided for Source objects to resolve fully qualified urls based on the shorthand which is allowed to be specified in the YAML