https://github.com/RS-Credentive/oscal-pydantic
https://github.com/RS-Credentive/oscal-pydantic
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/RS-Credentive/oscal-pydantic
- Owner: RS-Credentive
- License: other
- Created: 2023-03-16T10:05:34.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-06T09:09:52.000Z (about 1 year ago)
- Last Synced: 2025-04-03T09:10:01.433Z (26 days ago)
- Language: Python
- Size: 1010 KB
- Stars: 16
- Watchers: 5
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-oscal - Credentive Security's oscal-pydantic - pydantic/). Just "pip install oscal-pydantic". (Tools)
README
# OSCAL Pydantic
## CHECK OUT OSCAL-PYDANTIC V2, UNDER DEVELOPMENT [IN THIS BRANCH](https://github.com/RS-Credentive/oscal-pydantic/tree/oscal-pydantic-v2)
## Description
A simple module that contains pydantic datamodels representing the OSCAL standard. They are built from the OSCAL models published by NIST at https://github.com/usnistgov/OSCAL
Several Python projects include data models, but importing a large project just to get access to the datamodel represents a significant overhead. This module simply provides the models.
## Installation
pip install oscal-pydantic
## Usage
To import a specific model, include it in your python file:
e.g.: from oscal_pydantic import catalog
Alternatively, you can import the complete OSCAL schema:
from oscal_pydantic import complete
After importing, you should be able to define OSCAL objects that support pydantic's rich validation rules.
## License
This code is released under the [CC0 1.0 Universal Public Domain Dedication] (https://creativecommons.org/publicdomain/zero/1.0/).