Skip to content

Reference#

Here's the reference documentation for the rattler_build Python bindings API.

If you want to learn how to use Rattler-Build's Python API, check out the Tutorials.

Version#

Get the version of Rattler-Build:

from rattler_build import rattler_build_version

print(rattler_build_version())

Get the version of the Rattler-Build package

Core API#

  • Recipe - Parse and work with conda recipes (Stage0Recipe, Stage1Recipe)
  • Rendering - Render recipes with variants (RenderedVariant, VariantConfig)
  • Package - Inspect packages and run tests (Package, PackageTest)
  • Build Result - Build output information (BuildResult)

Configuration#

  • Configuration - Build and platform settings (ToolConfiguration, PlatformConfig, JinjaConfig, RenderConfig)

Debug#

  • Debug Session - Interactive build debugging (DebugSession, DebugPaths, ScriptResult)

Utilities#

  • Upload - Upload packages to various servers
  • Recipe Generation - Generate recipes from PyPI, CRAN, CPAN, LuaRocks
  • Progress - Progress callbacks for monitoring builds

Exceptions#

  • Exceptions - Error types raised by Rattler-Build