Update badges and settingref.txt (#353)

* update README badges and settingref.txt

* add BSD license badge

README.md

@@ -2,9 +2,13 @@
 
 # Python Stream Processing Fork
 
-![python versions](https://img.shields.io/badge/python-3.6%203.7%203.8%203.9%203.10-blue)
-![version](https://img.shields.io/badge/version-0.8.8-green)
+![python versions](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-blue)
+![version](https://img.shields.io/badge/version-0.8.9-green)
 [![codecov](https://codecov.io/gh/faust-streaming/faust/branch/master/graph/badge.svg?token=QJFBYNN0JJ)](https://codecov.io/gh/faust-streaming/faust)
+[![slack](https://img.shields.io/badge/slack-Faust-brightgreen.svg?logo=slack)](https://fauststream.slack.com/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+![pre-commit](https://img.shields.io/badge/pre--commit-enabled-green)
+![license](https://img.shields.io/pypi/l/faust-streaming)
 
 ## Installation
 

docs/includes/settingref.txt

@@ -746,7 +746,7 @@ Automatically check the CRC32 of the records consumed.
 --------------------
 
 :type: :class:`str`
-:default: ``'faust-1.11.0a1'``
+:default: ``'faust-0.8.9'``
 :environment: :envvar:`BROKER_CLIENT_ID`
 
 Broker client ID.
@@ -1029,6 +1029,45 @@ If not set, default assignment strategy is used. Otherwise,
 each consumer instance has to have a unique id.
 
 
+.. setting:: consumer_metadata_max_age_ms
+
+``consumer_metadata_max_age_ms``
+--------------------------------
+
+.. versionadded:: 0.8.5
+
+:type: :class:`int`
+:default: ``300000``
+:environment: :envvar:`CONSUMER_METADATA_MAX_AGE_MS`
+
+Consumer metadata max age milliseconds
+
+The period of time in milliseconds after which we force
+a refresh of metadata even if we haven’t seen any partition
+leadership changes to proactively discover any new brokers or partitions.
+
+Default: 300000
+
+
+.. setting:: consumer_connections_max_idle_ms
+
+``consumer_connections_max_idle_ms``
+------------------------------------
+
+.. versionadded:: 0.8.5
+
+:type: :class:`int`
+:default: ``540000``
+:environment: :envvar:`CONSUMER_CONNECTIONS_MAX_IDLE_MS`
+
+Consumer connections max idle milliseconds.
+
+Close idle connections after the number of milliseconds
+specified by this config.
+
+Default: 540000 (9 minutes).
+
+
 .. setting:: ConsumerScheduler
 
 ``ConsumerScheduler``
@@ -1295,72 +1334,62 @@ This is set high by default, as this is also the time when
 producer batches expire and will no longer be retried.
 
 
+.. setting:: producer_threaded
 
-.. _settings-rpc:
-
-Agent RPC Settings
-==================
-
-.. setting:: reply_create_topic
+``producer_threaded``
+---------------------
 
-``reply_create_topic``
-----------------------
+.. versionadded:: 0.4.5
 
 :type: :class:`bool`
 :default: :const:`False`
-:environment: :envvar:`APP_REPLY_CREATE_TOPIC`
+:environment: :envvar:`PRODUCER_THREADED`
 
-Automatically create reply topics.
+Thread separate producer for send_soon.
 
-Set this to :const:`True` if you plan on using the RPC with agents.
+If True, spin up a different producer in a different thread
+to be used for messages buffered up for producing via
+send_soon function.
 
-This will create the internal topic used for RPC replies on that
-instance at startup.
 
+.. setting:: producer_metadata_max_age_ms
 
-.. setting:: reply_expires
+``producer_metadata_max_age_ms``
+--------------------------------
 
-``reply_expires``
------------------
+.. versionadded:: 0.8.5
 
-:type: :class:`float` / :class:`~datetime.timedelta`
-:default: ``86400.0``
-:environment: :envvar:`APP_REPLY_EXPIRES`
-
-RPC reply expiry time in seconds.
-
-The expiry time (in seconds :class:`float`,
-or :class:`~datetime.timedelta`), for how long replies will stay
-in the instances local reply topic before being removed.
+:type: :class:`int`
+:default: ``300000``
+:environment: :envvar:`PRODUCER_METADATA_MAX_AGE_MS`
 
+Producer metadata max age milliseconds
 
-.. setting:: reply_to
+The period of time in milliseconds after which we force
+a refresh of metadata even if we haven’t seen any partition
+leadership changes to proactively discover any new brokers or partitions.
 
-``reply_to``
-------------
+Default: 300000
 
-:type: :class:`str`
-:default: :const:`None`
 
-Reply to address.
 
-The name of the reply topic used by this instance.
-If not set one will be automatically generated when the app
-is created.
+.. setting:: producer_connections_max_idle_ms
 
+``producer_connections_max_idle_ms``
+------------------------------------
 
-.. setting:: reply_to_prefix
+.. versionadded:: 0.8.5
 
-``reply_to_prefix``
--------------------
+:type: :class:`int`
+:default: ``540000``
+:environment: :envvar:`PRODUCER_CONNECTIONS_MAX_IDLE_MS`
 
-:type: :class:`str`
-:default: ``'f-reply-'``
-:environment: :envvar:`APP_REPLY_TO_PREFIX`
+Producer connections max idle milliseconds.
 
-Reply address topic name prefix.
+Close idle connections after the number of milliseconds
+specified by this config.
 
-The prefix used when generating reply topic names.
+Default: 540000 (9 minutes).
 
 
 
@@ -1369,6 +1398,92 @@ The prefix used when generating reply topic names.
 Advanced Stream Settings
 ========================
 
+.. setting:: recovery_consistency_check
+
+``recovery_consistency_check``
+------------------------------
+
+.. versionadded:: 0.4.7
+
+:type: :class:`bool`
+:default: :const:`True`
+:environment: :envvar:`RECOVERY_CONSISTENCY_CHECK`
+
+Check Kafka and local offsets for consistency.
+
+If True, assert that Kafka highwater offsets >= local offset
+in the rocksdb state storee
+
+
+.. setting:: store_check_exists
+
+``store_check_exists``
+----------------------
+
+.. versionadded:: 0.6.0
+
+:type: :class:`bool`
+:default: :const:`True`
+:environment: :envvar:`STORE_CHECK_EXISTS`
+
+Execute exists on the underlying store.
+
+If True, executes exists on the underlying store. If False
+client has to catch KeyError
+
+
+.. setting:: crash_app_on_aerospike_exception
+
+``crash_app_on_aerospike_exception``
+------------------------------------
+
+.. versionadded:: 0.6.3
+
+:type: :class:`bool`
+:default: :const:`True`
+:environment: :envvar:`CRASH_APP_ON_AEROSPIKE_EXCEPTION`
+
+Crashes the app on an aerospike Exceptions.
+
+If True, crashes the app and prevents the commit offset on progressing. If False
+client has to catch the Error and implement a dead letter queue
+
+
+.. setting:: aerospike_retries_on_exception
+
+``aerospike_retries_on_exception``
+----------------------------------
+
+.. versionadded:: 0.6.10
+
+:type: :class:`int`
+:default: ``60``
+:environment: :envvar:`AEROSPIKE_RETRIES_ON_EXCEPTION`
+
+Number of retries to aerospike on a runtime error from the aerospike client.
+
+Set this to the number of retries using the aerospike client on a runtime
+Exception thrown by the client
+
+
+.. setting:: aerospike_sleep_seconds_between_retries_on_exception
+
+``aerospike_sleep_seconds_between_retries_on_exception``
+--------------------------------------------------------
+
+.. versionadded:: 0.6.10
+
+:type: :class:`int`
+:default: ``1``
+:environment: :envvar:`AEROSPIKE_SLEEP_SECONDS_BETWEEN_RETRIES_ON_EXCEPTION`
+
+Seconds to sleep between retries to aerospike on a runtime error from
+the aerospike client.
+
+Set this to the sleep in seconds between retries using the aerospike
+client on a runtime Exception thrown by the client
+
+
 .. setting:: stream_buffer_maxsize
 
 ``stream_buffer_maxsize``
@@ -1520,6 +1635,74 @@ streams are idempotent you can disable it using this setting.
 
 
 
+.. _settings-rpc:
+
+Agent RPC Settings
+==================
+
+.. setting:: reply_create_topic
+
+``reply_create_topic``
+----------------------
+
+:type: :class:`bool`
+:default: :const:`False`
+:environment: :envvar:`APP_REPLY_CREATE_TOPIC`
+
+Automatically create reply topics.
+
+Set this to :const:`True` if you plan on using the RPC with agents.
+
+This will create the internal topic used for RPC replies on that
+instance at startup.
+
+
+.. setting:: reply_expires
+
+``reply_expires``
+-----------------
+
+:type: :class:`float` / :class:`~datetime.timedelta`
+:default: ``86400.0``
+:environment: :envvar:`APP_REPLY_EXPIRES`
+
+RPC reply expiry time in seconds.
+
+The expiry time (in seconds :class:`float`,
+or :class:`~datetime.timedelta`), for how long replies will stay
+in the instances local reply topic before being removed.
+
+
+.. setting:: reply_to
+
+``reply_to``
+------------
+
+:type: :class:`str`
+:default: :const:`None`
+
+Reply to address.
+
+The name of the reply topic used by this instance.
+If not set one will be automatically generated when the app
+is created.
+
+
+.. setting:: reply_to_prefix
+
+``reply_to_prefix``
+-------------------
+
+:type: :class:`str`
+:default: ``'f-reply-'``
+:environment: :envvar:`APP_REPLY_TO_PREFIX`
+
+Reply address topic name prefix.
+
+The prefix used when generating reply topic names.
+
+
+
 .. _settings-table:
 
 Advanced Table Settings
@@ -1820,6 +2003,21 @@ This option is usually set by :option:`faust worker --web-port`,
 not by passing it as a keyword argument to :class:`app`.
 
 
+.. setting:: web_ssl_context
+
+``web_ssl_context``
+-------------------
+
+.. versionadded:: 0.5.0
+
+:type: :class:`~ssl.SSLContext`
+:default: :const:`None`
+
+Web server SSL configuration.
+
+See :setting:`credentials`.
+
+
 .. setting:: web_transport
 
 ``web_transport``
@@ -1829,7 +2027,7 @@ not by passing it as a keyword argument to :class:`app`.
 
 :type: :class:`str` / :class:`~yarl.URL`
 :default: ``URL('tcp:')``
-:related-command-options:  :option:`faust worker --web-transport`
+:related-command-options: :option:`faust worker --web-transport`
 
 Network transport used for the web server.