From 24e210fb2b9da88d9366849723200fac80871b87 Mon Sep 17 00:00:00 2001 From: William Barnhart Date: Sun, 19 Jul 2026 16:40:50 +0000 Subject: [PATCH 1/2] docs: correct stale dependency and version references The user-facing docs still carried robinhood-era and pre-0.12 details: - `redis` extra listed the long-deprecated `aredis`; it is backed by `redis-py` now (since #635). - The "What do I need?" sidebar claimed Python 3.8 while the prose right below it already says 3.10 (the real minimum) - align it to 3.10. - Dropped two stale "Faust version 1.0" self-references. - Document the `faust[ckafka]` bundle (confluent-kafka / `confluent://` transport), which had no mention in the install docs. Co-Authored-By: Claude Opus 4.8 Claude-Session: https://claude.ai/code/session_01HHPL4VFWQRQPpjR1gXSKyL --- docs/includes/installation.txt | 7 +++++++ docs/introduction.rst | 6 +++--- docs/userguide/application.rst | 2 +- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/includes/installation.txt b/docs/includes/installation.txt index a75702494..676eddf0c 100644 --- a/docs/includes/installation.txt +++ b/docs/includes/installation.txt @@ -46,6 +46,13 @@ Caching :``faust[redis]``: for using `Redis_` as a simple caching backend (Memcached-style). +Transports +~~~~~~~~~~ + +:``faust[ckafka]``: + for using the :pypi:`confluent-kafka` client through the ``confluent://`` + transport. + Codecs ~~~~~~ diff --git a/docs/introduction.rst b/docs/introduction.rst index ad064a4f3..0b833d766 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -151,11 +151,11 @@ What do I need? ================== .. sidebar:: Version Requirements - :subtitle: Faust version 1.0 runs on + :subtitle: Faust runs on **Core** - - Python 3.8 or later. + - Python 3.10 or later. - Kafka 0.10.1 or later. **Extensions** @@ -176,7 +176,7 @@ Extensions +--------------+-------------+--------------------------------------------------+ | ``rocksdb`` | 5.0 | ``pip install faust-streaming[rocksdb]`` | +--------------+-------------+--------------------------------------------------+ -| ``redis`` | aredis 1.1 | ``pip install faust-streaming[redis]`` | +| ``redis`` | redis-py | ``pip install faust-streaming[redis]`` | +--------------+-------------+--------------------------------------------------+ | ``datadog`` | 0.20.0 | ``pip install faust-streaming[datadog]`` | +--------------+-------------+--------------------------------------------------+ diff --git a/docs/userguide/application.rst b/docs/userguide/application.rst index 29c21b970..b53b1663e 100644 --- a/docs/userguide/application.rst +++ b/docs/userguide/application.rst @@ -78,7 +78,7 @@ the driver that you want to use (it can also be the fully qualified path to a Python class). The storage driver decides how to keep distributed tables locally, and -Faust version 1.0 supports two options: +Faust supports two options: +----------------+-----------------------------------------------+ | ``rocksdb://`` | `RocksDB`_ an embedded database (production) | From 989ad6cfc9a1cf32baaaaac16d9828478f4772ef Mon Sep 17 00:00:00 2001 From: William Barnhart Date: Sun, 19 Jul 2026 16:44:03 +0000 Subject: [PATCH 2/2] docs: refresh copyright year and document missing extras - Bump the docs copyright to 2026 and note the faust-streaming project's continued maintenance (docs/conf.py and copyright.rst). - Document the install bundles that existed but were undocumented: `faust[rocksdict]` (Stores), and `faust[prometheus]` / `faust[sentry]` (Sensors). Left `aerospike` out on purpose: it ships a requirements file but is not in setup.py's BUNDLES, so `faust[aerospike]` is not an installable extra. Co-Authored-By: Claude Opus 4.8 Claude-Session: https://claude.ai/code/session_01HHPL4VFWQRQPpjR1gXSKyL --- docs/conf.py | 2 +- docs/copyright.rst | 2 ++ docs/includes/installation.txt | 10 ++++++++++ 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index c563f3628..58a0687a0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,7 +14,7 @@ canonical_url='https://faust-streaming.github.io/faust', webdomain='', github_project='faust-streaming/faust', - copyright='2017-2020, 2021-2022 Community', + copyright='2017-2020, 2021-2026 Community', html_logo='images/logo.png', html_favicon='images/favicon.ico', html_prepend_sidebars=[], diff --git a/docs/copyright.rst b/docs/copyright.rst index 1d967eb75..11a58cae6 100644 --- a/docs/copyright.rst +++ b/docs/copyright.rst @@ -7,6 +7,8 @@ Copyright Copyright |copy| 2017-2020, Robinhood Markets, Inc. +Copyright |copy| 2021-2026, the faust-streaming project. + All rights reserved. This material may be copied or distributed only subject to the terms and conditions set forth in the `Creative Commons Attribution-ShareAlike 4.0 International` diff --git a/docs/includes/installation.txt b/docs/includes/installation.txt index 676eddf0c..a44f485d6 100644 --- a/docs/includes/installation.txt +++ b/docs/includes/installation.txt @@ -37,6 +37,10 @@ Stores **Recommended in production.** +:``faust[rocksdict]``: + for storing Faust table state in `RocksDB`_ through the + :pypi:`rocksdict` bindings. + .. _`RocksDB`: http://rocksdb.org @@ -74,6 +78,12 @@ Sensors :``faust[statsd]``: for using the Statsd Faust monitor. +:``faust[prometheus]``: + for using the Prometheus Faust monitor. + +:``faust[sentry]``: + for reporting worker errors to Sentry via :pypi:`sentry-sdk`. + Event Loops ~~~~~~~~~~~