Welcome to iter-together’s Documentation!

Simultaneously iterate over multiple files with the same index column.

Usage

iter_together.iter_together(left_path, right_path, sep=',')[source]

Iterate over two files with the same index.

  • Assumes the left-most column in each file is the same

  • Splats the remaining rows in order so each row is a tuple of strings

Parameters

  • left_path (str) – The path to the first file (assumes file is CSV-like)

  • right_path (str) – The path to the second file (assumes file is CSV-like)

  • sep (str) – The separator used in the files

Return type

Iterable[Tuple[str, …]]

Command Line Interface

Note

The command line wrapper might not work on Windows. Use python3 -m iter_together if it has issues.

iter-together automatically installs the command iter-together. This command can be used to use the iter_together.iter_together() function via the command line.

iter-together

Iterate two files together.

iter-together [OPTIONS] LEFT RIGHT

Options

-s, --sep <sep>

[default: ,]

Arguments

LEFT

Required argument

RIGHT

Required argument

Indices and Tables