API Documentation
=================

insights.core
-------------

.. automodule:: insights.core
    :members:
    :show-inheritance:
    :undoc-members:

insights.core.context
---------------------

.. automodule:: insights.core.context
    :members:
    :show-inheritance:
    :undoc-members:

insights.core.dr
----------------

.. automodule:: insights.core.dr
    :members:
    :show-inheritance:
    :undoc-members:
    :exclude-members: ComponentType

.. autoclass:: insights.core.dr.ComponentType
    :members:
    :exclude-members: requires, optional, metadata, group, tags

insights.core.exceptions
------------------------

.. automodule:: insights.core.exceptions
    :members:
    :show-inheritance:
    :undoc-members:

insights.core.filters
---------------------

.. automodule:: insights.core.filters
    :members:
    :show-inheritance:
    :undoc-members:

insights.core.plugins
---------------------

.. automodule:: insights.core.plugins
    :members:
    :show-inheritance:
    :undoc-members:

insights.core.remote_resource
-----------------------------

.. automodule:: insights.core.remote_resource
    :members:
    :show-inheritance:
    :undoc-members:

insights.core.spec_factory
--------------------------

.. automodule:: insights.core.spec_factory
    :members:
    :show-inheritance:
    :undoc-members:

insights.core.taglang
---------------------

.. automodule:: insights.core.taglang
    :members:
    :show-inheritance:
    :undoc-members:

insights.cleaner
----------------

.. automodule:: insights.cleaner
    :members:
    :show-inheritance:
    :undoc-members:

insights.cleaner.filters
------------------------

.. automodule:: insights.cleaner.filters
    :members:
    :show-inheritance:
    :undoc-members:

insights.cleaner.hostname
-------------------------

.. automodule:: insights.cleaner.hostname
    :members:
    :show-inheritance:
    :undoc-members:

insights.cleaner.ip
-------------------

.. automodule:: insights.cleaner.ip
    :members:
    :show-inheritance:
    :undoc-members:

insights.cleaner.keyword
------------------------

.. automodule:: insights.cleaner.keyword
    :members:
    :show-inheritance:
    :undoc-members:

insights.cleaner.mac
--------------------

.. automodule:: insights.cleaner.mac
    :members:
    :show-inheritance:
    :undoc-members:

insights.cleaner.password
-------------------------

.. automodule:: insights.cleaner.password
    :members:
    :show-inheritance:
    :undoc-members:

insights.cleaner.pattern
------------------------

.. automodule:: insights.cleaner.pattern
    :members:
    :show-inheritance:
    :undoc-members:

insights.parsers
----------------

.. automodule:: insights.parsers
    :members: calc_offset, get_active_lines, keyword_search,
              optlist_to_dict, parse_delimited_table,
              parse_fixed_table, split_kv_pairs, unsplit_lines
    :show-inheritance:
    :undoc-members:

insights.parsr
--------------

.. automodule:: insights.parsr
    :members:
    :show-inheritance:
    :undoc-members:

insights.parsr.query
--------------------

.. automodule:: insights.parsr.query
    :members:
    :show-inheritance:
    :undoc-members:

insights.parsr.query.boolean
----------------------------

.. automodule:: insights.parsr.query.boolean
    :members:
    :show-inheritance:
    :undoc-members:

insights.specs
--------------
.. automodule:: insights.specs
    :members:
    :exclude-members: context_handlers, registry
    :show-inheritance:
    :undoc-members:

insights.specs.manifests
------------------------
.. automodule:: insights.specs.manifests
    :members: manifests, content_types
    :show-inheritance:
    :undoc-members:



insights.specs.default
----------------------
.. automodule:: insights.specs.default
    :members:
    :exclude-members: context_handlers, registry
    :show-inheritance:
    :undoc-members:

insights.specs.insights_archive
-------------------------------
.. automodule:: insights.specs.insights_archive
    :members:
    :exclude-members: context_handlers, registry
    :show-inheritance:
    :undoc-members:

insights.specs.sos_archive
--------------------------
.. automodule:: insights.specs.sos_archive
    :members:
    :exclude-members: context_handlers, registry
    :show-inheritance:
    :undoc-members:

insights.specs.jdr_archive
--------------------------
.. automodule:: insights.specs.jdr_archive
    :members:
    :exclude-members: context_handlers, registry
    :show-inheritance:
    :undoc-members:

insights.tests
--------------

.. automodule:: insights.tests
    :members:
    :show-inheritance:
    :undoc-members:

insights.tools
--------------

.. automodule:: insights.tools.cat
    :members:
    :show-inheritance:
    :undoc-members:

.. automodule:: insights.tools.insights_inspect
    :members:
    :show-inheritance:
    :undoc-members:

.. automodule:: insights.tools.query
    :members:
    :show-inheritance:
    :undoc-members:

insights.util
-------------

.. automodule:: insights.util
    :members:
    :show-inheritance:
    :undoc-members:

.. automodule:: insights.util.autology
    :members:
    :show-inheritance:
    :undoc-members:

.. automodule:: insights.util.autology.datasources
    :members:
    :show-inheritance:
    :undoc-members:

insights
--------

.. automodule:: insights.collect
    :members: collect
    :show-inheritance:
    :undoc-members: