Rebranded to "KurrentDB".

Author: johnbywater

.github/workflows/github-actions.yml

@@ -11,13 +11,13 @@ jobs:
       fail-fast: false
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
-        eventstore-docker-image:
+        docker-image:
             - docker.eventstore.com/eventstore-ce/eventstoredb-ce:22.10.4-jammy
             - docker.eventstore.com/eventstore-ce/eventstoredb-oss:23.10.2-jammy
             - docker.eventstore.com/eventstore/eventstoredb-ee:24.10.0-x64-8.0-bookworm-slim
             - docker.eventstore.com/kurrent-latest/kurrentdb:25.0.0-x64-8.0-bookworm-slim
     env:
-      EVENTSTORE_DOCKER_IMAGE: ${{ matrix.eventstore-docker-image }}
+      DOCKER_IMAGE: ${{ matrix.docker-image }}
     runs-on: "ubuntu-22.04"
     steps:
       - uses: actions/checkout@v3
@@ -28,8 +28,8 @@ jobs:
         run: make install-poetry
       - name: Install packages
         run: make install
-      - name: Start EventStoreDB
-        run: make start-eventstoredb
+      - name: Start KurrentDB
+        run: make start-kurrentdb
       - name: Lint
         run: make lint
       - name: Test

Makefile

@@ -1,8 +1,8 @@
 .EXPORT_ALL_VARIABLES:
 
-# EVENTSTORE_DOCKER_IMAGE ?= eventstore/eventstore:23.10.0-bookworm-slim
-#EVENTSTORE_DOCKER_IMAGE ?= docker.eventstore.com/eventstore/eventstoredb-ee:24.10.0-x64-8.0-bookworm-slim
-EVENTSTORE_DOCKER_IMAGE ?= docker.eventstore.com/kurrent-latest/kurrentdb:25.0.0-x64-8.0-bookworm-slim
+# DOCKER_IMAGE ?= eventstore/eventstore:23.10.0-bookworm-slim
+#DOCKER_IMAGE ?= docker.eventstore.com/eventstore/eventstoredb-ee:24.10.0-x64-8.0-bookworm-slim
+DOCKER_IMAGE ?= docker.eventstore.com/kurrent-latest/kurrentdb:25.0.0-x64-8.0-bookworm-slim
 
 PYTHONUNBUFFERED=1
 
@@ -80,55 +80,55 @@ build:
 publish:
 	$(POETRY) publish
 
-.PHONY: start-eventstoredb-insecure
-start-eventstoredb-insecure:
+.PHONY: start-kurrentdb-insecure
+start-kurrentdb-insecure:
 	docker run -d -i -t -p 2113:2113 \
     --env "EVENTSTORE_ALLOW_UNKNOWN_OPTIONS=true" \
     --env "EVENTSTORE_ADVERTISE_HOST_TO_CLIENT_AS=localhost" \
     --env "EVENTSTORE_ADVERTISE_HOST_PORT_TO_CLIENT_AS=2113" \
     --env "EVENTSTORE_ADVERTISE_HTTP_PORT_TO_CLIENT_AS=2113" \
-    --name my-eventstoredb-insecure \
-    $(EVENTSTORE_DOCKER_IMAGE) \
+    --name my-kurrentdb-insecure \
+    $(DOCKER_IMAGE) \
     --insecure \
     --enable-atom-pub-over-http
 
-.PHONY: start-eventstoredb-secure
-start-eventstoredb-secure:
+.PHONY: start-kurrentdb-secure
+start-kurrentdb-secure:
 	docker run -d -i -t -p 2114:2113 \
     --env "HOME=/tmp" \
     --env "EVENTSTORE_ALLOW_UNKNOWN_OPTIONS=true" \
     --env "EVENTSTORE_ADVERTISE_HOST_TO_CLIENT_AS=localhost" \
     --env "EVENTSTORE_ADVERTISE_HOST_PORT_TO_CLIENT_AS=2114" \
     --env "EVENTSTORE_ADVERTISE_HTTP_PORT_TO_CLIENT_AS=2114" \
