Metadata-Version: 2.1
Name: yk_face
Version: 0.1.0
Summary: Python SDK for the YooniK Face API.
Home-page: https://github.com/dev-yoonik/YK-Face-Python
Author: YooniK
Author-email: tech@yoonik.me
License: MIT
Description: 
        ![https://yoonik.me/wp-content/uploads/2019/08/cropped-LogoV4_TRANSPARENT.png](https://yoonik.me/wp-content/uploads/2019/08/cropped-LogoV4_TRANSPARENT.png)
        
        # YooniK Face API: Python SDK & Sample
        
        This repository contains the Python SDK for the YooniK Face API, an offering within [YooniK Services](https://yoonik.me)
        
        For more information please [contact us](mailto:info@yoonik.me).
        
        ## Getting started
        
        Install the module using [pip](https://pypi.python.org/pypi/pip/):
        
        ```bash
        pip install yk_face
        ```
        
        Use it:
        
        ```python
        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
        
        ```bash
        python setup.py install
        ```
        
        ## Running the sample
        
        A sample python script is also provided. Please check the sample directory in this repository.
        
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
