Skip to main content

Classes implementing the SARIF 2.1.0 object model.

Project description

sarif-python-om

Python classes for the SARIF 2.1.0 object model

Usage

pip install sarif-python-om

import sarif_om

Description

This module contains classes for the object model defined by the Static Analysis Results Interchange Format (SARIF) Version 2.1.0 file format, an OASIS Committee Specification.

To learn more about SARIF and find resources for working with it, you can visit the SARIF Home Page.

The source code is available at https://github.com/microsoft/sarif-python-om.

Generation

The classes in this module were generated from the SARIF JSON schema by the jschema-to-python code generator, using the JSON schema file sarif-2.1.0-rtm.4.json and the code generation hints file code-gen-hints.json at the root of the GitHub repo, with the following command line:

pip install jschema-to-python

py -m jschema_to_python
    --schema-path sarif-2.1.0-rtm.4.json
    --module-name sarif_om
    --output-directory sarif_om
    --root-class-name SarifLog
    --hints-file-path code-gen-hints.json
    --force
    -vv

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sarif-om, version 1.0.4
Filename, size File type Python version Upload date Hashes
Filename, size sarif_om-1.0.4-py3-none-any.whl (30.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size sarif_om-1.0.4.tar.gz (28.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page