Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
58 changes: 58 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<<<<<<< HEAD
# Confluent Python Client for Apache Kafka - CHANGELOG

## v2.12.0 - 2025-10-09
Expand Down Expand Up @@ -52,6 +53,11 @@ for a complete list of changes, enhancements, fixes and upgrade considerations.


## v2.11.1 - 2025-08-18
=======
# Confluent's Python client for Apache Kafka

## v2.11.1
>>>>>>> 7b378e7 (add accidentally removed md files)

v2.11.1 is a maintenance release with the following fixes:

Expand All @@ -60,7 +66,11 @@ confluent-kafka-python v2.11.1 is based on librdkafka v2.11.1, see the
for a complete list of changes, enhancements, fixes and upgrade considerations.


<<<<<<< HEAD
## v2.11.0 - 2025-07-03
=======
## v2.11.0
>>>>>>> 7b378e7 (add accidentally removed md files)

v2.11.0 is a feature release with the following enhancements:

Expand All @@ -69,7 +79,11 @@ confluent-kafka-python v2.11.0 is based on librdkafka v2.11.0, see the
for a complete list of changes, enhancements, fixes and upgrade considerations.


<<<<<<< HEAD
## v2.10.1 - 2025-06-11
=======
## v2.10.1
>>>>>>> 7b378e7 (add accidentally removed md files)

v2.10.1 is a maintenance release with the following fixes:

Expand All @@ -85,7 +99,11 @@ confluent-kafka-python v2.10.1 is based on librdkafka v2.10.1, see the
[librdkafka release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.10.1)
for a complete list of changes, enhancements, fixes and upgrade considerations.

<<<<<<< HEAD
## v2.10.0 - 2025-04-18
=======
## v2.10.0
>>>>>>> 7b378e7 (add accidentally removed md files)

v2.10.0 is a feature release with the following fixes and enhancements:

Expand All @@ -96,7 +114,11 @@ confluent-kafka-python v2.10.0 is based on librdkafka v2.10.0, see the
[librdkafka release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.10.0)
for a complete list of changes, enhancements, fixes and upgrade considerations.

<<<<<<< HEAD
## v2.9.0 - 2025-03-28
=======
## v2.9.0
>>>>>>> 7b378e7 (add accidentally removed md files)

v2.9.0 is a feature release with the following fixes and enhancements:

