Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/topic/awelzel/python-websocket-w…
Browse files Browse the repository at this point in the history
…arning-banner'

* origin/topic/awelzel/python-websocket-warning-banner:
  docs/python: Point users at WebSocket
  • Loading branch information
timwoj committed Mar 19, 2024
2 parents e730286 + 90233a0 commit 7cc4f5f
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
14 changes: 14 additions & 0 deletions CHANGES
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
2.8.0-dev.51 | 2024-03-19 15:28:32 -0700

* docs/python: Point users at WebSocket (Arne Welzel, Corelight)

Users on Slack somewhat regularly ask questions around how to use the Python
bindings and finding quirks with it. Just for us to tell them they
should be using WebSockets instead. These might not be perfect, but at
least we're open to hear feedback and improve them, which isn't
necessarily our stance for the Python bindings.

Put up a big banner to redirect users into the future. Seems "warning" is
warranted given our reluctance and future ideas around deprecation for
the bindings.

2.8.0-dev.49 | 2024-03-15 22:18:06 +0100

* CI: Remove CentOS 7 and Debian 10 builds (Christian Kreibich, Corelight)
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.8.0-dev.49
2.8.0-dev.51
10 changes: 10 additions & 0 deletions doc/python.rst
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

0 comments on commit 7cc4f5f

Please sign in to comment.