Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ActivityWatch/aw-watcher-input
Track your keypresses and mouse movements with ActivityWatch
https://github.com/ActivityWatch/aw-watcher-input
activitywatch activitywatch-watcher input keyboard-events mouse-events
Last synced: 5 days ago
JSON representation
Track your keypresses and mouse movements with ActivityWatch
- Host: GitHub
- URL: https://github.com/ActivityWatch/aw-watcher-input
- Owner: ActivityWatch
- Created: 2020-11-23T11:48:55.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T16:38:32.000Z (22 days ago)
- Last Synced: 2024-10-30T00:54:48.150Z (10 days ago)
- Topics: activitywatch, activitywatch-watcher, input, keyboard-events, mouse-events
- Language: Python
- Size: 169 KB
- Stars: 109
- Watchers: 7
- Forks: 20
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - ActivityWatch/aw-watcher-input - Track your keypresses and mouse movements with ActivityWatch (others)
README
aw-watcher-input
================Track your keypresses and mouse movements with [ActivityWatch](https://activitywatch.net).
NOTE: Work in progress, contributions welcome!
NOTE: This does not track *which* keys you press, only that you pressed any key some number of times in a given time span. This is **not a keylogger**, and never will be (due to the massive security and privacy implications).
# Build
Make sure you have Python 3.7+ and `poetry` installed, then install with `poetry install`.
# Usage
Run `poetry run aw-watcher-input --help` for usage instructions.
We might eventually create binary builds (like the ones bundled with ActivityWatch for aw-watcher-afk and aw-watcher-window) to make it easier to get this watcher up and running, but it's still a bit too early for that.
## Custom visualization
This watcher ships with an **experimental** custom visualization which needs special configuration.
**NOTE:** This is a work-in-progress. Custom visualizations is an experimental feature with little to no decent documentation, so far.
First, you need to build it, which you can do by:
```sh
cd visualization/
npm install -g pug-cli browserify # might need sudo
npm install
make build
```You can then configure aw-server or aw-server-rust to host the custom visualization.
To do so for aw-server, add the following to your config file (with the correct path!):
```toml
[server.custom_static]
aw-watcher-input = "/home/user/path/to/aw-watcher-input/visualization/dist"
```For aw-server-rust, instead add the following to your config file (with the correct path!):
```toml
[custom_static]
aw-watcher-input = "/home/user/path/to/aw-watcher-input/visualization/dist"
```You then need to restart aw-server/aw-server-rust for the changes to take effect.
Once the server is restarted, you can open the Activity view in the web UI, click "Edit view", then "Add visualization", then click the cogwheel and select "Custom visualization". This will open a popup asking for which visualization, here enter "aw-watcher-input".
It should now work. Click save and you're done!
# Notes
This was massively inspired by ulogme by @karpathy, here's a screenshot of how it looks:
![screenshot of ulogme](https://karpathy.github.io/assets/ulogme_sv2.jpeg)
The idea is that we can do the same thing with ActivityWatch, and this watcher is an attempt to incorporate this specific part.
Here's a link to the blog post where he presents it: https://karpathy.github.io/2014/08/03/quantifying-productivity/