Skip to content

Why Vigilant Palm Tree? Well, GitHub proposed this auto-generated name. So, here we go. It matches the purpose of the project, though. Coincidence? We don't think so.

IamMaxim/vigilant-palm-tree

Repository files navigation

Vigilant Palm Tree

A research tool that allows collecting audio/video data to predict a person's state of work engagement and correlate that data with that person's keyboard/mouse activity.

Installation

Install the dependencies using

pipenv install

If you are running Linux, you might need to manually install the PortAudio library (might be called libportaudio2 or similar), as well as the libsndfile library (called libsndfile1 or similar). On Windows/macOS, they are automatically installed.

On Debian/Ubuntu, you can do that using:

sudo apt install libportaudio2 libsndfile1

On Arch Linux, use:

sudo pacman -Sy portaudio libsndfile

Usage

Run pipenv run vpt <subcommand>. For detailed usage information, run pipenv run vpt -h.

If you are using Linux, you might need to run some commands as root (or with sudo) as mouse recording and keyboard recording require it.

Bundling

To bundle the application as a distributable executable, run pipenv run bundle-win on Windows, or pipenv run bundle-unix on most unix-based systems. The resulting program can be found in the "dist/vpt" folder, with the exeuctable file itself called vpt.

Note: The Windows version requires that the "Microsoft C++ Redistributable for Visual Studio 2015, 2017 and 2019" be installed on the system before running. They are not bundled with the program.

About

Why Vigilant Palm Tree? Well, GitHub proposed this auto-generated name. So, here we go. It matches the purpose of the project, though. Coincidence? We don't think so.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages