Skip to main content

JADN schema tools

Project description

This Python package contains software for processing and using JADN Information Models to serialize and validate application data. The software is organized by function:

  • core: Load, validate, and save a JADN schema. Defined constants for the JADN data format.

  • codec: Validate, encode, and decode application data using a JADN schema

  • convert: Convert a JADN schema to a documentation format

    • text-based Interface Definition Language (IDL)

    • html tables

    • markdown tables

    • JSON with JADN whitespacing

  • transform: Process a JADN schema to produce another JADN schema

    • resolve definitions from separate schemas into a single schema (include/import)

    • split a schema that defines multiple objects into separate schemas for each object

    • remove unreferenced definitions

    • remove or truncate comments to a fixed width

  • translate: Convert a JADN schema into a concrete schema language

    • JSON Schema

    • XSD

    • CDDL

    • Protobuf

The JADN schema language is defined in https://github.com/oasis-tcs/openc2-jadn/blob/working/jadn-v1.0-wd01.md.

Quickstart

The quickstart.py script demonstrates some of the above functions.

Project details


Download files

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

Source Distribution

jadn-0.5.0b5.tar.gz (32.2 kB view hashes)

Uploaded Source

Built Distribution

jadn-0.5.0b5-py3-none-any.whl (36.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page