Reference

This section details the core API reference along with other more elaborate details about BuildStream internals.

• Project format
  • Introduction
  • Project configuration
  • Declaring elements
  • Builtin public data
  • The project.refs file
• Plugin specific documentation
  • Elements
  • Sources
  • External plugins
• Plugin API reference
  • Foundation types
  • Node - Parsed YAML configuration
  • Plugin - Base plugin class
  • Source - Base source class
  • SourceFetcher - Object for fetching individual URLs
  • DownloadableFileSource - Abstract class for sources downloaded from a URI
  • Element - Base element class
  • BuildElement - Abstract class for build elements
  • ScriptElement - Abstract class for scripting elements
  • Sandbox - The build sandbox
  • Directory - Interfacing with files
  • Exceptions - API for Error Handling
  • Utilities
• Additional writings
  • BuildStream and Docker