focus-data-toolkit 0.11.0__py3-none-any.whl

focus_data_toolkit/model/json_schemas/contractcommitmentapplicabilityobjectschema.json

@@ -0,0 +1,290 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://focus.finops.org/schemas/contractcommitmentapplicabilityobject.json",
+  "title": "Contract Commitment Applicability Object",
+  "description": "Schema for validating the Contract Commitment Applicability column JSON object structure in FOCUS datasets",
+  "type": "object",
+  "$defs": {
+    "ApplicabilityObject": {
+      "type": "object",
+      "properties": {
+        "Cost": {
+          "type": "number",
+          "description": "Percentage applicable to ContractCommitmentCost",
+          "minimum": 0.0,
+          "maximum": 1.0,
+          "default": 1.0
+        },
+        "Usage": {
+          "type": "number",
+          "description": "Percentage applicable to ContractCommitmentQuantity",
+          "minimum": 0.0,
+          "maximum": 1.0,
+          "default": 1.0
+        }
+      },
+      "additionalProperties": false
+    },
+    "ApplicabilityRule": {
+      "type": "object",
+      "required": [
+        "Dimension",
+        "Operator",
+        "Values"
+      ],
+      "properties": {
+        "Dimension": {
+          "type": "string",
+          "description": "A valid FOCUS Column Name"
+        },
+        "Operator": {
+          "type": "string",
+          "description": "The comparison logic to apply",
+          "enum": [
+            "In",
+            "NotIn",
+            "StartsWith",
+            "NotStartsWith",
+            "Contains",
+            "NotContains",
+            "EndsWith",
+            "Exists",
+            "DoesNotExist"
+          ]
+        },
+        "Values": {
+          "type": "array",
+          "description": "List of strings to compare",
+          "items": {
+            "type": "string"
+          },
+          "minItems": 1
+        },
+        "Applicability": {
+          "$ref": "#/$defs/ApplicabilityObject",
+          "description": "Optional rule-level applicability that overrides top-level"
+        }
+      },
+      "allOf": [
+        {
+          "description": "Wildcard constraint: If '*' is used, it must be the only value and Operator must be compatible.",
+          "if": {
+            "properties": {
+              "Values": {
+                "contains": {
+                  "const": "*"
+                }
+              }
+            }
+          },
+          "then": {
+            "properties": {
+              "Values": {
+                "maxItems": 1
+              },
+              "Operator": {
+                "enum": [
+                  "In",
+                  "Contains",
+                  "Exists",
+                  "DoesNotExist"
+                ]
+              }
+            }
+          }
+        },
+        {
+          "description": "Existence Logic: Exists/DoesNotExist operators require the specific wildcard value.",
+          "if": {
+            "properties": {
+              "Operator": {
+                "enum": [
+                  "Exists",
+                  "DoesNotExist"
+                ]
+              }
+            }
+          },
+          "then": {
+            "properties": {
+              "Values": {
+                "items": {
+                  "const": "*"
+                },
+                "maxItems": 1
+              }
+            }
+          }
+        }
+      ],
+      "additionalProperties": false
+    }
+  },
+  "properties": {
+    "IsGlobalScope": {
+      "type": "boolean",
+      "description": "If true, commitment applies to all entities",
+      "default": false
+    },
+    "IsComplexScope": {
+      "type": "boolean",
+      "description": "If true, applicability logic exceeds schema capabilities",
+      "default": false
+    },
+    "Applicability": {
+      "$ref": "#/$defs/ApplicabilityObject",
+      "description": "Top-level fractional mapping for metrics"
+    },
+    "InclusionOperator": {
+      "type": "string",
+      "description": "Logical operator for Inclusions array",
+      "enum": [
+        "And",
+        "Or"
+      ]
+    },
+    "Inclusions": {
+      "type": "array",
+      "description": "List of rules defining the applicability boundary",
+      "items": {
+        "$ref": "#/$defs/ApplicabilityRule"
+      }
+    },
+    "ExclusionOperator": {
+      "type": "string",
+      "description": "Logical operator for Exclusions array",
+      "enum": [
+        "And",
+        "Or"
+      ]
+    },
+    "Exclusions": {
+      "type": "array",
+      "description": "List of rules defining entities to exclude",
+      "items": {
+        "$ref": "#/$defs/ApplicabilityRule"
+      },
+      "minItems": 1
+    }
+  },
+  "allOf": [
+    {
+      "description": "IsGlobalScope and IsComplexScope cannot both be true simultaneously.",
+      "not": {
+        "required": [
+          "IsGlobalScope",
+          "IsComplexScope"
+        ],
+        "properties": {
+          "IsGlobalScope": {
+            "const": true
+          },
+          "IsComplexScope": {
+            "const": true
+          }
+        }
+      }
+    },
+    {
+      "description": "If IsGlobalScope is true, Inclusions must be empty or omitted.",
+      "if": {
+        "properties": {
+          "IsGlobalScope": {
+            "const": true
+          }
+        },
+        "required": [
+          "IsGlobalScope"
+        ]
+      },
+      "then": {
+        "properties": {
+          "Inclusions": {
+            "maxItems": 0
+          },
+          "InclusionOperator": false
+        }
+      }
+    },
+    {
+      "description": "If IsComplexScope is true, Inclusions must be empty or omitted.",
+      "if": {
+        "properties": {
+          "IsComplexScope": {
+            "const": true
+          }
+        },
+        "required": [
+          "IsComplexScope"
+        ]
+      },
+      "then": {
+        "properties": {
+          "Inclusions": {
+            "maxItems": 0
+          },
+          "InclusionOperator": false
+        }
+      }
+    },
+    {
+      "description": "If neither Global nor Complex scope is active, Inclusions and InclusionOperator are required.",
+      "if": {
+        "not": {
+          "anyOf": [
+            {
+              "properties": {
+                "IsGlobalScope": {
+                  "const": true
+                }
+              },
+              "required": [
+                "IsGlobalScope"
+              ]
+            },
+            {
+              "properties": {
+                "IsComplexScope": {
+                  "const": true
+                }
+              },
+              "required": [
+                "IsComplexScope"
+              ]
+            }
+          ]
+        }
+      },
+      "then": {
+        "required": [
+          "InclusionOperator",
+          "Inclusions"
+        ],
+        "properties": {
+          "Inclusions": {
+            "minItems": 1
+          }
+        }
+      }
+    },
+    {
+      "description": "If Exclusions are present, ExclusionOperator is required.",
+      "if": {
+        "required": [
+          "Exclusions"
+        ]
+      },
+      "then": {
+        "required": [
+          "ExclusionOperator"
+        ]
+      }
+    }
+  ],
+  "patternProperties": {
+    "^x_[A-Z][a-zA-Z0-9]*$": {
+      "description": "Custom data generator-defined properties prefixed with x_ in PascalCase format"
+    }
+  },
+  "additionalProperties": false
+}

