API Reference
=============


IP
--
.. automodule:: clx.ip
    :members:

Analytics
---------
.. autoclass:: clx.analytics.dga_detector.DGADetector
    :members:

.. autoclass:: clx.analytics.model.rnn_classifier.RNNClassifier
    :members:

.. automodule:: clx.analytics.stats
    :members:

DNS Extractor
-------------
.. automodule:: clx.dns.dns_extractor
    :members:

Heuristics
----------
.. automodule:: clx.heuristics.ports
    :members:

OSI (Open Source Integration)
-----------------------------
.. autoclass:: clx.osi.farsight.FarsightLookupClient
    :members:

.. autoclass:: clx.osi.virus_total.VirusTotalClient
    :members:

.. autoclass:: clx.osi.whois.WhoIsLookupClient
    :members:

Parsers
-------

.. autoclass:: clx.parsers.event_parser.EventParser
    :members:

.. autoclass:: clx.parsers.splunk_notable_parser.SplunkNotableParser
    :members:

.. autoclass:: clx.parsers.windows_event_parser.WindowsEventParser
    :members:

.. automodule:: clx.parsers.zeek
    :members:

Workflow
--------

.. autoclass:: clx.workflow.workflow.Workflow
    :members:

.. autoclass:: clx.workflow.splunk_alert_workflow.SplunkAlertWorkflow
    :members:

I/O
--------

.. autoclass:: clx.io.reader.kafka_reader.KafkaReader
    :members:

.. autoclass:: clx.io.reader.dask_fs_reader.DaskFileSystemReader
    :members:

.. autoclass:: clx.io.reader.fs_reader.FileSystemReader
    :members:

.. autoclass:: clx.io.writer.kafka_writer.KafkaWriter
    :members:

.. autoclass:: clx.io.writer.fs_writer.FileSystemWriter
    :members: