Merge pull request #1023 from boltgolt/beta

Release 3.0.0

Author: boltgolt

.clang-tidy

@@ -0,0 +1,7 @@
+Checks: 'clang-diagnostic-*,clang-analyser-*,-clang-diagnostic-unused-command-line-argument,google-*,bugprone-*,modernize-*,performance-*,portability-*,readability-*,-bugprone-easily-swappable-*,-readability-magic-numbers,-google-readability-todo'
+WarningsAsErrors: 'clang-diagnostic-*,clang-analyser-*,-clang-diagnostic-unused-command-line-argument,google-*,bugprone-*,modernize-*,performance-*,portability-*,readability-*,-bugprone-easily-swappable-*,-readability-magic-numbers,-google-readability-todo'
+CheckOptions:
+  - key:             readability-function-cognitive-complexity.Threshold
+    value:           '50'
+
+# vim:syntax=yaml

.github/pull_request_template.md

@@ -0,0 +1,2 @@
+_Please make sure to target the "dev" branch if it exists_
+_REMOVE THIS MESSAGE IN THE PULL REQUEST_

.github/workflows/check.yml

@@ -0,0 +1,28 @@
+name: check
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install required libraries
+        run: >
+          sudo apt-get update && sudo apt-get install -y 
+          python3 python3-pip python3-setuptools python3-wheel
+          cmake make build-essential clang-tidy
+          libpam0g-dev libinih-dev libevdev-dev 
+          python3-dev libopencv-dev
+        
+      - name: Install meson
+        run: sudo python3 -m pip install meson ninja
+
+      - uses: actions/checkout@v2
+
+      - name: Build
+        run: |
+          meson setup build
+          ninja -C build
+
+      - name: Check source code
+        run: |
+          ninja clang-tidy -C build

.gitignore

@@ -101,13 +101,30 @@ ENV/
 .mypy_cache/
 
 # generated models
-/src/models
+/howdy/src/models
 
 # snapshots
-/src/snapshots
+/howdy/src/snapshots
 
 # build files
 debian/howdy.substvars
 debian/files
 debian/debhelper-build-stamp
 debian/howdy
+
+# vscode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+# Meson
+subprojects/

.travis.yml

