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

Uploaded Source

Built Distribution

yente-3.7.1-py3-none-any.whl (41.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for yente-3.7.1.tar.gz
Algorithm Hash digest
SHA256 5aaaa81171d45a739c6eb884478b60fc9b9de14f25053a01c381cbc190f3d58f
MD5 94c14e0716b945e1c2ad957fe3b55ae1
BLAKE2b-256 6943a0af97d904b8599fef5d612a9b0b61bec4dac35ae5dfb4bf4534abb817d7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for yente-3.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 aeb90307e392deccf09664ec9cb373ffeed60c03fed106758a55995bd60a9fc7
MD5 b5c6a4032e80eabf96cffa3b34b44ec9
BLAKE2b-256 744dfc685f34f1b57cd04657b33bbd5905ab6af5c4af8995d8bc43e639a8f5e2

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