Overview

The stix-ramrod package provides APIs and scripts for upgrading STIX and CybOX content. STIX content can be upgraded from 1.0 to 1.2 (the current release) and anywhere in between. CybOX content can be upgraded from 2.0 to 2.1 (the current release) and anywhere in between.

Our goal is to make it easy for developers, content authors, and content consumers to upgrade content from within code or the command line.

Installation

Use pip to install or upgrade stix-ramrod:

$ pip install stix-ramrod

For more information, see the Installation instructions.

Dependencies

The stix-ramrod library depends on the presence of certain packages/libraries to function. Please refer to their installation documentation for installation instructions.

• lxml

Getting Started

Read the Getting Started guide.

Layout

The stix-ramrod repository has the following layout:

• docs/ - Used to build the documentation.

• ramrod/ - The main stix-ramrod source.

• samples/ - Sample STIX/CybOX XML documents

Versioning

Releases of stix-ramrod are given major.minor.patch version numbers and follow semantic versioning guidelines.

Feedback

Please provide feedback to stix@mitre.org.

Terms

BY USING STIX-RAMROD YOU SIGNIFY YOUR ACCEPTANCE OF THE TERMS AND CONDITIONS OF USE. IF YOU DO NOT AGREE TO THESE TERMS, DO NOT USE STIX-RAMROD.

For more information, please refer to the LICENSE.txt file