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

PyOxidizer

Navigation

  • oxidized_importer Python Extension
  • The pyembed Rust Crate
  • PyOxidizer
    • Overview
    • Getting Started
    • The pyoxidizer Command Line Tool
    • Configuration Files
    • Packaging User Guide
    • Distributing User Guide
    • PyOxidizer for Rust Developers
    • Frequently Asked Questions
    • Project Status
    • Comparisons to Other Tools
    • Contributing to PyOxidizer
    • Project History
    • Technical Notes
  • The PyOxy Python Runner
  • Shipping Applications with tugger

Related Topics

  • Documentation overview
    • PyOxidizer
      • Previous: The pyoxidizer Command Line Tool
      • Next: Automatic File Location Strategy

Quick search

©2019-present, Gregory Szorc. | Powered by Sphinx 5.0.2 & Alabaster 0.7.12 | Page source