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 the deployment context.

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_ELASTICSEARCH_URL environment variable to point to a running instance of ElasticSearch, you can run the web server like this:

python yente/server.py

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-3.8.5.tar.gz (37.7 kB view details)

Uploaded Source

Built Distribution

yente-3.8.5-py3-none-any.whl (43.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yente-3.8.5.tar.gz
  • Upload date:
  • Size: 37.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for yente-3.8.5.tar.gz
Algorithm Hash digest
SHA256 b0968b8b26f09fdefbf0d0071f125cb50b01616333e8fd654beea0ecee0599a8
MD5 1d33d8630c26de02fbd1f1b80993a420
BLAKE2b-256 ae29b830518f8d469d76c0327aadc2e2b261ed0221882ca1c5f427a72b50eab2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yente-3.8.5-py3-none-any.whl
  • Upload date:
  • Size: 43.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for yente-3.8.5-py3-none-any.whl
Algorithm Hash digest
SHA256 222b37380255831dc0fc785eb13bb65af9181ed175de83fac18d6d5b735b8e4a
MD5 c974aaa344160372cf1a85a7cdb50ac0
BLAKE2b-256 0178e02387490d25b90d72ecfbb7ec198f4bae2b2b0fa24c8a480dc08aa97ef6

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