Welcome to bhopengraph's documentation!
========================================

.. image:: https://img.shields.io/pypi/v/bhopengraph
   :target: https://pypi.org/project/bhopengraph/
   :alt: PyPI version

.. image:: https://img.shields.io/github/release/p0dalirius/bhopengraph
   :target: https://github.com/p0dalirius/bhopengraph/releases
   :alt: GitHub release

.. image:: https://img.shields.io/twitter/follow/podalirius_?label=Podalirius&style=social
   :target: https://twitter.com/podalirius_
   :alt: Twitter Follow

.. image:: https://img.shields.io/youtube/channel/subscribers/UCF_x5O7CSfr82AfNVTKOv_A?style=social
   :target: https://www.youtube.com/c/Podalirius_
   :alt: YouTube Channel Subscribers

A Python library to create BloodHound OpenGraphs easily.

This module provides Python classes for creating and managing graph structures that are compatible with BloodHound OpenGraph. The classes follow the `BloodHound OpenGraph schema <https://bloodhound.specterops.io/opengraph/schema>`_ and `best practices <https://bloodhound.specterops.io/opengraph/best-practices>`_.

If you don't know about BloodHound OpenGraph yet, a great introduction can be found here: `https://bloodhound.specterops.io/opengraph/best-practices <https://bloodhound.specterops.io/opengraph/best-practices>`_

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   quickstart
   api/index
   examples/index
   contributing

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`