README.md

Tools

Scripts to generate the distributed files and import data files.

• python tools/create_matrix.py compiles the threat matrix data sources into a single standard YAML file, ATLAS.yaml. See more about generating outputs from data

• python -m tools.generate_schema outputs JSON Schema files for external validation of ATLAS.yaml and website case study files. See more on schema files.

• python -m tools.import_case_study_file <filepath> imports case study files created by the ATLAS website into ATLAS Data as newly-IDed, templated files. See more about updating case studies.

Run each script with -h to see full options.

Development Setup

1. Use Python 3.6+.

2. Set up a virtual environment. For example:

   python3 -m venv venv
   source venv/bin/activate
   pip install --upgrade pip
   

3. Install dependencies for running tools scripts and tests.

   pip install -r tools/requirements.txt
   pip install -r tests/requirements.txt