Methods

What follows is a list of methods that you can define in your recipes to customize the package creation & consumption processes:

  • build(): Contains the build instructions to build a package from source

  • build_id(): Allows reusing the same build to create different package binaries

  • build_requirements(): Defines tool_requires and test_requires

  • compatibility(): Defines binary compatibility at the recipe level

  • configure(): Allows configuring settings and options while computing dependencies

  • config_options(): Configure options while computing dependency graph

  • deploy(): Deploys (copy from package to user folder) the desired artifacts

  • export(): Copies files that are part of the recipe

  • export_sources(): Copies files that are part of the recipe sources

  • finalize(): Customizes the package for using it in the running machine without affecting the original package

  • generate(): Generates the files that are necessary for building the package

  • init(): Special initialization of recipe when extending from python_requires

  • layout(): Defines the relative project layout, source folders, build folders, etc.

  • package(): Copies files from build folder to the package folder.

  • package_id(): Defines special logic for computing the binary package_id identifier

  • package_info(): Provide information for consumers of this package about libraries, folders, etc.

  • requirements(): Define the dependencies of the package

  • set_name(): Dynamically define the name of a package

  • set_version(): Dynamically define the version of a package.

  • source(): Contains the commands to obtain the source code used to build

  • system_requirements(): Call system package managers like Apt to install system packages

  • test(): Run some simple package test (exclusive of test_package)

  • validate(): Define if the current package is invalid (cannot work) with the current configuration.

  • validate_build(): Define if the current package cannot be created with the current configuration.