Configuration Files

PyOxidizer uses Starlark files to configure run-time behavior.

Starlark is a dialect of Python intended to be used as a configuration language and the syntax should be familiar to any Python programmer.

This documentation section contains both a high-level overview of the configuration files and their semantics as well as low-level documentation for every type and function in the Starlark dialect.

• Automatic File Location Strategy
• Concepts
  • Processing
  • Targets
  • Python Distributions Provide Python
  • Python Executables Run Python
  • Python Resources
  • Specifying Resource Locations
• Resource Attributes Influencing Adding
  • add_include
  • add_location
  • add_location_fallback
  • add_source
  • add_bytecode_optimization_level_zero
  • add_bytecode_optimization_level_one
  • add_bytecode_optimization_level_two
• Global Symbols
  • Global Types
  • Global Constants
    • BUILD_TARGET_TRIPLE
    • CONFIG_PATH
    • CONTEXT
    • CWD
  • Global Functions
  • Types with Target Behavior
• Functions for Manipulating Global State
• Functions for Managing Targets
  • register_target()
  • resolve_target()
  • resolve_targets()
• Extensions to Tugger’s Starlark Dialect
  • FileManifest.add_python_resource()
  • FileManifest.add_python_resources()
• File
• PythonDistribution
  • default_python_distribution()
• PythonEmbeddedResources
• PythonExecutable
• PythonExtensionModule
• PythonInterpreterConfig
  • Starlark Caveats
• PythonModuleSource
• PythonPackageResource
• PythonPackageDistributionResource
• PythonPackagingPolicy