datacurrent 1.0.0__tar.gz → 1.0.1__tar.gz

{datacurrent-1.0.0 → datacurrent-1.0.1}/CHANGELOG.md

@@ -4,6 +4,33 @@ All notable changes to DataCurrent are documented here. The format follows
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1] — 2026-11-13
+
+Documentation, metadata and packaging release. The public API is unchanged.
+
+### Added
+
+- `CONTRIBUTING.md`: development setup, the check suite, and the release
+  process, including PyPI trusted publishing.
+- A "Documented examples" section in the README that maps each of the sixteen
+  runnable scripts to the feature it demonstrates.
+- `[project.urls]` in `pyproject.toml`: homepage and repository (GitHub), issues,
+  changelog and PyPI.
+- A GitHub Actions release workflow that publishes to PyPI over OIDC, so
+  uploads carry a signed provenance attestation.
+
+### Fixed
+
+- The FastAPI example documented `uvicorn examples.10_fastapi_integration:app`,
+  which is not a runnable module path. It now shows the verified commands.
+
+### Changed
+
+- README links to the GitHub repository, the PyPI homepage and the examples
+  directory.
+- The "not published to PyPI" note was removed; the package is on PyPI and this
+  is the current release.
+
 ## [1.0.0] — 2026-11-08
 
 First stable release. Built and verified locally; not published to PyPI.

{datacurrent-1.0.0/datacurrent.egg-info → datacurrent-1.0.1}/PKG-INFO

@@ -1,9 +1,14 @@
 Metadata-Version: 2.4
 Name: datacurrent
-Version: 1.0.0
+Version: 1.0.1
 Summary: Python streaming, made simple: async streams, operators, backpressure and real-time transports.
 Author: DataCurrent contributors
 License: MIT
+Project-URL: Homepage, https://github.com/CoderProandTester/datacurrent
+Project-URL: Repository, https://github.com/CoderProandTester/datacurrent
+Project-URL: Issues, https://github.com/CoderProandTester/datacurrent/issues
+Project-URL: Changelog, https://github.com/CoderProandTester/datacurrent/blob/main/CHANGELOG.md
+Project-URL: PyPI, https://pypi.org/project/datacurrent/
 Keywords: streaming,async,asyncio,real-time,data pipeline,stream processing,backpressure,reactive,event bus,pubsub,websocket,server-sent events,http streaming,concurrency,observability,http,https
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: AsyncIO
@@ -52,7 +57,15 @@ DataCurrent is a production-ready asynchronous streaming library. It gives you
 one consistent API for lists, async generators, queues, WebSockets, Server-Sent
 Events and streaming HTTP responses.
 
