Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/python: Point users at WebSocket #398

Merged
merged 1 commit into from
Mar 19, 2024
Merged

docs/python: Point users at WebSocket #398

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions doc/python.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@
Python Bindings
===============

.. warning::

To interact with Zeek, Broker's Python bindings should almost never be the
first choice nowadays. Consider them deprecated for most purposes. When setting
out to develop a new integration with Zeek, consider using :ref:`WebSockets <web-socket>`
instead. They are cross-platform, avoid pitfalls during deployment and upgrades
related to binary compatiblity. For debugging purposes, the WebSocket protocol
(in plaintext) is easier to introspect and monitor, too.


Almost all functionality of Broker is also accessible through Python
bindings. The Python API mostly mimics the C++ interface, but adds
transparent conversion between Python values and Broker values. In the
Expand Down
Loading