Metadata-Version: 2.1
Name: lockatme
Version: 0.0.2.1
Summary: Modulable screen locker
Home-page: https://github.com/Sweenu/lockatme
Author: Pierre-Louis Sergent, David Anandanadaradja, Matthieu Kirschleger, Sagar Gueye, Bruno Inec
Author-email: brunoinec@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Desktop Environment :: Screen Savers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Operating System :: POSIX :: Linux
Classifier: Environment :: X11 Applications
Requires-Python: >=3.6.0
Requires-Dist: python-xlib
Requires-Dist: opencv-python
Requires-Dist: dlib
Requires-Dist: face-recognition
Requires-Dist: pamela


lockatme: Modulable Screen Locker
#################################

lockatme is a screen locker that works with modules. It allows the user
to use the same locker for different types of authentication.

**This locker is in development stage, there is nothing secure about it.
Don't use it for real application just yet.**

|pypi|

.. contents::

.. section-numbering::


Main features
=============

* Modulable
* Themable (TODO)


Installation
============

Using ``pip``:

.. code-block:: bash

    $ pip install lockatme


Usage
=====

From the command line:

.. code-block:: bash

    $ lockatme


Configuration
=============

lockatme uses a ini-like config file.

Config file location
--------------------
The default location of the configuration file is ``$XDG_CONFIG_HOME/lockatme/config`` or
``~/.config/lockatme/config`` if ``$XDG_CONFIG_HOME`` is not set.

Module configuration
--------------------

You can choose which modules you want to use so for example, if you want to use only
password authentication:

.. code-block:: ini

    [unlockers]
    password

If you want to use both password and facial recognition at the same time:

.. code-block:: ini

    [unlockers]
    password
    facial_recogntion


.. |pypi| image:: https://pypip.in/v/lockatme/badge.png
    :target: https://pypi.org/project/lockatme/
    :alt: Latest PyPI version


