datacurrent 1.0.0__tar.gz → 1.0.2__tar.gz

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

@@ -4,6 +4,50 @@ 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.2] — 2026-11-13
+
+Automation and packaging release. The public API is unchanged.
+
+### Added
+
+- GitHub Actions CI (`.github/workflows/ci.yml`) running `ruff`, `mypy` and the
+  coverage-enforcing test suite on Python 3.11 through 3.14 for every push and
+  pull request.
+
+### Fixed
+
+- The source distribution ships `CONTRIBUTING.md`; the manifest entry was added
+  after the 1.0.1 build.
+- The release workflow now skips the PyPI upload when the version is already
+  published, instead of failing on a duplicate file.
+
+## [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.2/CONTRIBUTING.md

@@ -0,0 +1,137 @@
+# Contributing to DataCurrent
+
+Thanks for helping improve DataCurrent. This guide covers setup, the checks your
+change must pass, and how releases are published.
+
+- Repository: <https://github.com/CoderProandTester/datacurrent>
+- Issues: <https://github.com/CoderProandTester/datacurrent/issues>
+- PyPI: <https://pypi.org/project/datacurrent/>
+
+## Development setup
+
+Python 3.11 or newer is required.
+
+```bash
+git clone https://github.com/CoderProandTester/datacurrent.git
+cd datacurrent
+python -m venv .venv
+```
+
+Activate the environment, then install the package with the development extras:
+
+```bash
+# Windows (Git Bash)
+source .venv/Scripts/activate
+# macOS / Linux
+source .venv/bin/activate
+
+python -m pip install --upgrade pip
+python -m pip install -e ".[dev]"
+```
+
+`dev` pulls in `pytest`, `pytest-asyncio`, `pytest-cov`, `hypothesis`, `build`,
+`twine`, `ruff` and `mypy`.
+
+## Before you change anything
+
+```bash
+python scripts/dev.py check    # ruff + mypy
+python scripts/dev.py test     # full test suite
+```
+
+`scripts/dev.py` runs every command with the interpreter that launched it, so it
+always uses the active virtual environment. `python scripts/dev.py --help`
+lists all tasks.
+
+## Layout
+
+| Path | Contents |
+|---|---|
+| `datacurrent/core/` | `Stream`, operators, pipelines, terminals |
+| `datacurrent/buffering/` | `BoundedQueue`, backpressure policies |
+| `datacurrent/concurrency/` | `ConcurrencyLimiter`, task tracking, `gather_limited` |
+| `datacurrent/reliability/` | retries, timeouts |
+| `datacurrent/transports/` | HTTP, SSE, WebSocket and the transport base |
+| `datacurrent/events/` | `Channel`, `EventBus`, routing |
+| `datacurrent/integrations/` | FastAPI and Starlette helpers |
+| `datacurrent/observability/` | metrics, stats, structured logging |
+| `docs/` | guides and the API reference |
+| `examples/` | sixteen runnable, test-covered scripts |
+| `tests/` | unit, property-based, stress and packaging tests |
+| `benchmarks/` | reproducible micro-benchmarks |
+
+## Making a change
+
+1. Keep the public API in `datacurrent/__init__.py` and `__all__` in sync when
+   you add or remove an export.
+2. Preserve the existing guarantees: laziness, single consumption, bounded
+   buffers that block by default, counted drops, and cancellation-safe cleanup.
+3. New behaviour needs tests. The project enforces **100% line and branch
+   coverage**, so aim for that before you open a pull request.
+4. Add an example when you add a user-facing feature, and list it in the README
+   examples table. Examples must define `async def main()` and run in under 30
+   seconds; `tests/unit/test_examples.py` executes every file that does not start
+   with `_`.
+5. Update `CHANGELOG.md` under an "Unreleased" or new version heading. The format
+   follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions
+   follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Checks
+
+```bash
+python scripts/dev.py lint                  # ruff check .
+python scripts/dev.py fmt                   # ruff format .
+python scripts/dev.py typecheck             # mypy
+python scripts/dev.py cov                   # pytest with coverage (must be 100%)
+python scripts/dev.py examples              # just the example scripts
+python scripts/dev.py build                 # sdist + wheel
+python scripts/dev.py check-dist            # twine check dist/*
+```
+
+A change is ready when `lint`, `typecheck` and `cov` all pass. Please do not
+weaken assertions, skip tests or add suppressions to get a green run; fix the
+cause instead.
+
+## Style
+
+- `ruff` with a 100-character line length, targeting Python 3.11 syntax.
+- Full type annotations on public functions; the package ships `py.typed`.
+- Async-first: no blocking I/O on the event loop.
+- Prefer editing existing modules over adding new ones.
+- Comments explain why, not what.
+
+## Reporting a bug
+
+Open an issue at <https://github.com/CoderProandTester/datacurrent/issues> with
+the version (`python -c "import datacurrent; print(datacurrent.__version__)"`),
+your Python version and platform, a minimal reproduction, and what you expected
+instead. Security issues should be reported privately rather than in a public
+issue.
+
+## Release process
+
+Versions are read from `datacurrent/_version.py`; that file is the single source
+of truth. Releases are normally published by GitHub Actions with PyPI trusted
+publishing, so the upload carries a signed provenance attestation.
+
+```bash
+# 1. Bump the version and document it
+#    datacurrent/_version.py -> __version__ = "1.0.2"
+#    CHANGELOG.md -> new heading with the date
+
+# 2. Verify everything
+python scripts/dev.py release      # lint, mypy, tests, build, twine check
+
+# 3. Publish
+#    Preferred: GitHub Release -> the release workflow uploads to PyPI
+#    Fallback: twine upload dist/*
+```
+
+Set `TWINE_USERNAME=__token__` and `TWINE_PASSWORD=<PyPI API token>` (or use
+`~/.pypirc`) for the manual path. PyPI rejects re-uploads of an existing version,
+so a failed upload always needs a new version number.
+
+## License
+
+By contributing you agree that your contributions are licensed under the MIT
+license in `LICENSE`.

{datacurrent-1.0.0 → datacurrent-1.0.2}/MANIFEST.in

@@ -1,6 +1,7 @@
 include README.md
 include LICENSE
 include CHANGELOG.md
+include CONTRIBUTING.md
 include MANIFEST.in
 recursive-include datacurrent *.py py.typed
 prune tests

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

@@ -1,9 +1,14 @@
 Metadata-Version: 2.4
 Name: datacurrent
-Version: 1.0.0
+Version: 1.0.2
 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.2 · 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.2}/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.2 · 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.2}/datacurrent/_version.py

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

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

@@ -1,9 +1,14 @@
 Metadata-Version: 2.4
 Name: datacurrent
-Version: 1.0.0
+Version: 1.0.2
 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.2 · 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.2}/datacurrent.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 CHANGELOG.md
+CONTRIBUTING.md
 LICENSE
 MANIFEST.in
 README.md

{datacurrent-1.0.0 → datacurrent-1.0.2}/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"]