Skip to content

Commit b684504

Browse files
author
FirstUnicorn
committed
docs(rename): update all URLs and references from python-eventing to messagekit
## Starting point: stale references after rename and PyPI publish After renaming the GitHub repo, creating the new RTD project, and publishing to PyPI as messagekit, documentation and config files still referenced the old python-eventing name and python-eventing.readthedocs.io URLs. ## Changes ### pyproject.toml metadata - Added author, license, keywords, classifiers, documentation URL - Updated homepage/repository URLs to github.com/firstunicorn/messagekit ### README.md (13 replacements) - All ReadTheDocs URLs from python-eventing.readthedocs.io to messagekit.readthedocs.io - GitHub URLs already updated in prior commit ### docs/ (10 files) - All ReadTheDocs URLs across dlq-handlers, consumer-transactions, transactional-outbox, cross-service-communication - All prose references to python-eventing in integration-guide, troubleshooting, event-catalog, quickstart-docker-kafka, deployment README - Updated install commands in integration-guide to pip install messagekit ### Other files - docker-compose.yml: comment header - scripts/tests/e2e/run_e2e_test.py: docstring - scripts/tests/e2e/README.md: title ## Result Zero python-eventing references remain in active code/docs. Only frozen history (.specstory/, .cursor/plans/, memories/) retains old names.
1 parent 5230c7e commit b684504

13 files changed

Lines changed: 39 additions & 40 deletions

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Eventing
22

