Metadata-Version: 2.1
Name: face-lensing
Version: 0.2
Summary: Your face through a gravitational lens
Home-page: https://github.com/aboucaud/face_lensing
Author: Alexandre Boucaud
Author-email: aboucaud@apc.in2p3.fr
License: MIT
Project-URL: Bug Tracker, https://github.com/aboucaud/face_lensing/issues
Platform: any
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: opencv-python

Face Lensing App
================

Look at yourself through a gravitational lens.

Installation
------------

1. Install the Python program with `pip`
    ```sh
    pip install face_lensing
    ```
2. Launch the app from a terminal
    ```sh
    face-lensing-app
    ```
3. A window should appear with the distorted webcam image


App controls
------------

The app can be controlled through the keyboard using the following controls:

|       Key        | Action                                      |
| :--------------: | ------------------------------------------- |
|   <kbd>q</kbd>   | quit the program                            |
|   <kbd>c</kbd>   | change camera (in case of multiple webcams) |
| <kbd>Space</kbd> | save a screenshot locally                   |
|   <kbd>+</kbd>   | increase the lensing effect                 |
|   <kbd>-</kbd>   | decrease the lensing effect                 |


License
-------

This program is licensed under the MIT license.


