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

Uploaded Source

Built Distribution

yente-3.8.2-py3-none-any.whl (42.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yente-3.8.2.tar.gz
  • Upload date:
  • Size: 37.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for yente-3.8.2.tar.gz
Algorithm Hash digest
SHA256 db17ec016508af8bca84c70f86b8133ecf2a3802e51f4f510c06b44fd448d397
MD5 6eee7aca5c3854e0278c3f4594ac85fc
BLAKE2b-256 a80d8664a74261be462968b9a13325955b05df8f8195da29457e34003832eb9c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yente-3.8.2-py3-none-any.whl
  • Upload date:
  • Size: 42.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for yente-3.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1ec0eaeb790890358ce2dfe9245da7069169a0cfdb33250c28634b98d86c7e16
MD5 a9da2937a31f21d0fba3eb55ca7334d0
BLAKE2b-256 aeac5042a824b630e4d449b02d970e0f660706fe2f4c15ffa8fa358b87834d8e

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