-    --name my-eventstoredb-secure \
-    $(EVENTSTORE_DOCKER_IMAGE) \
+    --name my-kurrentdb-secure \
+    $(DOCKER_IMAGE) \
     --dev
 
-.PHONY: attach-eventstoredb-insecure
-attach-eventstoredb-insecure:
-	docker exec -it my-eventstoredb-insecure /bin/bash
+.PHONY: attach-kurrentdb-insecure
+attach-kurrentdb-insecure:
+	docker exec -it my-kurrentdb-insecure /bin/bash
 
-.PHONY: attach-eventstoredb-secure
-attach-eventstoredb-secure:
-	docker exec -it my-eventstoredb-secure /bin/bash
+.PHONY: attach-kurrentdb-secure
+attach-kurrentdb-secure:
+	docker exec -it my-kurrentdb-secure /bin/bash
 
-.PHONY: stop-eventstoredb-insecure
-stop-eventstoredb-insecure:
-	docker stop my-eventstoredb-insecure
-	docker rm my-eventstoredb-insecure
+.PHONY: stop-kurrentdb-insecure
+stop-kurrentdb-insecure:
+	docker stop my-kurrentdb-insecure
+	docker rm my-kurrentdb-insecure
 
-.PHONY: stop-eventstoredb-secure
-stop-eventstoredb-secure:
-	docker stop my-eventstoredb-secure
-	docker rm my-eventstoredb-secure
+.PHONY: stop-kurrentdb-secure
+stop-kurrentdb-secure:
+	docker stop my-kurrentdb-secure
+	docker rm my-kurrentdb-secure
 
-.PHONY: start-eventstoredb
-start-eventstoredb: start-eventstoredb-insecure start-eventstoredb-secure
+.PHONY: start-kurrentdb
+start-kurrentdb: start-kurrentdb-insecure start-kurrentdb-secure
 	@echo "Waiting for containers to be healthy"
-	@until docker ps | grep "my-eventstoredb" | grep -in "healthy" | wc -l | grep -in 2 > /dev/null; do printf "." && sleep 1; done; echo ""
+	@until docker ps | grep "my-kurrentdb" | grep -in "healthy" | wc -l | grep -in 2 > /dev/null; do printf "." && sleep 1; done; echo ""
 	@docker ps
 	@sleep 15
 
 
-.PHONY: stop-eventstoredb
-stop-eventstoredb: stop-eventstoredb-insecure stop-eventstoredb-secure
+.PHONY: stop-kurrentdb
+stop-kurrentdb: stop-kurrentdb-insecure stop-kurrentdb-secure

README.md

