Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# itrx - A Chainable Iterable Adaptor
# `itrx`: A Chainable Iterable Adaptor

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![Python Version](https://img.shields.io/python/required-version-toml?tomlFilePath=https://raw.githubusercontent.com/virgesmith/itrx/refs/heads/main/pyproject.toml)
![PyPI - Version](https://img.shields.io/pypi/v/itrx)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/itrx)
![PyPI - License](https://img.shields.io/pypi/l/xenoform)

`itrx` is a Python library that adapts iterators, iterables, and generators, providing a Rust-inspired `Iterator` trait experience with added Pythonic conveniences. It enables developers to build complex data processing pipelines with a fluent, chainable, and lazy API. In most cases, it simply wraps `itertools` and/or builtins in syntactic sugar.

Expand Down
8 changes: 4 additions & 4 deletions doc/apidoc.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `Itr` v0.1.7 class documentation
# `Itr` v0.2.0 class documentation
A generic iterator adaptor class inspired by Rust's Iterator trait, providing a composable API for
functional-style iteration and transformation over Python iterables.
## Public methods
Expand Down Expand Up @@ -183,13 +183,13 @@ Returns:

### `flat_map`

Flatten an iterable and map the results. Each item must itself be iterable.
Map each item to an iterable, then flatten one level.

Args:
mapper (Callable[[U], V]): A function mapping each item to an iterable.
mapper (Callable[[T], Iterable[U]]): A function mapping each item to an iterable.

Returns:
Itr[V]: An iterator over the mapped and flattened items.
Itr[U]: An iterator over the mapped and flattened items.



Expand Down
Loading
Loading