Skip to main content

Python SDK for the YooniK Face API.

Project description

https://yk-website-images.s3.eu-west-1.amazonaws.com/LogoV4_TRANSPARENT.png

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.
YKF.Key.set(KEY)

BASE_URL = 'YooniK Face API URL'  # Replace with a valid URL for YooniK Face API.
YKF.BaseUrl.set(BASE_URL)

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 setup.py 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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file yk_face-0.3.0.tar.gz.

File metadata

  • Download URL: yk_face-0.3.0.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for yk_face-0.3.0.tar.gz
Algorithm Hash digest
SHA256 87bfcc4aa7e01dc9af683befefee28ab10916aeb73fdc6ad8f4d757f0e32a51c
MD5 5f5f234b061e3d653fe8c34316704994
BLAKE2b-256 a18f6c286ac3465ec01f29def379050024c6167654e4459d90cd3b60f14f9238

See more details on using hashes here.

File details

Details for the file yk_face-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: yk_face-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for yk_face-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9af7e00ad96bcdb925d5eb45f0773617fe273bd0b9c2fbb3d39c1157cd284f5a
MD5 1fac552047c7f11812d62ec0426c3f31
BLAKE2b-256 86b909c10aa1a7a7b4b217fc45836e7ab0d460ce58f4b56efb66ac5b62f87002

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page