-**Version 1.0.0 · Stable / Production**
+**Version 1.0.1 · Stable / Production**
+
+[![PyPI version](https://img.shields.io/pypi/v/datacurrent.svg)](https://pypi.org/project/datacurrent/)
+[![Python versions](https://img.shields.io/pypi/pyversions/datacurrent.svg)](https://pypi.org/project/datacurrent/)
+[![GitHub](https://img.shields.io/badge/GitHub-CoderProandTester%2Fdatacurrent-181717)](https://github.com/CoderProandTester/datacurrent)
+
+- **GitHub repository:** <https://github.com/CoderProandTester/datacurrent>
+- **PyPI homepage:** <https://pypi.org/project/datacurrent/>
+- **Examples:** <https://github.com/CoderProandTester/datacurrent/tree/main/examples>
 
 - 279 tests passing, with 100% line and branch coverage.
 - Required networking dependencies install automatically.
@@ -65,7 +78,10 @@ pip install datacurrent
 ```
 
 Python 3.11 or newer is required. `httpx` and `websockets` are installed with the
-package, so HTTP streaming, SSE and WebSocket clients work immediately.
+package, so HTTP streaming, SSE and WebSocket clients work immediately. The
+[`examples/`](https://github.com/CoderProandTester/datacurrent/tree/main/examples)
+directory contains 16 runnable scripts, from a hello-world stream to a WebSocket
+server.
 
 Framework helpers are optional:
 
@@ -224,6 +240,39 @@ stream = Stream.from_factory(connect_and_read).retry(
 Retries require a replayable source, such as a factory or a list. A consumed
 generator raises `NonReplayableStreamError` instead of silently restarting.
 
+## Examples
+
+Sixteen runnable scripts live in [`examples/`](https://github.com/CoderProandTester/datacurrent/tree/main/examples).
+Each one is self-contained and is executed by the test suite, so the output you
+see is the output the project verifies.
+
+```bash
+python examples/01_hello_stream.py
+python -m pytest tests/unit/test_examples.py -q  # run them all
+```
+
+| Script | What it demonstrates |
+|---|---|
+| `01_hello_stream.py` | Creating a stream, iterating it, `tap` and terminal operations |
+| `02_transformations.py` | `filter`, `map`, `distinct`, `batch`, `window`, `reduce`, `enumerate` |
+| `03_large_dataset.py` | 100,000 records streamed in batches with bounded memory |
+| `04_filter_events.py` | `EventBus` wildcard topics and multiple handlers |
+| `05_multi_subscriber.py` | `Channel` fan-out to three independent consumers |
+| `06_websocket_client.py` | `WebSocketStream` JSON send/receive against a local echo server |
+| `07_websocket_server.py` | Broadcasting a `Channel` to connected WebSocket clients |
+| `08_sse_client.py` | `SSEStream` event ids, event types and JSON payloads |
+| `09_http_streaming.py` | `HTTPStream` line iteration and raw body streaming |
+| `10_fastapi_integration.py` | Serving a DataCurrent stream as a FastAPI SSE endpoint |
+| `11_backpressure.py` | Bounded queues, producer suspension and counted drops |
+| `12_concurrent_processing.py` | Bounded concurrency with order preserved |
+| `13_retry_recovery.py` | `RetryPolicy`, `recover` and replayable sources |
+| `14_custom_transport.py` | Implementing `StreamTransport` for a custom protocol |
+| `15_realtime_notifications.py` | Routing one event to WebSocket and email consumers |
+| `16_event_pipeline.py` | End-to-end event filtering, mapping and batching |
+
+`examples/_servers.py` holds the local HTTP/SSE test servers the networking
+examples use; it is not an example itself.
+
 ## Why DataCurrent
 
 - One model for iterables, queues, HTTP, SSE and WebSockets.
@@ -242,8 +291,8 @@ in-process streaming layer that works without any of them.
 
 - Python 3.11+ on asyncio; no Trio or AnyIO backend.
 - In-memory `Channel` and `EventBus` delivery is at most once.
-- No durable broker adapters or OpenTelemetry exporter in 1.0.0.
-- Not published to PyPI; the project name is provisional.
+- No durable broker adapters or OpenTelemetry exporter in this release.
+- The project name is provisional pending trademark clearance.
 
 ## License
 

{datacurrent-1.0.0 → datacurrent-1.0.1}/README.md

@@ -6,7 +6,15 @@ DataCurrent is a production-ready asynchronous streaming library. It gives you
 one consistent API for lists, async generators, queues, WebSockets, Server-Sent
 Events and streaming HTTP responses.
 
-**Version 1.0.0 · Stable / Production**
+**Version 1.0.1 · Stable / Production**
+
+[![PyPI version](https://img.shields.io/pypi/v/datacurrent.svg)](https://pypi.org/project/datacurrent/)
+[![Python versions](https://img.shields.io/pypi/pyversions/datacurrent.svg)](https://pypi.org/project/datacurrent/)
+[![GitHub](https://img.shields.io/badge/GitHub-CoderProandTester%2Fdatacurrent-181717)](https://github.com/CoderProandTester/datacurrent)
+
+- **GitHub repository:** <https://github.com/CoderProandTester/datacurrent>
+- **PyPI homepage:** <https://pypi.org/project/datacurrent/>
+- **Examples:** <https://github.com/CoderProandTester/datacurrent/tree/main/examples>
 
 - 279 tests passing, with 100% line and branch coverage.
 - Required networking dependencies install automatically.
@@ -19,7 +27,10 @@ pip install datacurrent
 ```
 
 Python 3.11 or newer is required. `httpx` and `websockets` are installed with the
-package, so HTTP streaming, SSE and WebSocket clients work immediately.
+package, so HTTP streaming, SSE and WebSocket clients work immediately. The
+[`examples/`](https://github.com/CoderProandTester/datacurrent/tree/main/examples)
+directory contains 16 runnable scripts, from a hello-world stream to a WebSocket
+server.
 
 Framework helpers are optional:
 
@@ -178,6 +189,39 @@ stream = Stream.from_factory(connect_and_read).retry(
 Retries require a replayable source, such as a factory or a list. A consumed
 generator raises `NonReplayableStreamError` instead of silently restarting.
 
+## Examples
+
+Sixteen runnable scripts live in [`examples/`](https://github.com/CoderProandTester/datacurrent/tree/main/examples).
+Each one is self-contained and is executed by the test suite, so the output you
+see is the output the project verifies.
+
+```bash
+python examples/01_hello_stream.py
+python -m pytest tests/unit/test_examples.py -q  # run them all
+```
+
+| Script | What it demonstrates |
+|---|---|
+| `01_hello_stream.py` | Creating a stream, iterating it, `tap` and terminal operations |
+| `02_transformations.py` | `filter`, `map`, `distinct`, `batch`, `window`, `reduce`, `enumerate` |
+| `03_large_dataset.py` | 100,000 records streamed in batches with bounded memory |
+| `04_filter_events.py` | `EventBus` wildcard topics and multiple handlers |
+| `05_multi_subscriber.py` | `Channel` fan-out to three independent consumers |
+| `06_websocket_client.py` | `WebSocketStream` JSON send/receive against a local echo server |
+| `07_websocket_server.py` | Broadcasting a `Channel` to connected WebSocket clients |
+| `08_sse_client.py` | `SSEStream` event ids, event types and JSON payloads |
+| `09_http_streaming.py` | `HTTPStream` line iteration and raw body streaming |
+| `10_fastapi_integration.py` | Serving a DataCurrent stream as a FastAPI SSE endpoint |
+| `11_backpressure.py` | Bounded queues, producer suspension and counted drops |
+| `12_concurrent_processing.py` | Bounded concurrency with order preserved |
+| `13_retry_recovery.py` | `RetryPolicy`, `recover` and replayable sources |
+| `14_custom_transport.py` | Implementing `StreamTransport` for a custom protocol |
+| `15_realtime_notifications.py` | Routing one event to WebSocket and email consumers |
+| `16_event_pipeline.py` | End-to-end event filtering, mapping and batching |
+
+`examples/_servers.py` holds the local HTTP/SSE test servers the networking
+examples use; it is not an example itself.
+
 ## Why DataCurrent
 
 - One model for iterables, queues, HTTP, SSE and WebSockets.
@@ -196,8 +240,8 @@ in-process streaming layer that works without any of them.
 
 - Python 3.11+ on asyncio; no Trio or AnyIO backend.
 - In-memory `Channel` and `EventBus` delivery is at most once.
-- No durable broker adapters or OpenTelemetry exporter in 1.0.0.
-- Not published to PyPI; the project name is provisional.
+- No durable broker adapters or OpenTelemetry exporter in this release.
+- The project name is provisional pending trademark clearance.
 
 ## License
 

{datacurrent-1.0.0 → datacurrent-1.0.1}/datacurrent/_version.py

@@ -2,5 +2,5 @@
 
 from __future__ import annotations
 
-__version__ = "1.0.0"
+__version__ = "1.0.1"
 VERSION = tuple(int(part) for part in __version__.split("."))

{datacurrent-1.0.0 → datacurrent-1.0.1/datacurrent.egg-info}/PKG-INFO

@@ -1,9 +1,14 @@
 Metadata-Version: 2.4
 Name: datacurrent
-Version: 1.0.0
+Version: 1.0.1
 Summary: Python streaming, made simple: async streams, operators, backpressure and real-time transports.
 Author: DataCurrent contributors
 License: MIT
+Project-URL: Homepage, https://github.com/CoderProandTester/datacurrent
+Project-URL: Repository, https://github.com/CoderProandTester/datacurrent
+Project-URL: Issues, https://github.com/CoderProandTester/datacurrent/issues
+Project-URL: Changelog, https://github.com/CoderProandTester/datacurrent/blob/main/CHANGELOG.md
+Project-URL: PyPI, https://pypi.org/project/datacurrent/
 Keywords: streaming,async,asyncio,real-time,data pipeline,stream processing,backpressure,reactive,event bus,pubsub,websocket,server-sent events,http streaming,concurrency,observability,http,https
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: AsyncIO
@@ -52,7 +57,15 @@ DataCurrent is a production-ready asynchronous streaming library. It gives you
 one consistent API for lists, async generators, queues, WebSockets, Server-Sent
 Events and streaming HTTP responses.
 
-**Version 1.0.0 · Stable / Production**
+**Version 1.0.1 · Stable / Production**
+
+[![PyPI version](https://img.shields.io/pypi/v/datacurrent.svg)](https://pypi.org/project/datacurrent/)
+[![Python versions](https://img.shields.io/pypi/pyversions/datacurrent.svg)](https://pypi.org/project/datacurrent/)
+[![GitHub](https://img.shields.io/badge/GitHub-CoderProandTester%2Fdatacurrent-181717)](https://github.com/CoderProandTester/datacurrent)
+
+- **GitHub repository:** <https://github.com/CoderProandTester/datacurrent>
+- **PyPI homepage:** <https://pypi.org/project/datacurrent/>
+- **Examples:** <https://github.com/CoderProandTester/datacurrent/tree/main/examples>
 
 - 279 tests passing, with 100% line and branch coverage.
 - Required networking dependencies install automatically.
@@ -65,7 +78,10 @@ pip install datacurrent
 ```
 
 Python 3.11 or newer is required. `httpx` and `websockets` are installed with the
-package, so HTTP streaming, SSE and WebSocket clients work immediately.
+package, so HTTP streaming, SSE and WebSocket clients work immediately. The
+[`examples/`](https://github.com/CoderProandTester/datacurrent/tree/main/examples)
+directory contains 16 runnable scripts, from a hello-world stream to a WebSocket
+server.
 
 Framework helpers are optional:
 
@@ -224,6 +240,39 @@ stream = Stream.from_factory(connect_and_read).retry(
 Retries require a replayable source, such as a factory or a list. A consumed
 generator raises `NonReplayableStreamError` instead of silently restarting.
 
+## Examples
+
+Sixteen runnable scripts live in [`examples/`](https://github.com/CoderProandTester/datacurrent/tree/main/examples).
+Each one is self-contained and is executed by the test suite, so the output you
+see is the output the project verifies.
+
+```bash
+python examples/01_hello_stream.py
+python -m pytest tests/unit/test_examples.py -q  # run them all
+```
+
+| Script | What it demonstrates |
+|---|---|
+| `01_hello_stream.py` | Creating a stream, iterating it, `tap` and terminal operations |
+| `02_transformations.py` | `filter`, `map`, `distinct`, `batch`, `window`, `reduce`, `enumerate` |
+| `03_large_dataset.py` | 100,000 records streamed in batches with bounded memory |
+| `04_filter_events.py` | `EventBus` wildcard topics and multiple handlers |
+| `05_multi_subscriber.py` | `Channel` fan-out to three independent consumers |
+| `06_websocket_client.py` | `WebSocketStream` JSON send/receive against a local echo server |
+| `07_websocket_server.py` | Broadcasting a `Channel` to connected WebSocket clients |
+| `08_sse_client.py` | `SSEStream` event ids, event types and JSON payloads |
+| `09_http_streaming.py` | `HTTPStream` line iteration and raw body streaming |
+| `10_fastapi_integration.py` | Serving a DataCurrent stream as a FastAPI SSE endpoint |
+| `11_backpressure.py` | Bounded queues, producer suspension and counted drops |
+| `12_concurrent_processing.py` | Bounded concurrency with order preserved |
+| `13_retry_recovery.py` | `RetryPolicy`, `recover` and replayable sources |
+| `14_custom_transport.py` | Implementing `StreamTransport` for a custom protocol |
+| `15_realtime_notifications.py` | Routing one event to WebSocket and email consumers |
+| `16_event_pipeline.py` | End-to-end event filtering, mapping and batching |
+
+`examples/_servers.py` holds the local HTTP/SSE test servers the networking
+examples use; it is not an example itself.
+
 ## Why DataCurrent
 
 - One model for iterables, queues, HTTP, SSE and WebSockets.
@@ -242,8 +291,8 @@ in-process streaming layer that works without any of them.
 
 - Python 3.11+ on asyncio; no Trio or AnyIO backend.
 - In-memory `Channel` and `EventBus` delivery is at most once.
-- No durable broker adapters or OpenTelemetry exporter in 1.0.0.
-- Not published to PyPI; the project name is provisional.
+- No durable broker adapters or OpenTelemetry exporter in this release.
+- The project name is provisional pending trademark clearance.
 
 ## License
 

{datacurrent-1.0.0 → datacurrent-1.0.1}/pyproject.toml

@@ -48,6 +48,13 @@ classifiers = [
 ]
 dependencies = ["httpx>=0.27", "websockets>=12"]
 
+[project.urls]
+Homepage = "https://github.com/CoderProandTester/datacurrent"
+Repository = "https://github.com/CoderProandTester/datacurrent"
+Issues = "https://github.com/CoderProandTester/datacurrent/issues"
+Changelog = "https://github.com/CoderProandTester/datacurrent/blob/main/CHANGELOG.md"
+PyPI = "https://pypi.org/project/datacurrent/"
+
 [project.optional-dependencies]
 starlette = ["starlette>=0.36"]
 fastapi = ["fastapi>=0.110"]