3-
[Documentation Status](https://python-eventing.readthedocs.io/en/latest/?badge=latest)
3+
[Documentation Status](https://messagekit.readthedocs.io/en/latest/?badge=latest)
44
[Tests](https://github.com/firstunicorn/messagekit/actions)
55
[Python](https://www.python.org/downloads/)
66
[License](LICENSE)
@@ -21,7 +21,7 @@
2121

2222
Package-first universal event infrastructure for microservices.
2323

24-
📚 **[Full Documentation](https://python-eventing.readthedocs.io/en/latest/)** - Comprehensive guides and API reference
24+
📚 **[Full Documentation](https://messagekit.readthedocs.io/en/latest/)** - Comprehensive guides and API reference
2525

2626
## Installation
2727

@@ -102,18 +102,18 @@ Support scale: `❌` none, `✅` basic, `✅✅` strong, `✅✅✅` first-class
102102

103103
## Documentation
104104

105-
📖 **[Integration Guide](https://python-eventing.readthedocs.io/en/latest/integration-guide.html)** - Step-by-step integration instructions
105+
📖 **[Integration Guide](https://messagekit.readthedocs.io/en/latest/integration-guide.html)** - Step-by-step integration instructions
106106

107-
🔍 **[API Reference](https://python-eventing.readthedocs.io/en/latest/autoapi/index.html)** - Complete API documentation
107+
🔍 **[API Reference](https://messagekit.readthedocs.io/en/latest/autoapi/index.html)** - Complete API documentation
108108

109-
📋 **[Event Catalog](https://python-eventing.readthedocs.io/en/latest/event-catalog.html)** - Available event types and contracts
109+
📋 **[Event Catalog](https://messagekit.readthedocs.io/en/latest/event-catalog.html)** - Available event types and contracts
110110

111111
### Key topics
112112

113-
- [Transactional Outbox Pattern](https://python-eventing.readthedocs.io/en/latest/transactional-outbox.html) - Guaranteed event delivery (PRIMARY)
114-
- [Cross-Service Communication](https://python-eventing.readthedocs.io/en/latest/cross-service-communication.html) - Database isolation, Kafka/RabbitMQ architecture, production deployment
115-
- [Idempotent Consumers](https://python-eventing.readthedocs.io/en/latest/consumer-transactions.html) - Duplicate message handling
116-
- [Health Checks](https://python-eventing.readthedocs.io/en/latest/autoapi/eventing/infrastructure/health/index.html) - Monitoring outbox and broker status
113+
- [Transactional Outbox Pattern](https://messagekit.readthedocs.io/en/latest/transactional-outbox.html) - Guaranteed event delivery (PRIMARY)
114+
- [Cross-Service Communication](https://messagekit.readthedocs.io/en/latest/cross-service-communication.html) - Database isolation, Kafka/RabbitMQ architecture, production deployment
115+
- [Idempotent Consumers](https://messagekit.readthedocs.io/en/latest/consumer-transactions.html) - Duplicate message handling
116+
- [Health Checks](https://messagekit.readthedocs.io/en/latest/autoapi/eventing/infrastructure/health/index.html) - Monitoring outbox and broker status
117117

118118
**Architecture note**: This package handles the **write side** of the outbox pattern (persisting events transactionally with business data). **Publishing** is delegated to Kafka Connect with Debezium CDC, which captures outbox table changes and publishes to Kafka. The **bridge component** (part of standard architecture) forwards events from Kafka to RabbitMQ for services preferring AMQP. Dead letter handling leverages native broker mechanisms (RabbitMQ DLX, Kafka Connect DLQ SMT) with a minimal bookkeeping consumer to maintain database failed-event flags.
119119

@@ -196,7 +196,7 @@ flowchart LR
196196
- **Publish Phase**: ✅ At-least-once (CDC retries on failure)
197197
- **Consume Phase**: ✅ Exactly-once (idempotency via processed message store in consumer's database)
198198

199-
📖 **[Cross-Service Communication Guide](https://python-eventing.readthedocs.io/en/latest/cross-service-communication.html)** - Detailed explanation with production deployment patterns
199+
📖 **[Cross-Service Communication Guide](https://messagekit.readthedocs.io/en/latest/cross-service-communication.html)** - Detailed explanation with production deployment patterns
200200

201201
### Database isolation and event flow
202202

@@ -465,7 +465,7 @@ async def startup():
465465
app.state.event_bus = event_bus
466466
```
467467

468-
**CDC Publishing:** Kafka Connect with Debezium CDC automatically detects outbox table changes and publishes to Kafka. See [`debezium-cdc-architecture.md`](https://python-eventing.readthedocs.io/en/latest/debezium-cdc-architecture.html) for configuration.
468+
**CDC Publishing:** Kafka Connect with Debezium CDC automatically detects outbox table changes and publishes to Kafka. See [`debezium-cdc-architecture.md`](https://messagekit.readthedocs.io/en/latest/debezium-cdc-architecture.html) for configuration.
469469

470470
## Quick Start: Transactional Outbox
471471

docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
version: '3.8'
22

3-
# Docker Compose for python-eventing + Kafka local development
3+
# Docker Compose for messagekit + Kafka local development
44

55
networks:
66
eventing-network:

docs/deployment/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Deployment Documentation
22

3-
Guide for running python-eventing with Kafka infrastructure.
3+
Guide for running messagekit with Kafka infrastructure.
44

55
## Quick start
66

77
[quickstart-docker-kafka.md](./quickstart-docker-kafka.md) - Complete setup with Docker Compose
88

99
## Two Publishing Patterns
1010

11-
python-eventing supports two approaches:
11+
messagekit supports two approaches:
1212

1313
1. **Direct Publishing** - Publish events directly to Kafka (simpler, Kafka only)
1414
2. **Transactional Outbox** - Write to DB, CDC publishes to Kafka (robust, requires PostgreSQL + Kafka Connect)

docs/deployment/quickstart-docker-kafka.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Quick Start: python-eventing with Docker Kafka
1+
# Quick Start: messagekit with Docker Kafka
22

3-
Get python-eventing running with Docker Kafka.
3+
Get messagekit running with Docker Kafka.
44

55
## Prerequisites
66

@@ -10,7 +10,7 @@ Get python-eventing running with Docker Kafka.
1010

1111
## Two Publishing Patterns
1212

13-
python-eventing supports two approaches:
13+
messagekit supports two approaches:
1414

1515
### 1. Direct Publishing (simpler)
1616
Publish events directly to Kafka - no database, no CDC needed.
@@ -99,10 +99,10 @@ Wait for health checks (~30 seconds):
9999
docker-compose ps
100100
```
101101

102-
### 3. Install python-eventing
102+
### 3. Install messagekit
103103

104104
```bash
105-
pip install python-eventing faststream[kafka]
105+
pip install messagekit faststream[kafka]
106106

107107
# For transactional outbox, also install:
108108
pip install sqlalchemy asyncpg
@@ -133,7 +133,7 @@ For transactional outbox pattern, configure Debezium CDC connector. This tells K
133133
| `database.password` | `postgres` | From docker-compose.yml `POSTGRES_PASSWORD` |
134134
| `database.dbname` | `eventing` | From docker-compose.yml `POSTGRES_DB` |
135135
| `database.server.name` | `myapp` | Arbitrary logical name (choose any) |
136-
| `table.include.list` | `public.outbox_events` | Table name from python-eventing ORM model |
136+
| `table.include.list` | `public.outbox_events` | Table name from messagekit ORM model |
137137

138138
**Create the connector:**
139139

@@ -219,4 +219,4 @@ curl http://localhost:8083/connectors/outbox-connector/status
219219

220220
- [docker-compose.yml](../../docker-compose.yml) - Infrastructure definition
221221
- [.env.example](../../.env.example) - Configuration template
222-
- python-eventing docs: https://python-eventing.readthedocs.io/
222+
- messagekit docs: https://messagekit.readthedocs.io/

docs/source/consumer-transactions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Consumer transaction management guide
22

3-
**API Reference:** [IdempotentConsumerBase](https://python-eventing.readthedocs.io/en/latest/autoapi/messagekit/infrastructure/messaging/kafka_consumer_base/index.html)
3+
**API Reference:** [IdempotentConsumerBase](https://messagekit.readthedocs.io/en/latest/autoapi/messagekit/infrastructure/messaging/kafka_consumer_base/index.html)
44

5-
**Integration Guide:** [Consume idempotently](https://python-eventing.readthedocs.io/en/latest/integration-guide.html#consume-idempotently)
5+
**Integration Guide:** [Consume idempotently](https://messagekit.readthedocs.io/en/latest/integration-guide.html#consume-idempotently)
66

77
## Overview
88

docs/source/cross-service-communication.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Overview
44

5-
`python-eventing` enables reliable event-driven communication between microservices following the **database-per-service** pattern. Each service maintains its own PostgreSQL database and communicates via shared Kafka infrastructure.
5+
`messagekit` enables reliable event-driven communication between microservices following the **database-per-service** pattern. Each service maintains its own PostgreSQL database and communicates via shared Kafka infrastructure.
66

77
## Architecture principle: Database isolation
88

@@ -369,7 +369,7 @@ All services on the **same Docker network** enable automatic service discovery v
369369

370370
### Configuration via environment variables
371371

372-
Each service configures `python-eventing` via environment variables (read by Pydantic Settings):
372+
Each service configures `messagekit` via environment variables (read by Pydantic Settings):
373373

374374
**Service A (Producer):**
375375
```ini
@@ -548,7 +548,7 @@ async with session.begin():
548548

549549
## See also
550550

551-
- {doc}`integration-guide` - How to integrate `python-eventing` in your service
551+
- {doc}`integration-guide` - How to integrate `messagekit` in your service
552552
- {doc}`transactional-outbox` - Outbox pattern details
553553
- {doc}`consumer-transactions` - Idempotent consumer pattern
554554
- {doc}`dlq-handlers` - Dead letter queue handling

docs/source/dlq-handlers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Dead letter queue (DLQ) handler guide
22

3-
**API Reference:** [Universal DLQ Handler](https://python-eventing.readthedocs.io/en/latest/autoapi/messagekit/infrastructure/messaging/index.html) | [Kafka DLQ Handler](https://python-eventing.readthedocs.io/en/latest/autoapi/messagekit/infrastructure/messaging/kafka/index.html)
3+
**API Reference:** [Universal DLQ Handler](https://messagekit.readthedocs.io/en/latest/autoapi/messagekit/infrastructure/messaging/index.html) | [Kafka DLQ Handler](https://messagekit.readthedocs.io/en/latest/autoapi/messagekit/infrastructure/messaging/kafka/index.html)
44

55
## Overview
66

docs/source/event-catalog.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ events and services against TOML registries:
5252

5353
**Your organization's catalog repository structure:**
5454

55-
This is the structure for your own centralized event catalog Git repository (not part of the `python-eventing` library):
55+
This is the structure for your own centralized event catalog Git repository (not part of the `messagekit` library):
5656

5757
```
5858
your-event-catalog/
@@ -80,7 +80,7 @@ events_published = ["orders.order.created"]
8080

8181
## Published domain event examples
8282

83-
> **Note:** The events below are purely illustrative examples. The `python-eventing` library does *not* contain any hardcoded business payloads or domains (like gamification).
83+
> **Note:** The events below are purely illustrative examples. The `messagekit` library does *not* contain any hardcoded business payloads or domains (like gamification).
8484
8585
The eventing service does not define producer-specific business payloads.
8686
Instead, it provides the reusable base contract that other services extend. The

docs/source/integration-guide.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Integration guide
22

3-
Use the `python-eventing` package when a domain service needs both local
3+
Use the `messagekit` package when a domain service needs both local
44
in-process dispatch and reliable cross-service publication.
55

66
**For detailed cross-service architecture:** See {doc}`cross-service-communication` for database isolation patterns, Kafka/RabbitMQ architecture, and production deployment examples.
@@ -12,19 +12,18 @@ Add to your project's `pyproject.toml`:
1212
```toml
1313
[tool.poetry.dependencies]
1414
python = "^3.12"
15-
python-eventing = "^0.1.0"
15+
messagekit = "^0.1.0"
1616
```
1717

1818
Or install directly:
1919

2020
```bash
21-
pip install python-eventing
21+
pip install messagekit
2222
# or
23-
poetry add python-eventing
23+
poetry add messagekit
2424
```
2525

26-
The published distribution name is `python-eventing`, while Python imports use
27-
`from messagekit ...` (not `eventing`).
26+
The distribution and import name is `messagekit`:
2827

2928
## Add a new event schema
3029

docs/source/transactional-outbox.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Transactional outbox pattern - usage guide
22

3-
**Full documentation:** [Integration Guide - Publish through the outbox](https://python-eventing.readthedocs.io/en/latest/integration-guide.html#publish-through-the-outbox)
3+
**Full documentation:** [Integration Guide - Publish through the outbox](https://messagekit.readthedocs.io/en/latest/integration-guide.html#publish-through-the-outbox)
44

55
## Overview
66

0 commit comments

Comments
 (0)