Metadata-Version: 2.4
Name: matchbox-db
Version: 0.5.5
Summary: A framework for orchestrating and comparing data linking and deduplication methodologies.
Author: Department for Business and Trade
License: MIT License
        
        Copyright (c) 2024 Department for Business and Trade
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Documentation, https://uktrade.github.io/matchbox/
Project-URL: Repository, https://github.com/uktrade/matchbox.git
Requires-Python: <3.14,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.1.7
Requires-Dist: cryptography>=44.0.2
Requires-Dist: duckdb>=1.1.1
Requires-Dist: faker>=36.1.1
Requires-Dist: frozendict>=2.4.6
Requires-Dist: httpx>=0.28.0
Requires-Dist: matplotlib>=3.9.2
Requires-Dist: pandas>=2.2.3
Requires-Dist: polars-hash>=0.5.3
Requires-Dist: polars>=1.32.3
Requires-Dist: psycopg[binary,pool]>=3.2.6
Requires-Dist: pyarrow>=17.0.0
Requires-Dist: pydantic-settings>=2.5.2
Requires-Dist: pydantic>=2.9.2
Requires-Dist: rich>=13.9.4
Requires-Dist: rustworkx>=0.15.1
Requires-Dist: splink<4.1.0,>=4.0.5
Requires-Dist: sqlalchemy>=2.0.35
Requires-Dist: sqlglot[rs]>=26.12.1
Requires-Dist: tenacity>=9.1.2
Provides-Extra: server
Requires-Dist: adbc-driver-postgresql>=1.5.0; extra == "server"
Requires-Dist: alembic>=1.15.2; extra == "server"
Requires-Dist: boto3>=1.35.99; extra == "server"
Requires-Dist: celery[redis]>=5.5.3; extra == "server"
Requires-Dist: fastapi[standard-no-fastapi-cloud-cli]>=0.116.0; extra == "server"
Requires-Dist: python-multipart>=0.0.18; extra == "server"
Requires-Dist: redis>=5.2.1; extra == "server"
Requires-Dist: tomli>=2.0.1; extra == "server"
Provides-Extra: eval
Requires-Dist: streamlit>=1.45.0; extra == "eval"
Dynamic: license-file

<p align="center">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/uktrade/matchbox/refs/heads/main/docs/assets/matchbox-logo-dark.svg">
      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/uktrade/matchbox/refs/heads/main/docs/assets/matchbox-logo-light.svg">
      <img alt="Shows the Matchbox logo in light or dark color mode." src="https://raw.githubusercontent.com/uktrade/matchbox/refs/heads/main/docs/assets/matchbox-logo-light.svg">
    </picture>
</p>

Record matching is a chore. 🔥Matchbox is a match pipeline orchestration tool that aims to:

* Make matching an iterative, collaborative, measurable problem
* Compose sources, dedupers and linkers and make the results very easy to query
* Allow organisations to know they have matching records without having to share the data
* Allow matching pipelines to run iteratively
* Support batch and real-time matching 

Matchbox doesn't store raw data, instead indexing the data in your warehouse and leaving permissioning at the level of the user, service or pipeline.

To get started, read our [full documentation](https://uktrade.github.io/matchbox/).

## Installation

To install the matchbox client:

```shell
pip install "matchbox-db"
```

To install the full package, including the server features:

```shell
pip install "matchbox-db[server]"
```

To run the server, see the [server installation documentation](https://uktrade.github.io/matchbox/server/install/).

## Use cases

### Data architects and engineers

* Reconcile entities across disparate data
* Rationalise about the quality of different entity matching pipelines and serve up the best
* Run matching pipelines without recomputing them every time
* Lay the foundation for the nouns of a semantic layer

### Data analysts and scientists

* Use your team's best matching methods when retrieving entities, always
* Measurably improve methodologies when they don't work for you
* When you link new data, allow others to use your work easily and securely

### Service owners

* Understand the broader business entities in your service, not just what you have
* Enrich other services with data generated in yours without giving away any permissioning powers
* Empower your users to label matched entities and let other services use that information

## Development

See our full development guide and coding standards on our [contribution guide](https://uktrade.github.io/matchbox/contributing/).
