TypoTracker

TypoTracker is a Python script designed to track keyboard inputs and send notifications when specific key bindings are activated. This tool is intended to run in any environment where Python is available, making it suitable for various use cases including analyzing typing habits and monitoring keyboard activity.

Features

• Keyboard input tracking.
• Customizable key bindings.
• Support for notification systems based on the operating system (currently only macOS).

Setup

1. Install Dependencies: TypoTracker requires pynput and yaml. Install these packages using the following command:

   pip install pynput pyyaml
   

2. Configure Settings: Edit the ttconfig.yaml file to customize the following settings:

   • log_file_path: Path to the file where logs will be saved.
   • debug_mode: Enable or disable debug mode.
   • trigger_key: Key bindings to trigger TypoTracker.
   • notification_type: Type of notification system to use ('macOS', 'Windows', 'Linux', 'None').

   Example configuration:

   log_file_path: "/path/to/logfile"
   debug_mode: False
   trigger_key:
     ctrl: True
     shift: True
     alt: False
     cmd: False
     key: 'l'
   notification_type: 'macOS'

Usage

To run the script, use the following command:

python typotracker.py

Running in a Virtual Environment

If you prefer to run TypoTracker in a virtual environment, you can follow these steps:

1. Create a Virtual Environment (Optional): If you haven't already, you can create a virtual environment using virtualenv or venv. For example, using venv:

   python -m venv env_typotracker
   

   Activate the virtual environment:

   • On macOS/Linux:

     source env_typotracker/bin/activate
     

   • On Windows:

     .\env_typotracker\Scripts\activate
     

2. Install Dependencies: Inside your virtual environment, install the required dependencies using pip as mentioned in the Setup section:

   pip install pynput pyyaml
   

3. Configure Settings: Customize the ttconfig.yaml file with your desired settings as explained in the Setup section.

4. Run TypoTracker: Run TypoTracker within the virtual environment:

   python typotracker.py
   

5. Deactivate Virtual Environment (Optional): When you're done using TypoTracker, you can deactivate the virtual environment:

   deactivate
   

This will ensure that TypoTracker runs in an isolated environment, keeping your system's Python installation unaffected.

License

This project is released under the MIT License.