Skip to content

index.rst

Latest commit

 

History

History
87 lines (64 loc) · 3.13 KB

index.rst

File metadata and controls

87 lines (64 loc) · 3.13 KB
Raw

python-stix |release| Documentation

The python-stix library provides an API for developing and consuming Structured Threat Information eXpression (STIX) content. Developers can leverage the API to develop applications that create, consume, translate, or otherwise process STIX content. This page should help new developers get started with using this library. For more information about STIX, please refer to the STIX website.

Note

These docs provide standard reference for this Python library. For documentation on idiomatic usage and common patterns, as well as various STIX-related information and utilities, please visit the STIXProject at GitHub.

Versions

Each version of python-stix is designed to work with a single version of the STIX Language. The table below shows the latest version the library for each version of STIX.

STIX Version python-stix Version
1.2 1.2.0.2 (PyPI) (GitHub)
1.1.1 1.1.1.7 (PyPI) (GitHub)
1.1.0 1.1.0.6 (PyPI) (GitHub)
1.0.1 1.0.1.1 (PyPI) (GitHub)
1.0 1.0.0a7 (PyPI) (GitHub)

Users and developers working with multiple versions of STIX content may want to take a look at stix-ramrod, which is a library designed to update STIX and CybOX content.

Check out the Working with python-stix section for examples on how to integrate stix-ramrod and python-stix.

Contents

.. toctree::
   :maxdepth: 2

   installation
   getting_started
   overview/index
   examples/index
   api_vs_bindings/index

API Reference

.. toctree::
   :maxdepth: 2

   api/index
   api/coverage

Contributing

If a bug is found, a feature is missing, or something just isn't behaving the way you'd expect it to, please submit an issue to our tracker. If you'd like to contribute code to our repository, you can do so by issuing a pull request and we will work with you to try and integrate that code into our repository.

Indices and tables