Metric Engine

Getting Started:

  • Quickstart Guide

User Guide:

  • Financial Value
  • Policy
  • Policy Context
  • Formatting and Internationalization
  • Null Behaviour
  • Units
  • Registry Collections
  • Calculation Engine
  • Reductions & Utilities
  • Provenance Tracking

Tutorials:

  • Metric Engine Tour
  • Money, Tax, and Percentages
  • Creating Domain Packages
  • Strict vs Safe Mode
  • Formatting Financial Values Tutorial

How-To Guides:

  • How to Create New Calculations
  • Cross-Package Dependencies
  • Custom Reducers
  • Creating New Units
  • Unit System Usage Guide
  • Conversion Registration Patterns and Best Practices
  • Custom Policies
  • How to Internationalize Your Application
  • How to Create Custom Renderers
  • Handling Zero Denominators
  • Testing Calculations
  • Configuring Provenance Tracking
  • Using Provenance Tracking
  • Provenance Best Practices

API Reference:

  • API Reference

Design Documentation:

  • Policy Resolution
  • Null Strategy Design
  • Unit Algebra Design
  • Equality and Hashing
  • Performance Design

Development:

  • Contributing
  • Testing
  • Changelog
  • Frequently Asked Questions
  • Glossary
  • License

Legacy:

  • Usage
  • Migration guidelines for converting calculation collections to the new format
  • API Reference
Metric Engine
  • Overview: module code

All modules for which code is available

  • metricengine
    • metricengine.base
    • metricengine.calculations.growth
    • metricengine.calculations.inventory
    • metricengine.calculations.pricing
    • metricengine.calculations.profitability
    • metricengine.calculations.ratios
    • metricengine.calculations.utilities
    • metricengine.calculations.variance
    • metricengine.engine
    • metricengine.equality_mode
    • metricengine.exceptions
    • metricengine.formatting
    • metricengine.null_behaviour
    • metricengine.policy
    • metricengine.policy_context
    • metricengine.provenance
    • metricengine.provenance_config
    • metricengine.reductions
    • metricengine.registry
    • metricengine.registry_collections
    • metricengine.rendering
    • metricengine.shortcuts
    • metricengine.typed_api
    • metricengine.units
    • metricengine.utils
    • metricengine.value

© Copyright 2025, Metric Engine Contributors.

Built with Sphinx using a theme provided by Read the Docs.