@@ -1,9 +1,6 @@
 ![](https://boltgolt.nl/howdy/banner.png)
 
 <p align="center">
-	<a href="https://travis-ci.org/boltgolt/howdy">
-		<img src="https://img.shields.io/travis/boltgolt/howdy/master.svg">
-	</a>
 	<a href="https://github.com/boltgolt/howdy/releases">
 		<img src="https://img.shields.io/github/release/boltgolt/howdy.svg?colorB=4c1">
 	</a>
@@ -13,6 +10,12 @@
 	<a href="https://www.buymeacoffee.com/boltgolt">
 		<img src="https://img.shields.io/badge/endpoint.svg?url=https://boltgolt.nl/howdy/shield.json">
 	</a>
+	<a href="https://actions-badge.atrox.dev/boltgolt/howdy/goto?ref=beta">
+		<img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fboltgolt%2Fhowdy%2Fbadge%3Fref%3Dbeta&style=flat&label=build&logo=none">
+	</a>
+	<a href="https://aur.archlinux.org/packages/howdy">
+		<img src="https://img.shields.io/aur/votes/howdy?color=4c1&label=aur%20votes">
+	</a>
 </p>
 
 Howdy provides Windows Hello™ style authentication for Linux. Use your built-in IR emitters and camera in combination with facial recognition to prove who you are.
@@ -42,32 +45,79 @@ This will guide you through the installation.
 Download the .deb file from the [Releases page](https://github.com/boltgolt/howdy/releases) and install with gdebi.
 
 ### Arch Linux
+
 _Maintainer wanted._
 
 Install the `howdy` package from the AUR. For AUR installation instructions, take a look at this [wiki page](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages).
 
 You will need to do some additional configuration steps. Please read the [ArchWiki entry](https://wiki.archlinux.org/index.php/Howdy) for more information.
 
 ### Fedora
+
 _Maintainer: [@luyatshimbalanga](https://github.com/luyatshimbalanga)_
 
-The `howdy` package is available as a [Fedora COPR repository](https://copr.fedorainfracloud.org/coprs/luya/howdy/), install it by simply executing the following commands in a terminal:
+The `howdy` package is available as a [Fedora COPR repository](https://copr.fedorainfracloud.org/coprs/principis/howdy/), install it by simply executing the following commands in a terminal:
+
+```
+sudo dnf copr enable principis/howdy
+sudo dnf --refresh install howdy
+```
+
+*Note:* Fedora 41 [removed support for Python2](https://fedoraproject.org/wiki/Changes/RetirePython2.7), but at this point in time Howdy still depends on it. If the install fails, you can fix this by installing the beta Repository and removing the release version:
 
 ```
-sudo dnf copr enable luya/howdy
-sudo dnf install howdy
+sudo dnf copr remove principis/howdy
+sudo dnf copr enable principis/howdy-beta
+sudo dnf --refresh install howdy
 ```
 
+See the link to the COPR repository for detailed configuration steps.
+
 ### openSUSE
+
 _Maintainer: [@dmafanasyev](https://github.com/dmafanasyev)_
 
 Go to the [openSUSE wiki page](https://en.opensuse.org/SDB:Facial_authentication) for detailed installation instructions.
 
+### Building from source
+
+If you want to build Howdy from source, a few dependencies are required.
+
+#### Dependencies
+
+- Python 3.6 or higher
+  * pip
+  * setuptools
+  * wheel
+- meson version 0.64 or higher
+- ninja
+- INIReader (can be pulled from git automatically if not found)
+- libevdev
+
+To install them on Debian/Ubuntu for example:
+
+```
+sudo apt-get update && sudo apt-get install -y \
+python3 python3-pip python3-setuptools python3-wheel \
+cmake make build-essential \
+libpam0g-dev libinih-dev libevdev-dev python3-opencv \
+python3-dev libopencv-dev
+```
+
+#### Build
+
+```sh
+meson setup build
+meson compile -C build
+```
+
+You can also install Howdy to your system with `meson install -C build`.
+
 ## Setup
 
 After installation, Howdy needs to learn what you look like so it can recognise you later. Run `sudo howdy add` to add a face model.
 
-If nothing went wrong we should be able to run sudo by just showing your face. Open a new terminal and run `sudo -i` to see it in action. Please check [this wiki page](https://github.com/boltgolt/howdy/wiki/Common-issues) if you've experiencing problems or [search](https://github.com/boltgolt/howdy/issues) for similar issues.
+If nothing went wrong we should be able to run sudo by just showing your face. Open a new terminal and run `sudo -i` to see it in action. Please check [this wiki page](https://github.com/boltgolt/howdy/wiki/Common-issues) if you're experiencing problems or [search](https://github.com/boltgolt/howdy/issues) for similar issues.
 
 If you're curious you can run `sudo howdy config` to open the central config file and see the options Howdy has to offer. On most systems this will open the nano editor, where you have to press `ctrl`+`x` to save your changes.
 
@@ -82,12 +132,12 @@ howdy [-U user] [-y] command [argument]
 
 | Command   | Description                                   |
 |-----------|-----------------------------------------------|
-| `add`     | Add a new face model for an user              |
-| `clear`   | Remove all face models for an user            |
+| `add`     | Add a new face model for a user               |
+| `clear`   | Remove all face models for a user             |
 | `config`  | Open the config file in your default editor   |
 | `disable` | Disable or enable howdy                       |
-| `list`    | List all saved face models for an user        |
-| `remove`  | Remove a specific model for an user           |
+| `list`    | List all saved face models for a user         |
+| `remove`  | Remove a specific model for a user            |
 | `snapshot`| Take a snapshot of your camera input          |
 | `test`    | Test the camera and recognition methods       |
 | `version` | Print the current version number              |
@@ -100,13 +150,14 @@ Code contributions are also very welcome. If you want to port Howdy to another d
 
 ## Troubleshooting
 
-Any python errors get logged directly into the console and should indicate what went wrong. If authentication still fails but no errors are printed you could take a look at the last lines in `/var/log/auth.log` to see if anything has been reported there.
+Any Python errors get logged directly into the console and should indicate what went wrong. If authentication still fails but no errors are printed, you could take a look at the last lines in `/var/log/auth.log` to see if anything has been reported there.
 
-If you encounter an error that hasn't been reported yet, don't be afraid to open a new issue.
+Please first check the [wiki on common issues](https://github.com/boltgolt/howdy/wiki/Common-issues) and 
+if you encounter an error that hasn't been reported yet, don't be afraid to open a new issue.
 
 ## A note on security
 
-This package is in no way as secure as a password and will never be. Although it's harder to fool than normal face recognition, a person who looks similar to you or well-printed photo of you could be enough to do it. Howdy is a more quick and convenient way of logging in, not a more secure one.
+This package is in no way as secure as a password and will never be. Although it's harder to fool than normal face recognition, a person who looks similar to you, or a well-printed photo of you could be enough to do it. Howdy is a more quick and convenient way of logging in, not a more secure one.
 
 To minimize the chance of this program being compromised, it's recommended to leave Howdy in `/lib/security` and to keep it read-only.