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.1.tar.gz (7.8 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.1-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yk_face-0.3.1.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for yk_face-0.3.1.tar.gz
Algorithm Hash digest
SHA256 08be81763a58cdeeebefc963adf70bad8754b92319adb69571cff10c80606aaa
MD5 c0593acdf159036008935b2c33c88972
BLAKE2b-256 b4868a5eb505ced2aa31363d6c6f42250ec61286b4a90bc5a42dec5489e83061

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yk_face-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for yk_face-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2da7975174b6344033cbd0dabd343c1abf136c1d532dbc08100071ecc9236824
MD5 b696f1f339eee61454f350b25852118e
BLAKE2b-256 eed310685c7cbc5f20056b81363e63c32084b89187bd06a9f17761f961c81140

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