focus_data_toolkit/model/json_schemas/json_schemas_provenance.json

@@ -0,0 +1,38 @@
+{
+  "description": "Provenance of the vendored official FOCUS JSON object schemas.",
+  "source_repository": "https://github.com/FinOps-Open-Cost-and-Usage-Spec/FOCUS_Spec",
+  "source_ref": "v1.4",
+  "license": "CC-BY-4.0",
+  "attribution": "FinOps Open Cost and Usage Specification (FOCUS), (c) FinOps Foundation. Schemas vendored verbatim from the specification repository.",
+  "retrieved": "2026-07-17",
+  "files": [
+    {
+      "file": "contractappliedobjectschema.json",
+      "source_path": "specification/schemas/datasets/cost_and_usage/contractappliedobjectschema.json",
+      "column": "ContractApplied",
+      "sha256": "26ad380f89c12b414f36822fb4f12786e4eacfb0d00ac4781a84752483a5d73e",
+      "bytes": 4352
+    },
+    {
+      "file": "allocatedmethoddetailsobjectschema.json",
+      "source_path": "specification/schemas/datasets/cost_and_usage/allocatedmethoddetailsobjectschema.json",
+      "column": "AllocatedMethodDetails",
+      "sha256": "0f552469954433c04a51ad18561e4b85e13787570cda4a4cc5a733a39214d8fd",
+      "bytes": 3250
+    },
+    {
+      "file": "commitmentprogrameligibilitydetailsobjectschema.json",
+      "source_path": "specification/schemas/datasets/cost_and_usage/commitmentprogrameligibilitydetailsobjectschema.json",
+      "column": "CommitmentProgramEligibilityDetails",
+      "sha256": "0cc2fc4bfc3a720754591c017a5899d214f78d630167a16e99c2875cb91de576",
+      "bytes": 1647
+    },
+    {
+      "file": "contractcommitmentapplicabilityobjectschema.json",
+      "source_path": "specification/schemas/datasets/contract_commitment/contractcommitmentapplicabilityobjectschema.json",
+      "column": "ContractCommitmentApplicability",
+      "sha256": "6c396aa5ac0ccfed1bfb1c464d6698684520554aca50dca3258307ff779a565b",
+      "bytes": 7143
+    }
+  ]
+}

