API Reference

Complete API reference for Metric Engine.

Core Components

• metricengine.value
  • EqualityMode
  • FinancialValue
  • FV
  • Core Value Types
• metricengine.units
  • Unit
  • Dimensionless
  • Ratio
  • Percent
  • Money
  • currency_unit()
  • USD
  • EUR
  • GBP
  • ZAR
  • NewUnit
  • MoneyUnit()
  • Qty()
  • Pct()
  • ConversionContext
  • Conversion
  • register_conversion()
  • get_conversion()
  • list_conversions()
  • ConversionPolicy
  • use_conversions()
  • get_current_conversion_policy()
  • convert_decimal()
  • Base Unit Class
  • Built-in Units
• metricengine.policy
  • default_quantizer_factory()
  • DisplayPolicy
  • Policy
  • Policy Classes
  • Policy Functions
• metricengine.policy_context
  • PolicyResolution
  • get_policy()
  • get_active_policy()
  • get_resolution()
  • use_policy
  • use_policy_resolution
  • Policy Context Class
  • Context Managers
  • Context Utilities
• Formatting Reference
  • Installation
  • Quick Start
  • DisplayPolicy Parameters
  • Common Locale Examples
  • Formatter Classes
  • Value Factory Functions
  • Formatting Methods
  • Accounting Style
  • Error Handling
  • Supported Currencies
  • Supported Locales
  • Performance Tips
  • Common Patterns
  • Troubleshooting
• metricengine.null_behaviour
  • NullBinaryMode
  • NullReductionMode
  • NullBehavior
  • use_nulls
  • use_reduction()
  • use_binary()
  • with_reduction()
  • with_binary()
  • get_nulls()
  • with_nulls()
  • Null Behaviour Enum
  • Null Handling Functions
• metricengine.registry
  • calc()
  • get()
  • deps()
  • list_calculations()
  • clear_registry()
  • is_registered()
  • unregister()
  • dependency_graph()
  • detect_cycles()
  • Registry Class
  • Registry Functions
  • Global Registry
• metricengine.registry_collections
  • Collection
  • Registry Collection Class
  • Collection Management
  • Built-in Collections
• metricengine.engine
  • Engine
  • Engine Class
  • Engine Functions
  • Engine Configuration
  • Global Engine
• metricengine.reductions
  • fv_sum()
  • fv_mean()
  • fv_weighted_mean()
  • Built-in Reducers
  • Statistical Reducers
  • Custom Reducer Registration
• metricengine.utils
  • to_decimal()
  • Validation Utilities
  • Conversion Utilities
  • Formatting Utilities
• metricengine.exceptions
  • MetricEngineError
  • MissingInputError
  • CircularDependencyError
  • CalculationError
  • Base Exceptions
  • Value Exceptions
  • Policy Exceptions
• Provenance API Reference
  • Core Classes
  • Configuration
  • Configuration Functions
  • Context Manager
  • Utility Functions
  • Hashing Functions
  • Export Functions
  • Span Management
  • FinancialValue Provenance Methods
  • Examples

Calculations

• metricengine.calculations.growth
  • simple_growth_rate()
  • compound_growth_rate()
  • compound_growth_rate_percent()
  • Growth Rate Calculations
  • Revenue Growth
• metricengine.calculations.inventory
  • cogs()
  • cogs_ratio()
  • cogs_percentage()
  • inventory_turnover()
  • average_inventory()
  • fnb_sales()
  • fnb_cost()
  • food_cost_ratio()
  • food_cost_percentage()
  • beverage_cost_ratio()
  • beverage_cost_percentage()
  • delivery_fee_amount()
  • delivery_sales_net()
  • original_delivery_sales()
  • Inventory Metrics
  • Cost Calculations
• metricengine.calculations.pricing
  • total_cost()
  • sales_ex_tax()
  • sales_with_tax()
  • tax_amount()
  • price_ex_tax()
  • markup_ratio()
  • markup_percentage()
  • discount_ratio()
  • discount_percentage()
  • Price Calculations
  • Margin Calculations
• metricengine.calculations.profitability
  • gross_profit()
  • gross_profit_ex_tax()
  • gross_margin_ratio()
  • gross_margin_percentage()
  • gross_margin_ratio_ex_tax()
  • gross_margin_percentage_ex_tax()
  • cost_ratio()
  • cost_percent()
  • cost_ratio_ex_tax()
  • cost_percent_ex_tax()
  • net_profit()
  • net_margin_ratio()
  • net_margin_percentage()
  • net_profit_with_tax()
  • net_margin_with_tax_ratio()
  • net_margin_with_tax()
  • cost_ratio_with_tax()
  • cost_percentage_with_tax()
  • contribution_margin()
  • contribution_margin_ratio_raw()
  • contribution_margin_ratio()
  • operating_margin_ratio()
  • operating_margin()
  • ebitda_margin_ratio()
  • ebitda_margin()
  • roi_ratio()
  • roi()
  • Margin Calculations
  • Profitability Ratios
• metricengine.calculations.ratios
  • ratio()
  • percentage_of_total()
  • ratio_to_percentage()
  • percentage_to_ratio()
  • cap_percentage()
  • Liquidity Ratios
  • Leverage Ratios
  • Activity Ratios
• metricengine.calculations.utilities
  • average_value()
  • weighted_average()
  • Present Value Calculations
  • Interest Calculations
  • Time Value of Money
• metricengine.calculations.variance
  • variance_amount()
  • variance_ratio()
  • variance_percentage()
  • percentage_change_ratio()
  • percentage_change()
  • variance_ratio_from_components()
  • variance_percentage_from_components()
  • Budget Variance
  • Cost Variance
  • Performance Variance