1.6.0: Make Stream an AsyncIterable decorator and an Awaitable[Stream]; add all async twin operations (closes #8 #100 #101)

.github/workflows/pypi.yml

@@ -4,6 +4,9 @@ on:
   push:
     branches:
       - main
+      - alpha
+      - beta
+      - rc
     paths:
       - 'version.py'
 

.github/workflows/testing.yml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ['3.7.17', '3.8.18', '3.9.18', '3.10.13', '3.11.7', '3.12.1', '3.13.1', '3.14.0-alpha.3']
+        python-version: ['3.7.17', '3.8.18', '3.9.18', '3.10.13', '3.11.7', '3.12.1', '3.13.1', '3.14.0-beta.1']
 
     steps:
       - uses: actions/checkout@v4

.gitignore

@@ -1,11 +1,13 @@
+__pycache__
 .idea
 .vscode
-__pycache__
-.venv
+.venv*
 tmp*
 build
 dist
+streamable.egg-info
 .mypy_cache
-htmlcov
+.ruff_cache
 .coverage
-streamable.egg-info
+htmlcov
+.ipynb_checkpoints

CONTRIBUTING.md

@@ -27,7 +27,7 @@ is relatively close to
 Applying an operation simply performs argument validation and returns a new instance of a `Stream` sub-class corresponding to the operation. Defining a stream is basically constructing a composite structure where each node is a `Stream` instance: The above `events` variable holds a `CatchStream[int]` instance, whose `.upstream` attribute points to a `TruncateStream[int]` instance, whose `.upstream` attribute points to a `ForeachStream[int]` instance, whose `.upstream` points to a `Stream[int]` instance. Each node's `.source` attribute points to the same `range(10)`.
 
 ## Visitor Pattern
-Each node in this composite structure exposes an `.accept` method enabling traversal by a visitor. Both `Stream.__iter__` and `Stream.__repr__` rely on visitor classes defined in the `streamable.visitors` package.
+Each node in this composite structure exposes an `.accept` method enabling traversal by a visitor. `.__iter__`/`.__aiter__`/`.__repr__`/`.__str__`/`.__eq__` rely on visitor classes defined in the `streamable.visitors` package.
 
 ## Decorator Pattern
-A `Stream[T]` both inherits from `Iterable[T]` and holds an `Iterable[T]` as its `.source`: when you instantiate a stream from an iterable you decorate it with a fluent interface.
+A `Stream[T]` *decorates* an iterable with a fluent interface: it is instanciated from an `Iterable[T]`/`AsyncIterable[T]` and is an `Iterable[T]`/`AsyncIterable[T]`.