Skip to main content

Python SDK for the YouFace API.

Project description

logo

YouFace API: Python SDK & Sample

PyPi Version License

This repository contains the Python SDK for the YouFace API, an offering within Youverse 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 = 'YouFace API URL'  # Replace with a valid URL for YouFace 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.

YouFace 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.6.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

yk_face-0.3.6-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yk_face-0.3.6.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for yk_face-0.3.6.tar.gz
Algorithm Hash digest
SHA256 7905b6928028ac4fecd0f4b6ca057cca178410f25c28d888acf51c37a41bb973
MD5 ab6e6566dc60f9ce2fcb727cc54f02cc
BLAKE2b-256 49675bd50b3aabd431bd9847441693bd2493674584043e838a787e6c0974d0fa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yk_face-0.3.6-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for yk_face-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3ffe5e18133213694b32ad8b1e34e9383e3b0b9d4d6153034d607daa9109229f
MD5 0d99e5012cac2630061a27861fa97fb5
BLAKE2b-256 36a35a26ecbbbab0334951e75023dd8b3c3d790cca002c6bf5296ec8ded5385c

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