Skip to main content

Python SDK for the YooniK Face API.

Project description

YooniK Face API: Python SDK & Sample

PyPi Version License

This repository contains the Python SDK for the YooniK Face API, an offering within YooniK Services

Getting started

Install the module using pip:

pip install yk_face

Use it:

import yk_face as YKF

KEY = 'subscription key'  # Replace with a valid Subscription Key here.

BASE_URL = 'YooniK Face API URL'  # Replace with a valid URL for YooniK Face API.

img_file_path = 'image path'  # Replace with a valid image file path here.
detected_faces = YKF.face.process(img_file_path)
print(f'Detected faces: {detected_faces}')

Installing from the source code

python install

Running the sample

A sample python script is also provided. Please check the sample directory in this repository.

YooniK Face API Details

For a complete specification of our Face API please check the swagger file.

Contact & Support

For more information and trial licenses please contact us or join us at our discord community.

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

yk_face-0.3.0.tar.gz (5.3 kB view hashes)

Uploaded Source

Built Distribution

yk_face-0.3.0-py3-none-any.whl (6.5 kB view hashes)

Uploaded Python 3

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