Version: 4.1.0.13

Getting Started with python-maec

Note

The python-maec library is intended for developers who want to add MAEC support to existing programs or create new programs that handle MAEC content. Experience with Python development is assumed.

Other users should look at existing tools that support MAEC.

Understanding XML, XML Schema, and the MAEC language is also incredibly helpful when using python-maec in an application.

First, you should follow the Installation procedures.

Your First MAEC Application

Once you have installed python-maec, you can begin writing Python applications that consume or create STIX content!

Note

The python-maec library provides bindings and APIs, both of which can be used to parse and write MAEC XML files. For in-depth description of the APIs, bindings, and the differences between the two, please refer to APIs or bindings?

Creating a MAEC Package

from maec.package import Package              # Import the MAEC Package API
from maec.package import MalwareSubject       # Import the MAEC Malware Subject API

package = Package()                           # Create an instance of Package
malware_subject = MalwareSubject()            # Create an instance of MalwareSubject
package.add_malware_subject(malware_subject)  # Add the Malware Subject to the Package

print(package.to_xml())                       # Print the XML for this MAEC Package

Parsing MAEC XML

import maec                                # Import the python-maec API

fn = 'sample_maec_package.xml'             # generate by running examples\package_generation_example.py
maec_objects = maec.parse_xml_instance(fn) # Parse using the from_xml() method
api_object = maec_objects['api']           # Get the API object from the parsed objects

Example Scripts

The python-maec repository contains several example scripts that help illustrate the capabilities of the APIs. These scripts are simple command line utilities that can be executed by passing the name of the script to a Python interpreter.

$ python package_generation_example.py

Writing Your Own Application

See the Examples page for more examples of using python-maec in your own application.