@@ -1,28 +1,28 @@
-Please note: following the rebranding of EventStoreDB to KurrentDB, this package has
-been rebranded as [`eventsourcing-kurrentdb`](https://pypi.org/project/eventsourcing-kurrentdb). Please
+Please note: following the rebranding of EventStoreDB to KurrentDB, this package is
+the rebranding of [`eventsourcing-eventstoredb`](https://pypi.org/project/eventsourcing-eventstoredb). Please
 migrate your code to use the [`eventsourcing-kurrentdb`](https://pypi.org/project/eventsourcing-kurrentdb)
 package when you are ready.
 
 # Event Sourcing in Python with KurrentDB
 
 This is an extension package for the Python [eventsourcing](https://github.com/pyeventsourcing/eventsourcing) library
-that provides a persistence module for [EventStoreDB and KurrentDB](https://www.kurrent.io).
+that provides a persistence module for [KurrentDB](https://www.kurrent.io).
 It uses the [kurrentdbclient](https://github.com/pyeventsourcing/kurrentdbclient)
-package to communicate with EventStoreDB and KurrentDB via the gRPC interface.
+package to communicate with KurrentDB via the gRPC interface.
 
 ## Installation
 
-Use pip to install the [stable distribution](https://pypi.org/project/eventsourcing-eventstoredb/)
+Use pip to install the [stable distribution](https://pypi.org/project/eventsourcing-kurrentdb/)
 from the Python Package Index.
 
-    $ pip install eventsourcing-eventstoredb
+    $ pip install eventsourcing-kurrentdb
 
 Please note, it is recommended to install Python packages into a Python virtual environment.
 
 ## Getting started
 
 Define aggregates and applications in the usual way. Please note, "streams"
-in EventStoreDB and KurrentDB are constrained to start from position `0`, and this
+in KurrentDB are constrained to start from position `0`, and this
 package expects the `originator_version` of the first event in an aggregate sequence
 to be `0`, so you must set `INITIAL_VERSION` on your aggregate classes to `0`.
 
@@ -58,7 +58,7 @@ class TrainingSchool(Application):
 
 
 class Dog(Aggregate):
-    INITIAL_VERSION = 0  # for EventStoreDB and KurrentDB
+    INITIAL_VERSION = 0  # for KurrentDB
 
     @staticmethod
     def create_id(name: str):
@@ -79,43 +79,43 @@ class DogDetails(TypedDict):
     tricks: Tuple[str, ...]
 ```
 
-Configure the `TrainingSchool` application to use EventStoreDB or KurrentDB by setting
-the environment variable `PERSISTENCE_MODULE` to `'eventsourcing_eventstoredb'`. You
+Configure the `TrainingSchool` application to use KurrentDB by setting
+the environment variable `PERSISTENCE_MODULE` to `'eventsourcing_kurrentdb'`. You
 can do this in actual environment variables, or by passing in an `env` argument when
 constructing  the application object, or by setting `env` on the application class.
 
 ```python
 import os
 
-os.environ['TRAININGSCHOOL_PERSISTENCE_MODULE'] = 'eventsourcing_eventstoredb'
+os.environ['TRAININGSCHOOL_PERSISTENCE_MODULE'] = 'eventsourcing_kurrentdb'
 ```
 
-Also set environment variable `EVENTSTOREDB_URI` to an EventStoreDB
-or KurrentDB connection string URI. This value will be used as the `uri`
-argument when the `KurrentDBClient` class is constructed by this package.
+Also set environment variable `KURRENTDB_URI` to an KurrentDB connection
+string URI. This value will be used as the `uri` argument when the `KurrentDBClient`
+class is constructed by this package.
 
 ```python
-os.environ['EVENTSTOREDB_URI'] = 'esdb://localhost:2113?Tls=false'
+os.environ['KURRENTDB_URI'] = 'esdb://localhost:2113?Tls=false'
 ```
 
-If you are connecting to a "secure" EventStoreDB or KurrentDB server, unless
+If you are connecting to a "secure" KurrentDB server, unless
 the root certificate of the certificate authority used to generate the
 server's certificate is installed locally, then also set environment
-variable `EVENTSTOREDB_ROOT_CERTIFICATES` to an SSL/TLS certificate
-suitable for making a secure gRPC connection to the EventStoreDB server(s).
+variable `KURRENTDB_ROOT_CERTIFICATES` to an SSL/TLS certificate
+suitable for making a secure gRPC connection to the KurrentDB server(s).
 This value will be used as the `root_certificates` argument when the
 `KurrentDBClient` class is constructed by this package.
 
 
 ```python
-os.environ['EVENTSTOREDB_ROOT_CERTIFICATES'] = '<PEM encoded SSL/TLS root certificates>'
+os.environ['KURRENTDB_ROOT_CERTIFICATES'] = '<PEM encoded SSL/TLS root certificates>'
 ```
 
 Please refer to the [kurrentdbclient](https://github.com/pyeventsourcing/kurrentdbclient)
-documentation for details about starting a "secure" or "insecure" EventStoreDB
-server, and the "esdb" and "esdb+discover" EventStoreDB connection string
+documentation for details about starting a "secure" or "insecure" KurrentDB
+server, and the "kdb" and "kdb+discover" KurrentDB connection string
 URI schemes, and how to obtain a suitable SSL/TLS certificate for use
-in the client when connecting to a "secure" EventStoreDB server.
+in the client when connecting to a "secure" KurrentDB server.
 
 Construct the application.
 
@@ -357,10 +357,6 @@ from the [Python website](https://www.python.org/downloads/).
 Once project dependencies have been installed, you should be able to run tests
 from within PyCharm (right-click on the `tests` folder and select the 'Run' option).
 
-Because of a conflict between pytest and PyCharm's debugger and the coverage tool,
-you may need to add ``--no-cov`` as an option to the test runner template. Alternatively,
-just use the Python Standard Library's ``unittest`` module.
-
 You should also be able to open a terminal window in PyCharm, and run the project's
 Makefile commands from the command line (see below).
 
@@ -387,17 +383,17 @@ and creating the Poetry virtual environment using PyCharm (see above).
 
 ### Project Makefile commands
 
-You can start EventStoreDB using the following command.
+You can start KurrentDB using the following command.
 
-    $ make start-eventstoredb
+    $ make start-kurrentdb
 
-You can run tests using the following command (needs EventStoreDB to be running).
+You can run tests using the following command (needs KurrentDB to be running).
 
     $ make test
 
-You can stop EventStoreDB using the following command.
+You can stop KurrentDB using the following command.
 
-    $ make stop-eventstoredb
+    $ make stop-kurrentdb
 
 You can check the formatting of the code using the following command.
 
@@ -407,7 +403,7 @@ You can reformat the code using the following command.
 
     $ make fmt
 
-Tests belong in `./tests`. Code-under-test belongs in `./eventsourcing_eventstoredb`.
+Tests belong in `./tests`. Code-under-test belongs in `./eventsourcing_kurrentdb`.
 
 Edit package dependencies in `pyproject.toml`. Update `poetry.lock` and installed packages
 using the following command.

eventsourcing_eventstoredb/__init__.py

@@ -0,0 +1,3 @@
+from .factory import KurrentDBFactory
+
+__all__ = ["KurrentDBFactory"]

eventsourcing_kurrentdb/__init__.py

@@ -12,47 +12,47 @@
 )
 from kurrentdbclient import KurrentDBClient
 
-from eventsourcing_eventstoredb.recorders import (
-    EventStoreDBAggregateRecorder,
-    EventStoreDBApplicationRecorder,
+from eventsourcing_kurrentdb.recorders import (
+    KurrentDBAggregateRecorder,
+    KurrentDBApplicationRecorder,
 )
 
 if TYPE_CHECKING:
     from eventsourcing.utils import Environment
 
 
-class EventStoreDBFactory(InfrastructureFactory[TrackingRecorder]):
+class KurrentDBFactory(InfrastructureFactory[TrackingRecorder]):
     """
-    Infrastructure factory for EventStoreDB infrastructure.
+    Infrastructure factory for KurrentDB infrastructure.
     """
 
-    EVENTSTOREDB_URI = "EVENTSTOREDB_URI"
-    EVENTSTOREDB_ROOT_CERTIFICATES = "EVENTSTOREDB_ROOT_CERTIFICATES"
+    KURRENTDB_URI = "KURRENTDB_URI"
+    KURRENTDB_ROOT_CERTIFICATES = "KURRENTDB_ROOT_CERTIFICATES"
 
     def __init__(self, env: Environment):
         super().__init__(env)
-        eventstoredb_uri = self.env.get(self.EVENTSTOREDB_URI)
+        eventstoredb_uri = self.env.get(self.KURRENTDB_URI)
         if eventstoredb_uri is None:
             msg = (
-                f"{self.EVENTSTOREDB_URI!r} not found "
+                f"{self.KURRENTDB_URI!r} not found "
                 "in environment with keys: "
-                f"{', '.join(self.env.create_keys(self.EVENTSTOREDB_URI))!r}"
+                f"{', '.join(self.env.create_keys(self.KURRENTDB_URI))!r}"
             )
             raise InfrastructureFactoryError(msg)
-        root_certificates = self.env.get(self.EVENTSTOREDB_ROOT_CERTIFICATES)
+        root_certificates = self.env.get(self.KURRENTDB_ROOT_CERTIFICATES)
         self.client = KurrentDBClient(
             uri=eventstoredb_uri,
             root_certificates=root_certificates,
         )
 
     def aggregate_recorder(self, purpose: str = "events") -> AggregateRecorder:
-        return EventStoreDBAggregateRecorder(
+        return KurrentDBAggregateRecorder(
             client=self.client,
             for_snapshotting=bool(purpose == "snapshots"),
         )
 
     def application_recorder(self) -> ApplicationRecorder:
-        return EventStoreDBApplicationRecorder(self.client)
+        return KurrentDBApplicationRecorder(self.client)
 
     def tracking_recorder(
         self, tracking_recorder_class: type[TrackingRecorder] | None = None

eventsourcing_eventstoredb/factory.py eventsourcing_kurrentdb/factory.pyeventsourcing_eventstoredb/factory.py renamed to eventsourcing_kurrentdb/factory.py

@@ -29,7 +29,7 @@
     from collections.abc import Sequence
 
 
-class EventStoreDBAggregateRecorder(AggregateRecorder):
+class KurrentDBAggregateRecorder(AggregateRecorder):
     SNAPSHOT_STREAM_PREFIX = "snapshot-$"
 
     def __init__(
@@ -74,9 +74,7 @@ def _insert_events(  # noqa: C901
             if len(set_of_originator_ids) == 0:
                 return []
             if len(set_of_originator_ids) > 1:
-                msg = (
-                    "EventStoreDB can't atomically store events in more than one stream"
-                )
+                msg = "KurrentDB can't atomically store events in more than one stream"
                 raise ProgrammingError(msg)
 
             # Make sure stored events have a gapless sequence of originator_versions.
@@ -227,9 +225,7 @@ def _construct_notification(recorded_event: RecordedEvent) -> Notification:
     )
 
 
-class EventStoreDBApplicationRecorder(
-    EventStoreDBAggregateRecorder, ApplicationRecorder
-):
+class KurrentDBApplicationRecorder(KurrentDBAggregateRecorder, ApplicationRecorder):
     def insert_events(
         self, stored_events: list[StoredEvent], **kwargs: Any
     ) -> Sequence[int] | None:
@@ -288,13 +284,13 @@ def max_notification_id(self) -> int | None:
     def subscribe(
         self, gt: int | None = None, topics: Sequence[str] = ()
     ) -> Subscription[ApplicationRecorder]:
-        return EventStoreDBSubscription(recorder=self, gt=gt, topics=topics)
+        return KurrentDBSubscription(recorder=self, gt=gt, topics=topics)
 
 
-class EventStoreDBSubscription(Subscription[EventStoreDBApplicationRecorder]):
+class KurrentDBSubscription(Subscription[KurrentDBApplicationRecorder]):
     def __init__(
         self,
-        recorder: EventStoreDBApplicationRecorder,
+        recorder: KurrentDBApplicationRecorder,
         gt: int | None = None,
         topics: Sequence[str] = (),
     ):

eventsourcing_eventstoredb/py.typed eventsourcing_kurrentdb/py.typedeventsourcing_eventstoredb/py.typed renamed to eventsourcing_kurrentdb/py.typed

@@ -1,6 +1,6 @@
 [mypy]
 python_version = 3.9
-files = eventsourcing_eventstoredb,tests
+files = eventsourcing_kurrentdb,tests
 
 check_untyped_defs = True
 disallow_any_generics = True