Merge remote-tracking branch 'origin/main' into add-is-eventql-true-precondition

Author: matthiasharzer

.editorconfig

@@ -3,11 +3,11 @@ root = true
 [*]
 charset = utf-8
 end_of_line = lf
-indent_size = 2
-indent_style = tab
 insert_final_newline = true
-tab_width = 2
 trim_trailing_whitespace = true
+indent_style = tab
+indent_size = 2
+tab_width = 2
 
 [*.py]
 indent_style = space

.github/workflows/qa.yml

@@ -21,7 +21,8 @@ jobs:
         python-version: ${{ matrix.version }}
     - name: Install dependencies
       run: |
-        pip install poetry
-        poetry install
+        curl --location --silent --show-error --fail https://astral.sh/uv/install.sh | sh
+        export PATH="$HOME/.local/bin:$PATH"
+        uv sync --dev
     - name: Run QA
       run: make qa

.github/workflows/release.yml

@@ -27,17 +27,14 @@ jobs:
         python-version: '3.13'
     - name: Install dependencies
       run: |
-        # First install Poetry in latest version, then install
-        # build and twine in matching versions. The following
-        # commands should not be run in a single line.
-        pip install poetry
-        pip install build twine
-        poetry install
+        curl --location --silent --show-error --fail https://astral.sh/uv/install.sh | sh
+        export PATH="$HOME/.local/bin:$PATH"
+        uv sync --dev
     - name: Run QA
       run: make qa
     - name: Get next version
       id: get_next_version
-      uses: thenativeweb/get-next-version@2.6.3
+      uses: thenativeweb/get-next-version@2.7.1
     - name: Create new version
       if: ${{ steps.get_next_version.outputs.hasNextVersion == 'true' }}
       run: |
@@ -52,11 +49,11 @@ jobs:
     - name: Build package
       if: ${{ steps.get_next_version.outputs.hasNextVersion == 'true' }}
       run: |
-        python -m build
+        uv build
     - name: Publish package
       if: ${{ steps.get_next_version.outputs.hasNextVersion == 'true' }}
       env:
         TWINE_USERNAME: __token__
         TWINE_PASSWORD: ${{ secrets.TOKEN_GITHUB_TO_PYPI_RW }}
       run: |
