py-ocsf-models

The py-ocsf-models package offers a Python implementation of the Open Cybersecurity Schema Framework (OCSF) models, facilitating the manipulation and understanding of cybersecurity data within Python applications. This package provides a rich set of models covering various aspects of cybersecurity events, findings, objects, and profiles as defined by the OCSF Schema, enabling developers to work with structured cybersecurity data efficiently.

In Prowler, we leverage the py-ocsf-models package to generate JSON formatted OCSF outputs, specifically focusing on Detection Findings. This integration facilitates the standardization and sharing of cybersecurity findings in a structured and widely-accepted format, enhancing the interoperability between different security tools and platforms.

Features

Comprehensive OCSF Schema Implementation: Includes models for events, findings, objects, and profiles, covering the entire OCSF Schema.
Easy Data Manipulation: Easily create, modify, and interact with cybersecurity data structures.
Serialization and Deserialization Support: Convert OCSF model instances to and from JSON for easy storage and transmission.
Extensible Design: Extend and customize models to fit specific requirements while staying compliant with the OCSF schema.

OCSF Coverage

Detection Finding
Compliance Finding
Application Security Posture Finding

Installation

Install py-ocsf-models using pip:

pip install py-ocsf-models

Import the package in your Python application:

import py_ocsf_models

Usage Examples

You can find ready-to-run examples demonstrating how to generate events using the OCSF schema in the examples folder.

How to Release

To release a new version of py-ocsf-models:

Create a PR with version update: Update the version number in pyproject.toml and create a pull request with the changes.
Create a GitHub release: Once the PR is merged into the master branch, create a new release in GitHub from the master branch. This will automatically trigger the pypi-release.yml workflow to publish the package to PyPI.

Contributing

Contributions are welcome! Whether you're fixing a bug, adding new features, or improving the documentation, please feel free to make a pull request or open an issue.

License

This project is licensed under the Apache-2.0 License - see the LICENSE file for details.

Acknowledgments

This package is built to support and encourage the adoption of the Open Cybersecurity Schema Framework (OCSF) and facilitate the handling of cybersecurity data in Python applications.

Support

For support, questions, or feedback, please open an issue on the GitHub repository.

Download files

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

Source Distribution

py_ocsf_models-0.10.0.tar.gz (36.5 kB view details)

Uploaded Jul 13, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

py_ocsf_models-0.10.0-py3-none-any.whl (64.3 kB view details)

Uploaded Jul 13, 2026 Python 3

File details

Details for the file py_ocsf_models-0.10.0.tar.gz.

File metadata

Download URL: py_ocsf_models-0.10.0.tar.gz
Upload date: Jul 13, 2026
Size: 36.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for py_ocsf_models-0.10.0.tar.gz
Algorithm	Hash digest
SHA256	`29abaa5a3d4ebba0e2a21757508a4848fa5e1d57da233af57e580f97f0223c59`
MD5	`b547e35fb5ea68268f967806ed53f920`
BLAKE2b-256	`70d6f0787cbe953e3cf6ef4430f3cc7d66cbbaabe4b20cb82cc27cc2d21e622a`

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_ocsf_models-0.10.0.tar.gz:

Publisher: pypi-release.yml on prowler-cloud/py-ocsf-models

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: py_ocsf_models-0.10.0.tar.gz
- Subject digest: 29abaa5a3d4ebba0e2a21757508a4848fa5e1d57da233af57e580f97f0223c59
- Sigstore transparency entry: 2160456688
- Sigstore integration time: Jul 13, 2026
Source repository:
- Permalink: prowler-cloud/py-ocsf-models@8c12c2fc73e09c9fc103f5dec2e0d2762aa1a78b
- Branch / Tag: refs/tags/0.10.0
- Owner: https://github.com/prowler-cloud
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: pypi-release.yml@8c12c2fc73e09c9fc103f5dec2e0d2762aa1a78b
- Trigger Event: release