airtai · davorrunje · Dec 13, 2023 · Dec 13, 2023 · Dec 13, 2023 · Dec 13, 2023
diff --git a/.github/workflows/update_release_notes.yaml b/.github/workflows/update_release_notes.yaml
@@ -15,6 +15,11 @@ jobs:
       TAG_NAME: ${{ github.ref_name }}
       BRANCH_NAME: update-release-notes-${{ github.ref_name }}
     steps:
+      - name: Configure Git user
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
@@ -53,8 +58,9 @@ jobs:
         with:
           token: ${{ steps.generate-token.outputs.token }}
           branch: ${{ env.BRANCH_NAME }}
+          base: "main" # The branch you want to merge into
           title: "Update Release Notes for ${{ env.TAG_NAME }}"
           commit-message: "Update Release Notes for ${{ env.TAG_NAME }}"
           body: "This is an automated pull request to update the release notes for ${{ env.TAG_NAME }}"
-          base: "main" # The branch you want to merge into
+          labels: documentation
           reviewers: davorrunje, Lancetnik, kumaranvpl, sternakt
diff --git a/docs/create_api_docs.py b/docs/create_api_docs.py
@@ -6,7 +6,6 @@
 from types import FunctionType, ModuleType
 from typing import Any, List, Optional, Tuple, Type, Union
 