focus_data_toolkit/model/model_provenance.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "https://raw.githubusercontent.com/guymano/focus-data-toolkit/main/schema/model_provenance.schema.json",
+  "schema_version": "1.0",
+  "focus_version": "1.4",
+  "provenance_status": "complete",
+  "description": "Provenance for the committed FOCUS 1.4 machine-readable model (focus_1_4_model.json). The JSON is a deterministic extraction of the FinOps Foundation FOCUS 1.4 Data Model and is the artifact of record for this package.",
+  "source": {
+    "name": "FinOps FOCUS 1.4 Data Model workbook",
+    "publisher": "FinOps Foundation",
+    "homepage": "https://focus.finops.org",
+    "repository": "https://github.com/FinOps-Open-Cost-and-Usage-Spec/FOCUS_Spec",
+    "license": "CC-BY-4.0",
+    "license_verified": true,
+    "license_reference": "https://github.com/FinOps-Open-Cost-and-Usage-Spec/FOCUS_Spec/blob/main/license.md",
+    "artifact": "FOCUS 1.4 Data Model workbook (spreadsheet), downloaded from https://focus.finops.org; not redistributed in this repository",
+    "artifact_sha256": "39b3e3347e902a484cad180ead6fcb5a96b70cc76391c9af1916911a25a68005",
+    "artifact_retrieved": "2026-07-18"
+  },
+  "supplements": [
+    {
+      "path": "src/focus_data_toolkit/model/focus_1_4_servicesubcategory.json",
+      "sha256": "8532467093bedd1e228a82f07c782d8b29286de75d0a79bccbf896debd867f64",
+      "description": "ServiceSubcategory -> parent Category map, transcribed from the FOCUS v1.4 specification; an input to the extractor."
+    }
+  ],
+  "generator": {
+    "script": "tools/extract_focus_1_4_model.py",
+    "script_sha256": "4fc4c8d6f30f3b3045c7f6afcc46b81ebbb44d800e63993246878374d4ee9403",
+    "command": "python tools/extract_focus_1_4_model.py <focus_1_4_data_model.xlsx>",
+    "runtime": "Dev-time only; requires openpyxl. Neither the runtime package nor the test suite imports openpyxl — the committed JSON is the artifact of record.",
+    "serialization": "json.dumps(model, indent=2, sort_keys=True) + trailing newline; UTF-8. Deterministic: identical (workbook, supplement, generator) reproduce identical output bytes."
+  },
+  "output": {
+    "path": "src/focus_data_toolkit/model/focus_1_4_model.json",
+    "sha256": "8b006e1a36bc9678fef6b79c847654f914ea7abe25c827478aa44ee1d15b214b",
+    "bytes": 64971,
+    "focus_version": "1.4",
+    "datasets": {
+      "Cost and Usage": 65,
+      "Billing Period": 6,
+      "Contract Commitment": 30,
+      "Invoice Detail": 22
+    }
+  },
+  "reproducibility": {
+    "byte_for_byte": "The committed output is byte-reproducible by re-running the pinned generator on the same source workbook: the serialization is deterministic (sorted keys, fixed indent, UTF-8, trailing newline).",
+    "verifiable_in_ci": [
+      "output.sha256 matches the committed focus_1_4_model.json",
+      "generator.script_sha256 matches the committed extractor",
+      "supplements[].sha256 match the committed supplement files"
+    ],
+    "limitation": "None for the model chain: the source workbook is hashed (source.artifact_sha256) and the committed output was reproduced byte-for-byte from it by the pinned extractor at completion time. The workbook itself is still not redistributed; obtain it from the FinOps Foundation and verify it against source.artifact_sha256."
+  },
+  "attribution": "FOCUS(TM) is a trademark of the FinOps Foundation. The FOCUS specification and data model are (c) the FinOps Foundation and are licensed CC-BY-4.0. The committed model JSON and this provenance file are a derivative work distributed under CC-BY-4.0 with attribution. This project is an independent community toolkit and is not endorsed by the FinOps Foundation.",
+  "notes": [
+    "provenance_status was set to 'complete' by scripts/verify_model_provenance.py --complete: the source workbook was hashed and the committed model was reproduced byte-for-byte from it with the pinned extractor."
+  ]
+}