-        twine upload dist/*
+        uv run twine upload dist/*

.gitignore

@@ -1,5 +1,35 @@
 # Python folders
 __pycache__/
+*.pyc
+*.pyo
+*.pyd
+*.egg-info/
+*.egg/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.pytype/
+
+# Package managers
+.uv/
+__pypackages__/
+pip-wheel-metadata/
+
+# Virtual environments
+venv/
+env/
+.venv/
+.env/
+
+# Build and distribution
+build/
+dist/
+
+# Testing and coverage
+.coverage
+.coverage.*
+htmlcov/
+.tox/
 
 # OS generated files and folders
 .DS_Store

.pylintrc

@@ -1,19 +1,64 @@
-qa: analyze test
+PACKAGE := eventsourcingdb
+TEST_DIR := tests
+PYTHON_DIRS := $(PACKAGE) $(TEST_DIR)
+
+qa: analyze typecheck security test 
 
 analyze:
-	@poetry run pylint eventsourcingdb tests
+	@echo "Running code analysis..."
+	@uv run ruff check $(PYTHON_DIRS)
+
+build: qa clean
+	@echo "Build prepared."
+
+clean:
+	@echo "Cleaning up..."
+	@find . -type d -name __pycache__ -exec rm -rf {} +
+	@find . -type f -name "*.pyc" -delete
+	@find . -type f -name "*.pyo" -delete
+	@find . -type f -name "*.pyd" -delete
+	@find . -type f -name ".coverage" -delete
+	@find . -type d -name "*.egg-info" -exec rm -rf {} +
+	@find . -type d -name "*.egg" -exec rm -rf {} +
+	@find . -type d -name ".pytest_cache" -exec rm -rf {} +
+	@find . -type d -name ".mypy_cache" -exec rm -rf {} +
+	@find . -type d -name ".pyright" -exec rm -rf {} +
+	@find . -type d -name ".ruff_cache" -exec rm -rf {} +
+	@rm -rf build/ dist/ .coverage htmlcov/ .venv/
+
+coverage:
+	@echo "Checking test coverage..."
+	@uv run pytest --cov=$(PACKAGE) --cov-report=term-missing $(TEST_DIR)
 
 format:
-	@poetry run autopep8 --in-place --aggressive --max-line-length=100 --recursive eventsourcingdb tests
-	
+	@echo "Formatting code..."
+	@uv run ruff format $(PYTHON_DIRS)
+
 lock:
-	@poetry lock 
+	@echo "Updating dependency lock..."
+	@uv run uv lock
 
-test:
-	@poetry run pytest --maxfail=1
+security:
+	@echo "Running security checks..."
+	@uv run bandit -r $(PACKAGE) -c pyproject.toml
 
-clean:
+test:
+	@echo "Running tests..."
+	@uv run pytest --maxfail=1
 
-build: qa clean
+typecheck:
+	@uv add pyright --dev
+	@echo "Running type checking..."
+	@uv run pyright $(PACKAGE)
 
-.PHONY: analyze build clean format lock qa test
+.PHONY: analyze \
+		build \
+		coverage \
+		format \
+		help \
+		lock \
+		qa \
+		security \
+		test \
+		typecheck \
+		clean

Makefile

@@ -530,4 +530,4 @@ In case you need to set up the client yourself, use the following functions to g
 - `get_host()` returns the host name
 - `get_mapped_port()` returns the port
 - `get_base_url()` returns the full URL of the container
-- `get_api_token()` returns the API token
+- `get_api_token()` returns the API token

README.md

@@ -1,26 +1,39 @@
 from .bound import Bound, BoundType
 from .client import Client
 from .container import Container
-from .event import Event, EventCandidate
 from .errors import ClientError, CustomError, InternalError, ServerError, ValidationError
+from .event import Event, EventCandidate
 from .observe_events import (
+    IfEventIsMissingDuringObserve,
     ObserveEventsOptions,
     ObserveFromLatestEvent,
-    IfEventIsMissingDuringObserve
 )
-from .read_events import ReadEventsOptions, ReadFromLatestEvent, IfEventIsMissingDuringRead, Order
 from .read_event_types import EventType
-from .write_events import Precondition, IsSubjectOnEventId, IsSubjectPristine, IsEventQlTrue
-
+from .read_events import IfEventIsMissingDuringRead, Order, ReadEventsOptions, ReadFromLatestEvent
+from .write_events import IsEventQlTrue, IsSubjectOnEventId, IsSubjectPristine, Precondition
 
 __all__ = [
-    'Bound', 'BoundType',
-    'Client',
-    'Container',
-    'Event', 'EventCandidate',
-    'EventType',
-    'ObserveEventsOptions', 'ObserveFromLatestEvent', 'IfEventIsMissingDuringObserve',
-    'Precondition', 'IsSubjectOnEventId', 'IsSubjectPristine', 'IsEventQlTrue',
-    'ReadEventsOptions', 'ReadFromLatestEvent', 'IfEventIsMissingDuringRead', 'Order',
-    'ClientError', 'CustomError', 'InternalError', 'ServerError', 'ValidationError',
+    "Bound",
+    "BoundType",
+    "Client",
+    "ClientError",
+    "Container",
+    "CustomError",
+    "Event",
+    "EventCandidate",
+    "EventType",
+    "IfEventIsMissingDuringObserve",
+    "IfEventIsMissingDuringRead",
+    "InternalError",
+		"IsEventQlTrue",
+    "IsSubjectOnEventId",
+    "IsSubjectPristine",
+    "ObserveEventsOptions",
+    "ObserveFromLatestEvent",
+    "Order",
+    "Precondition",
+    "ReadEventsOptions",
+    "ReadFromLatestEvent",
+    "ServerError",
+    "ValidationError",
 ]

eventsourcingdb/__init__.py

@@ -13,7 +13,4 @@ class Bound:
     type: BoundType
 
     def to_json(self) -> dict[str, str]:
-        return {
-            'id': self.id,
-            'type': self.type.value
-        }
+        return {"id": self.id, "type": self.type.value}

eventsourcingdb/bound.py

@@ -45,12 +45,6 @@ async def __aexit__(
     ) -> None:
         await self.__http_client.__aexit__(exc_type, exc_val, exc_tb)
 
-    async def initialize(self) -> None:
-        await self.__http_client.initialize()
-
-    async def close(self) -> None:
-        await self.__http_client.close()
-
     @property
     def http_client(self) -> HttpClient:
         return self.__http_client
@@ -335,4 +329,4 @@ async def read_event_types(self) -> AsyncGenerator[EventType]:
                 raise ServerError(
                     f'Failed to read event types, an unexpected '
                     f'stream item was received \'{message}\'.'
-                )
+                )