Expand All @@ -109,7 +131,11 @@ confluent-kafka-python v2.9.0 is based on librdkafka v2.8.0, see the
[librdkafka release notes](https://github.com/confluentinc/librdkafka/releases/tag/v2.8.0)
for a complete list of changes, enhancements, fixes and upgrade considerations.

<<<<<<< HEAD
## v2.8.2 - 2025-02-28
=======
## v2.8.2
>>>>>>> 7b378e7 (add accidentally removed md files)

v2.8.2 is a maintenance release with the following fixes and enhancements:

Expand All @@ -124,7 +150,11 @@ Note: Versioning is skipped due to breaking change in v2.8.1.
Do not run software with v2.8.1 installed.


<<<<<<< HEAD
## v2.8.0 - 2025-01-07
=======
## v2.8.0
>>>>>>> 7b378e7 (add accidentally removed md files)

v2.8.0 is a feature release with the features, fixes and enhancements:

Expand All @@ -133,7 +163,11 @@ confluent-kafka-python v2.8.0 is based on librdkafka v2.8.0, see the
for a complete list of changes, enhancements, fixes and upgrade considerations.


<<<<<<< HEAD
## v2.7.0 - 2024-12-21
=======
## v2.7.0
>>>>>>> 7b378e7 (add accidentally removed md files)

v2.7.0 is a feature release with the features, fixes and enhancements present in v2.6.2 including the following fix:

Expand All @@ -144,7 +178,11 @@ confluent-kafka-python v2.7.0 is based on librdkafka v2.6.1, see the
for a complete list of changes, enhancements, fixes and upgrade considerations.


<<<<<<< HEAD
## v2.6.2 - 2024-12-18
=======
## v2.6.2
>>>>>>> 7b378e7 (add accidentally removed md files)

> [!WARNING]
> Due to an error in which we included dependency changes to a recent patch release, Confluent recommends users to **refrain from upgrading to 2.6.2** of Confluent Kafka. Confluent will release a new minor version, 2.7.0, where the dependency changes will be appropriately included. Users who have already upgraded to 2.6.2 and made the required dependency changes are free to remain on that version and are recommended to upgrade to 2.7.0 when that version is available. Upon the release of 2.7.0, the 2.6.2 version will be marked deprecated.
Expand Down Expand Up @@ -187,7 +225,11 @@ confluent-kafka-python is based on librdkafka v2.6.1, see the
for a complete list of changes, enhancements, fixes and upgrade considerations.


<<<<<<< HEAD
## v2.6.1 - 2024-11-18
=======
## v2.6.1
>>>>>>> 7b378e7 (add accidentally removed md files)

v2.6.1 is a maintenance release with the following fixes and enhancements:

Expand All @@ -200,7 +242,11 @@ confluent-kafka-python is based on librdkafka v2.6.1, see the
for a complete list of changes, enhancements, fixes and upgrade considerations.


<<<<<<< HEAD
## v2.6.0 - 2024-10-11
=======
## v2.6.0
>>>>>>> 7b378e7 (add accidentally removed md files)

v2.6.0 is a feature release with the following features, fixes and enhancements:

Expand All @@ -214,7 +260,11 @@ confluent-kafka-python is based on librdkafka v2.6.0, see the
for a complete list of changes, enhancements, fixes and upgrade considerations.


<<<<<<< HEAD
## v2.5.3 - 2024-09-02
=======
## v2.5.3
>>>>>>> 7b378e7 (add accidentally removed md files)

v2.5.3 is a maintenance release with the following fixes and enhancements:

Expand All @@ -229,7 +279,11 @@ for a complete list of changes, enhancements, fixes and upgrade considerations.



<<<<<<< HEAD
## v2.5.0 - 2024-07-10
=======
## v2.5.0
>>>>>>> 7b378e7 (add accidentally removed md files)

> [!WARNING]
This version has introduced a regression in which an assert is triggered during **PushTelemetry** call. This happens when no metric is matched on the client side among those requested by broker subscription.
Expand Down Expand Up @@ -262,7 +316,11 @@ confluent-kafka-python is based on librdkafka v2.5.0, see the
for a complete list of changes, enhancements, fixes and upgrade considerations.


<<<<<<< HEAD
## v2.4.0 - 2024-05-07
=======
## v2.4.0
>>>>>>> 7b378e7 (add accidentally removed md files)

v2.4.0 is a feature release with the following features, fixes and enhancements:

Expand Down
38 changes: 38 additions & 0 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,18 @@ This document provides information useful to developers working on confluent-kaf
- Git
- librdkafka (for Kafka functionality)

<<<<<<< HEAD
### Quick start (editable install)

<!-- markdownlint-disable MD029 -->

1. **Fork and Clone**

=======
### Setup Steps

1. **Fork and Clone**
>>>>>>> 7b378e7 (add accidentally removed md files)
```bash
git clone https://github.com/your-username/confluent-kafka-python.git
cd confluent-kafka-python
Expand All @@ -30,33 +36,49 @@ This document provides information useful to developers working on confluent-kaf
**Note**: On Windows the variables for Visual Studio are named INCLUDE and LIB

3. **Install librdkafka** (if not already installed)
<<<<<<< HEAD

See the main README.md for platform-specific installation instructions.
=======
See the main README.md for platform-specific installation instructions
>>>>>>> 7b378e7 (add accidentally removed md files)

If librdkafka is installed in a non-standard location provide the include and library directories with:

```bash
C_INCLUDE_PATH=/path/to/include LIBRARY_PATH=/path/to/lib python -m build
```

<<<<<<< HEAD
4. **Install confluent-kafka-python (editable) with dev/test/docs extras**

=======
4. **Install confluent-kafka-python with optional dependencies**
>>>>>>> 7b378e7 (add accidentally removed md files)
```bash
pip3 install -e .[dev,tests,docs]
```

<<<<<<< HEAD
Alternatively you can build the bundle independently with:
=======
This will also build the wheel be default. Alternatively you can build the bundle independently with:
>>>>>>> 7b378e7 (add accidentally removed md files)

```bash
python3 -m build
```

5. **Verify Setup**
<<<<<<< HEAD

=======
>>>>>>> 7b378e7 (add accidentally removed md files)
```bash
python3 -c "import confluent_kafka; print('Setup successful!')"
```

<<<<<<< HEAD
<!-- markdownlint-enable MD029 -->

## Project layout
Expand All @@ -68,6 +90,8 @@ C_INCLUDE_PATH=/path/to/include LIBRARY_PATH=/path/to/lib python -m build
- `examples/` — runnable samples (includes asyncio example)
- `tools/unasync.py` — SR-only sync code generation from async sources

=======
>>>>>>> 7b378e7 (add accidentally removed md files)
## Generate Documentation

Install docs dependencies:
Expand All @@ -92,7 +116,11 @@ python3 setup.py build_sphinx

Documentation will be generated in `build/sphinx/html`.

<<<<<<< HEAD
## Unasync — maintaining sync versions of async code (Schema Registry only)
=======
## Unasync -- maintaining sync versions of async code
>>>>>>> 7b378e7 (add accidentally removed md files)

```bash
python3 tools/unasync.py
Expand All @@ -101,6 +129,7 @@ python3 tools/unasync.py
python3 tools/unasync.py --check
```

<<<<<<< HEAD
If you make any changes to the async code (in `src/confluent_kafka/schema_registry/_async` and `tests/integration/schema_registry/_async`), you **must** run this script to generate the sync counterparts (in `src/confluent_kafka/schema_registry/_sync` and `tests/integration/schema_registry/_sync`). Otherwise, this script will be run in CI with the `--check` flag and fail the build.

Note: The AsyncIO Producer/Consumer under `src/confluent_kafka/experimental/aio/` are first-class asyncio implementations and are not generated using `unasync`.
Expand Down Expand Up @@ -183,3 +212,12 @@ See “Generate Documentation” above; ensure examples and code blocks compile

- Build errors related to librdkafka: ensure headers and libraries are discoverable; see “Install librdkafka” above for `C_INCLUDE_PATH` and `LIBRARY_PATH`.
- Async tests hanging: check event loop usage and that `await producer.close()` is called to stop background tasks.
=======
If you make any changes to the async code (in `src/confluent_kafka/schema_registry/_async` and `tests/integration/schema_registry/_async`), you **must** run this script to generate the sync counter parts (in `src/confluent_kafka/schema_registry/_sync` and `tests/integration/schema_registry/_sync`). Otherwise, this script will be run in CI with the --check flag and fail the build.


## Tests


See [tests/README.md](tests/README.md) for instructions on how to run tests.
>>>>>>> 7b378e7 (add accidentally removed md files)
Loading