Metadata-Version: 2.4
Name: multi-join
Version: 0.1.3
Summary: Join two or more iterators using flexible join conditions
Author-email: Chris Finan <c.finan@ucl.ac.uk>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://cfinan.gitlab.io/multi-join
Project-URL: Repository, https://gitlab.com/cfinan/multi-join
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: <3.14,>=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-dependency; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: bump2version; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# Getting Started with multi-join

__version__: `0.1.3`

The multi-join package is a toolkit to join any number of iterables together using specified join conditions. It is mainly geared towards joining delimited flat files together though, similar to unix `join` command but in a pure python API. It is built on top of `heapq.merge`.

There is [online](https://cfinan.gitlab.io/multi-join/index.html) documentation for multi-join.

## Installation instructions

Install using pip
```
pip install multi-join
```

Or a conda install
```
conda install -c cfin multi-join
```

## Basic usage
There are some examples in `./resources/examples` where `.` is the root of the multi-join repository.

## Run tests
If you have cloned the repository, you can also run the tests using `pytest ./tests`, if any fail please contact us (see the contribution page for contact info).
