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

Uploaded Source

Built Distribution

yente-3.6.0-py3-none-any.whl (40.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for yente-3.6.0.tar.gz
Algorithm Hash digest
SHA256 47ac881b051b78ec9c87c532b234b024e12374ca9c1ffecc663b48b136eaf3b8
MD5 5ec7b42ae12fe053b541b38b1200ea44
BLAKE2b-256 442319b2b2d462126ee1659c582ec4f2c8573586330b9adf934fb5c1c6d01046

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for yente-3.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d245ca94ff0e83c5b437526de30e2907f8e8c04affde17ccca5ed8409d586988
MD5 a42eb54a97da7f7bb8200d4a3c825a9e
BLAKE2b-256 5f74b84f7c22f66a19aa56ad251a23c1628d9619005c736e1dcfced40fbdc467

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