Metadata-Version: 2.1
Name: flare-face-extractor
Version: 0.0.2
Summary: A small example package
Home-page: https://github.com/Flare-FYDP/facial-extractor
Author: flare
Author-email: author@example.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/Flare-FYDP/facial-extractor/issues
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
License-File: LICENSE

# facial-extractor

PyPi: [flare-face-extractor](https://pypi.org/project/flare-face-extractor/)

## API
* `locate_faces`
  * Calculates the location of all the faces in a given image.
  * Parameters
    * `image_path` - A string specifying where the image in located.
  * Return:
    * A list of `Faces`. Each `Face` consists of its x and y coordinates as well as its width and height.

* `outline_faces`
  * Opens a window displaying the image provided and outlines the faces present in the photo. 
    Should be used purely for interactive purposes.
  * Parameters
    * `image_path` - A string specifying where the image in located.  
  * Return:
    * `None`

* `count`
  * Returns the number of faces present in the given image.
  * Parameters
    * `image_path` - A string specifying where the image in located
  * Return:
    * An integer representing the number of faces present.


## Publishing the package
1. Install packages in `requirements.txt`
2. Bump the version number in [setup.cfg](/setup.cfg)
3. Building (Now run this command from the same directory where pyproject.toml is located): 
   `python3 -m build`
4. Get the PyPI API token
5. Run Twine to upload all the archives under `dist`: 
   `python3 -m twine upload dist/*`
  1. username: `__token__`
  2. password: the PyPi token  including the `pypi-` prefix

## Helpful links 
* [Instructions](https://packaging.python.org/en/latest/tutorials/packaging-projects/)

