Metadata-Version: 2.4
Name: yente
Version: 5.2.1
Summary: A simple and fast API service for querying FollowTheMoney data, including OpenSanctions.
Project-URL: Documentation, https://www.opensanctions.org/docs/yente/
Project-URL: Repository, https://github.com/opensanctions/yente.git
Project-URL: Issues, https://github.com/opensanctions/yente/issues
Author-email: OpenSanctions <info@opensanctions.org>
License: MIT License
        
        Copyright (c) 2022-2025 OpenSanctions Datenbanken GmbH
        
        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.
License-File: LICENSE
Requires-Python: <=3.14,>=3.11
Requires-Dist: aiocron==2.1
Requires-Dist: aiocsv==1.4.0
Requires-Dist: aiofiles==25.1.0
Requires-Dist: aiohttp[speedups]==3.13.5
Requires-Dist: anyio==4.13.0
Requires-Dist: asyncstdlib==3.14.0
Requires-Dist: boto3~=1.37
Requires-Dist: click<8.4,>=8.2
Requires-Dist: countrynames==1.16.10
Requires-Dist: cryptography==46.0.6
Requires-Dist: elasticsearch[async]==8.19.3
Requires-Dist: email-validator==2.3.0
Requires-Dist: fastapi==0.135.2
Requires-Dist: fingerprints==1.3.1
Requires-Dist: followthemoney==4.7.0
Requires-Dist: httpx[http2]==0.28.1
Requires-Dist: nomenklatura==4.7.3
Requires-Dist: normality==3.1.0
Requires-Dist: opensearch-py[async]==3.1.0
Requires-Dist: orjson==3.11.8
Requires-Dist: pydantic
Requires-Dist: pyicu==2.16.2
Requires-Dist: python-multipart==0.0.22
Requires-Dist: rich
Requires-Dist: rigour==1.7.5
Requires-Dist: structlog==25.5.0
Requires-Dist: text-unidecode==1.3
Requires-Dist: uvicorn[standard]==0.42.0
Description-Content-Type: text/markdown

# yente

`yente` is an open source data match-making API. The service provides several HTTP endpoints to search, retrieve or match [FollowTheMoney entities](https://www.opensanctions.org/docs/entities/), including people, companies or vessels that are subject to international sanctions.

The yente API is built to provide access to [OpenSanctions data](https://www.opensanctions.org/datasets/), and can also be used to search and match other data, such as [company registries](https://www.opensanctions.org/datasets/kyb/) or [custom watchlists](https://www.opensanctions.org/docs/yente/datasets/).

While `yente` is the open source core code base for the [OpenSanctions API](https://www.opensanctions.org/api/), it can also be run [on-premises as a KYC appliance](https://www.opensanctions.org/docs/self-hosted/) so that no customer data leaves your infrastructure.

* [yente documentation](https://www.opensanctions.org/docs/yente/) - install, configure and use the service.

## Development

`yente` is implemented in asynchronous, typed Python using the FastAPI framework. We're happy to see any bug fixes, improvements or extensions from the community. To set up a local development environment, use `uv`:

```bash
git clone https://github.com/opensanctions/yente.git
cd yente
# Install runtime and development dependencies
uv sync
# Install pre-commit hooks with useful checks
prek install
# Activate the virtual environment
source .venv/bin/activate
```

This will install a broad range of dependencies, including `numpy`, `scikit-learn` and `pyicu`, which are binary packages that may require a local build environment. For `pyicu` in particular, refer to the [package documentation](https://pypi.org/project/PyICU/).

### Running the server

Once you've set the ``YENTE_INDEX_URL`` environment variable to point to a running instance of ElasticSearch or OpenSearch, you can run the web server like this:

```bash
yente serve
```


### Releasing

    bump2version --verbose minor # or patch
    git push && git push --tags

## License and Support

``yente`` is licensed according to the MIT license terms documented in ``LICENSE``. Using the service in a commercial context may require a [data license for OpenSanctions data](https://www.opensanctions.org/licensing/).
