sarif-om

What it is and what it does

This package is a collection of Python classes auto-generated from the SARIF 2.1.0 JSON schema. SARIF is an OASIS standard for representing static analysis tool results in a machine-readable, vendor-neutral format. The package lets you construct, read, and manipulate SARIF objects programmatically in Python using attrs-based classes that mirror the official schema structure.

The classes were generated from the official SARIF schema, so they track the specification closely. You import the package and work with classes like SarifLog to build or parse SARIF documents. It's a thin, schema-faithful wrapper with minimal dependencies (attrs and pbr), suitable for tools that need to emit or consume SARIF reports.

Use it for:

• Build a static analysis tool that outputs results in SARIF format for integration with other security or code-quality platforms.
• Parse SARIF reports from third-party analysis tools to aggregate or transform results programmatically.
• Validate or transform SARIF documents within a larger CI/CD pipeline.
• Generate standardized security or code-quality reports that other tools can consume via SARIF.
• Create a SARIF viewer or dashboard that reads and displays analysis results from multiple tools.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides Python classes implementing the SARIF 2.1.0 object model for representing static analysis results in a standardized interchange format.

Yes, if you need to work with SARIF 2.1.0 in Python. The package is stable, permissively licensed, and has no known vulnerabilities. Its dormancy is not a risk—SARIF is a fixed standard and the generated classes are unlikely to need updates. Install it for any tool that must emit or consume SARIF reports.

Install

sarif-om on PyPI

pip install sarif-om

uv add sarif-om

poetry add sarif-om

Installing sarif-om

Before you install

Low install friction with only two lightweight runtime dependencies (attrs and pbr). The package is dormant—last release was 2019-10-05 and last commit 2024-04-03—so expect no active maintenance, though the underlying SARIF specification it implements is stable.

License in practice

MIT license is permissive, allowing free use, modification, and distribution with minimal restrictions.

Quickstart

pip install sarif-om

import sarif_om

log = sarif_om.SarifLog()

Verify before relying

• Whether the generated classes fully cover all SARIF 2.1.0 schema features and edge cases in practice.
• Current compatibility with modern Python versions beyond what 'supports_current' indicates.
• Whether the 2024-04-03 commit represents active maintenance or a minor fix.

Package facts

Evidence: sarif_om-1.0.4-py3-none-any.whl

Tags

More Python Modules packages