-
 API_META = (
     "# 0.5 - API\n"
     "# 2 - Release\n"
@@ -294,6 +293,7 @@ def create_api_docs(
 
     (docs_dir / "SUMMARY.md").write_text(summary)
 
+
 if __name__ == "__main__":
     root = Path(__file__).resolve().parent
     create_api_docs(root, "faststream")
diff --git a/docs/docs/SUMMARY.md b/docs/docs/SUMMARY.md
@@ -1,3 +1,7 @@
+---
+search:
+  exclude: true
+---
 - [Features](faststream.md)
 - Tutorial
     - [Getting Started](getting-started/index.md)
@@ -62,6 +66,7 @@
     - [Acknowledgement](rabbit/ack.md)
     - [Declare Queue/Exchange](rabbit/declare.md)
     - [Message Information](rabbit/message.md)
+    - [Security Configuration](rabbit/security.md)
 - [NATS](nats/index.md)
     - Subscription
         - [Direct](nats/examples/direct.md)
@@ -228,6 +233,7 @@
             - handler
                 - [AsyncHandler](api/faststream/broker/handler/AsyncHandler.md)
                 - [BaseHandler](api/faststream/broker/handler/BaseHandler.md)
+                - [MultiLock](api/faststream/broker/handler/MultiLock.md)
             - message
                 - [ABCStreamMessage](api/faststream/broker/message/ABCStreamMessage.md)
                 - [StreamMessage](api/faststream/broker/message/StreamMessage.md)

diff --git a/docs/docs/en/api/faststream/broker/handler/MultiLock.md b/docs/docs/en/api/faststream/broker/handler/MultiLock.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.broker.handler.MultiLock
diff --git a/docs/docs/en/getting-started/serialization/examples.md b/docs/docs/en/getting-started/serialization/examples.md
@@ -82,19 +82,19 @@ Next, let's define the schema for our message. You can either define it in the P
 Or you can load the schema from an avsc file as:
 
 ``` python
-{!> docs_src/getting_started/serialization/avro.py [ln:20] !}
+{!> docs_src/getting_started/serialization/avro.py [ln:21] !}
 ```
 
 The contents of the `person.avsc` file are:
 
-```avro
+``` avro
 {!> docs_src/getting_started/serialization/person.avsc !}
 ```
 
 Finally, let's use Avro's `schemaless_reader` and `schemaless_writer` to decode and encode messages in the `FastStream` app.
 
-``` python linenums="1" hl_lines="1 3 25-28 31 40-42"
-{!> docs_src/getting_started/serialization/avro.py !}
+``` python linenums="1" hl_lines="1 3 15-18 21 30-32"
+{!> docs_src/getting_started/serialization/avro.py [ln:1-9,23-45] !}
 ```
 
 ## Tips

diff --git a/docs/docs/en/kafka/Publisher/batch_publisher.md b/docs/docs/en/kafka/Publisher/batch_publisher.md
@@ -42,6 +42,10 @@ Or you can decorate your processing function and return a batch of messages, as
 
 The application in the example imelements both of these ways, so feel free to use whichever option fits your needs better.
 
+!!! note
+    Also, you can publishes messages in batches right from a `broker` object: just call  
+    `#!python broker.publish_batch("msg2", "msg2", topic="output_data")`
+
 ## Why Publish in Batches?
 
 In the above example, we've explored how to leverage the `#!python @broker.publisher(...)` decorator to efficiently publish messages in batches using **FastStream** and **Kafka**. By following the two key steps outlined in the previous sections, you can significantly enhance the performance and reliability of your **Kafka**-based applications.

diff --git a/docs/docs/en/kafka/security.md b/docs/docs/en/kafka/security.md
@@ -1,16 +1,14 @@
-# Kafka Security Configuration
-
 # FastStream Kafka Security
 
-This chapter discusses the security options available in FastStream and how to use them.
+This chapter discusses the security options available in **FastStream** and how to use them.
 
 ## Security Objects
 
-FastStream allows you to enhance the security of applications by using security objects when creating brokers. These security objects encapsulate security-related configurations and mechanisms. Security objects supported in FastStream are (More are planned in the future such as SASL OAuth):
+**FastStream** allows you to enhance the security of applications by using security objects when creating brokers. These security objects encapsulate security-related configurations and mechanisms. Security objects supported in **FastStream** are (More are planned in the future such as SASL OAuth):
 
 ### 1. BaseSecurity Object
 
-**Purpose:** The `BaseSecurity` object wraps `ssl.SSLContext` object and is used to enable SSL/TLS encryption for secure communication between FastStream services and external components such as message brokers.
+**Purpose:** The `BaseSecurity` object wraps `ssl.SSLContext` object and is used to enable SSL/TLS encryption for secure communication between **FastStream** services and external components such as message brokers.
 
 **Usage:**
 

diff --git a/docs/docs/en/rabbit/security.md b/docs/docs/en/rabbit/security.md
@@ -0,0 +1,27 @@
+# FastStream RabbitMQ Security
+
+This chapter discusses the security options available in **FastStream** and how to use them.
+
+## Security Objects
+
+**FastStream** allows you to enhance the security of **applications** by using security objects when creating brokers. These security objects encapsulate security-related configurations and mechanisms. Security objects supported in **FastStream** for **RabbitMQ** are:
+
+### 1. BaseSecurity Object
+
+**Purpose:** The `BaseSecurity` object wraps `ssl.SSLContext` object and is used to enable SSL/TLS encryption for secure communication between FastStream services and external components such as message brokers.
+
+**Usage:**
+
+```python linenums="1" hl_lines="6-7 9"
+{!> docs_src/rabbit/security/basic.py !}
+```
+
+### 2. SASLPlaintext Object with SSL/TLS
+
+**Purpose:** The `SASLPlaintext` object is used for authentication in SASL (Simple Authentication and Security Layer) plaintext mode. It allows you to provide a username and password for authentication.
+
+**Usage:**
+
+```python linenums="1" hl_lines="6-11 13"
+{!> docs_src/rabbit/security/plaintext.py !}
+```
diff --git a/docs/docs/en/redis/security.md b/docs/docs/en/redis/security.md
@@ -1,21 +1,19 @@
-# Kafka Security Configuration
-
 # FastStream Redis Security
 
-This chapter discusses the security options available in FastStream and how to use them.
+This chapter discusses the security options available in **FastStream** and how to use them.
 
 ## Security Objects
 
-FastStream allows you to enhance the security of applications by using security objects when creating brokers. These security objects encapsulate security-related configurations and mechanisms. Security objects supported in FastStream for Redis are:
+**FastStream** allows you to enhance the security of **applications** by using security objects when creating brokers. These security objects encapsulate security-related configurations and mechanisms. Security objects supported in **FastStream** for **Redis** are:
 
 ### 1. BaseSecurity Object
 
 **Purpose:** The `BaseSecurity` object wraps `ssl.SSLContext` object and is used to enable SSL/TLS encryption for secure communication between FastStream services and external components such as message brokers.
 
 **Usage:**
 
-```python linenums="1"
-{!> docs_src/redis/basic_security/app.py [ln:1-11] !}
+```python linenums="1" hl_lines="6-7 9"
+{!> docs_src/redis/security/basic.py !}
 ```
 
 ### 2. SASLPlaintext Object with SSL/TLS
@@ -24,6 +22,6 @@ FastStream allows you to enhance the security of applications by using security
 
 **Usage:**
 
-```python linenums="1"
-{!> docs_src/redis/plaintext_security/app.py [ln:1-11] !}
+```python linenums="1" hl_lines="6-11 13"
+{!> docs_src/redis/security/plaintext.py !}
 ```
diff --git a/docs/docs/navigation_template.txt b/docs/docs/navigation_template.txt
@@ -1,3 +1,7 @@
+---
+search:
+  exclude: true
+---
 - [Features](faststream.md)
 - Tutorial
     - [Getting Started](getting-started/index.md)
@@ -62,6 +66,7 @@
     - [Acknowledgement](rabbit/ack.md)
     - [Declare Queue/Exchange](rabbit/declare.md)
     - [Message Information](rabbit/message.md)
+    - [Security Configuration](rabbit/security.md)
 - [NATS](nats/index.md)
     - Subscription
         - [Direct](nats/examples/direct.md)

diff --git a/docs/docs_src/getting_started/serialization/avro.py b/docs/docs_src/getting_started/serialization/avro.py
@@ -20,6 +20,7 @@
 
 person_schema = fastavro.schema.load_schema("person.avsc")
 
+# person_schema = ...
 schema = fastavro.schema.parse_schema(person_schema)
 
 async def decode_message(msg: KafkaMessage):

diff --git a/...docs_src/redis/basic_security/__init__.py → docs/docs_src/rabbit/security/__init__.py b/...docs_src/redis/basic_security/__init__.py → docs/docs_src/rabbit/security/__init__.py
diff --git a/docs/docs_src/rabbit/security/basic.py b/docs/docs_src/rabbit/security/basic.py
@@ -0,0 +1,9 @@
+import ssl
+
+from faststream.rabbit import RabbitBroker
+from faststream.security import BaseSecurity
+
+ssl_context = ssl.create_default_context()
+security = BaseSecurity(ssl_context=ssl_context)
+
+broker = RabbitBroker(security=security)
diff --git a/docs/docs_src/rabbit/security/plaintext.py b/docs/docs_src/rabbit/security/plaintext.py
@@ -0,0 +1,13 @@
+import ssl
+
+from faststream.rabbit import RabbitBroker
+from faststream.security import SASLPlaintext
+
+ssl_context = ssl.create_default_context()
+security = SASLPlaintext(
+    ssl_context=ssl_context,
+    username="admin",
+    password="password",
+)
+
+broker = RabbitBroker(security=security)
diff --git a/docs/docs_src/redis/plaintext_security/app.py b/docs/docs_src/redis/plaintext_security/app.py
diff --git a/..._src/redis/plaintext_security/__init__.py → docs/docs_src/redis/security/__init__.py b/..._src/redis/plaintext_security/__init__.py → docs/docs_src/redis/security/__init__.py
diff --git a/docs/docs_src/redis/basic_security/app.py → docs/docs_src/redis/security/basic.py b/docs/docs_src/redis/basic_security/app.py → docs/docs_src/redis/security/basic.py
@@ -1,17 +1,9 @@
 import ssl
 
-from faststream import FastStream
 from faststream.redis import RedisBroker
 from faststream.security import BaseSecurity
 
 ssl_context = ssl.create_default_context()
 security = BaseSecurity(ssl_context=ssl_context)
 
 broker = RedisBroker(security=security)
-app = FastStream(broker)
-
-
-@broker.publisher("test_2")
-@broker.subscriber("test_1")
-async def test_topic(msg: str) -> str:
-    pass
diff --git a/docs/docs_src/redis/security/plaintext.py b/docs/docs_src/redis/security/plaintext.py
@@ -0,0 +1,13 @@
+import ssl
+
+from faststream.redis import RedisBroker
+from faststream.security import SASLPlaintext
+
+ssl_context = ssl.create_default_context()
+security = SASLPlaintext(
+    ssl_context=ssl_context,
+    username="admin",
+    password="password",
+)
+
+broker = RedisBroker(security=security)
diff --git a/docs/includes/getting_started/integrations/fastapi/multiple.md b/docs/includes/getting_started/integrations/fastapi/multiple.md
@@ -12,12 +12,12 @@
 
 === "NATS"
 
-    ```python linenums="1" hl_lines="5-6 16 18-19"
+    ```python linenums="1" hl_lines="4-5 15 17-18"
     {!> docs_src/integrations/fastapi/nats/multiple.py !}
     ```
 
 === "Redis"
 
-    ```python linenums="1" hl_lines="5-6 16 18-19"
+    ```python linenums="1" hl_lines="4-5 15 17-18"
     {!> docs_src/integrations/fastapi/redis/multiple.py !}
     ```
diff --git a/faststream/__about__.py b/faststream/__about__.py
@@ -1,5 +1,5 @@
 """Simple and fast framework to create message brokers based microservices"""
-__version__ = "0.3.4"
+__version__ = "0.3.5"
 
 
 INSTALL_YAML = """

diff --git a/faststream/_compat.py b/faststream/_compat.py
@@ -57,6 +57,11 @@
 ANYIO_VERSION = parse(get_version("anyio"))
 ANYIO_V3 = ANYIO_VERSION.major == 3
 
+
+def is_test_env() -> bool:
+    return bool(os.getenv("PYTEST_CURRENT_TEST"))
+
+
 try:
     from fastapi import __version__ as FASTAPI_VERSION