Skip to main content

No project description provided

Project description

yente

yente is an open source data match-making API. The service provides several HTTP endpoints to search, retrieve or match FollowTheMoney entities, including people, companies or vessels that are subject to international sanctions.

The yente API is built to provide access to OpenSanctions data, it can also be used to search and match other data, such as company registries or custom watchlists.

While yente is the open source core code base for the OpenSanctions API, it can also be run on-premises as a KYC appliance so that no customer data leaves your infrastructure.

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. For local development without Docker, install the package into a fresh virtual Python environment like this:

git clone https://github.com/opensanctions/yente.git
cd yente
pip install -e .

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.

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:

yente serve

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yente-4.1.0.tar.gz (50.9 kB view details)

Uploaded Source

Built Distribution

yente-4.1.0-py3-none-any.whl (54.7 kB view details)

Uploaded Python 3

File details

Details for the file yente-4.1.0.tar.gz.

File metadata

  • Download URL: yente-4.1.0.tar.gz
  • Upload date:
  • Size: 50.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for yente-4.1.0.tar.gz
Algorithm Hash digest
SHA256 67a64e9a52476cec35f9968fb46ff735aa6cf39695f0db601fe77ae90c03b410
MD5 9513d7389da485790023a65e3656679b
BLAKE2b-256 c2013cc72395f6cf1d8d4b3e34dd1d8252d5d570564403efcce87137f2855792

See more details on using hashes here.

File details

Details for the file yente-4.1.0-py3-none-any.whl.

File metadata

  • Download URL: yente-4.1.0-py3-none-any.whl
  • Upload date:
  • Size: 54.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for yente-4.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6732bc6a6609bc02a91748c0a7eb815ba31c3db4f7960f84972568aaab7c61f9
MD5 cfffcfe012d20e51a6d8100cf173c8a6
BLAKE2b-256 a0c75257cb9a05aa606551f98750f03ab4f241ab3b3f818c6f1ad668a6d80636

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page