From efcf1ae4a8f503446d43c936098a609be572385b Mon Sep 17 00:00:00 2001 From: Patrick Lenihan Date: Mon, 3 Feb 2025 13:39:34 +0000 Subject: [PATCH 1/6] Make the install from source page easier to find --- src/getting-started.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/getting-started.rst b/src/getting-started.rst index 5e67a12..18c68fe 100644 --- a/src/getting-started.rst +++ b/src/getting-started.rst @@ -33,6 +33,9 @@ Installation .. note:: Getting it to F-droid is a work-in-progress, see `this PR `_. + .. group-tab:: Source + + If you prefer to build ActivityWatch from source, check out :doc:`this guide ` instead. Usage ===== From 48dd40ced2d7e0b34d44016e5f999597ef8860d7 Mon Sep 17 00:00:00 2001 From: Patrick Lenihan Date: Mon, 3 Feb 2025 13:40:04 +0000 Subject: [PATCH 2/6] Warn about Wayland support --- src/getting-started.rst | 4 ++++ src/installing-from-source.rst | 3 +++ src/watchers.rst | 19 +++++++++++-------- 3 files changed, 18 insertions(+), 8 deletions(-) diff --git a/src/getting-started.rst b/src/getting-started.rst index 18c68fe..e81bcec 100644 --- a/src/getting-started.rst +++ b/src/getting-started.rst @@ -37,6 +37,7 @@ Installation If you prefer to build ActivityWatch from source, check out :doc:`this guide ` instead. + Usage ===== @@ -51,6 +52,9 @@ If you want more advanced ways to run ActivityWatch (including running it withou .. note:: If you are running GNOME 3 or another desktop environment that does not support system trays, or if for some reason Qt can't be used on your machine, read `Running on GNOME`. +.. note:: + If your Linux system is using Wayland rather than X11, the default watchers will not work. Read :ref:`window and idle watchers for Wayland`. + .. note:: If you are using a proxy ActivityWatch might not work out of the box. To fix this you can set the environment variable ``NO_PROXY`` to include ``127.0.0.1`` before starting aw-qt. How to set an environment variable depends on your operating system; use Google if you are unsure how to do this. diff --git a/src/installing-from-source.rst b/src/installing-from-source.rst index 9983007..ef8a843 100644 --- a/src/installing-from-source.rst +++ b/src/installing-from-source.rst @@ -28,6 +28,9 @@ If you want to ensure you have the latest version of all submodules, preserving git submodule foreach --recursive git pull +.. note:: + If your Linux system is using Wayland rather than X11, the default watchers will not work. Read :ref:`window and idle watchers for Wayland` for replacement modules supporting Wayland. + Checking dependencies --------------------- diff --git a/src/watchers.rst b/src/watchers.rst index 547115e..33437ea 100644 --- a/src/watchers.rst +++ b/src/watchers.rst @@ -3,7 +3,7 @@ Watchers Watchers are the parts of ActivityWatch that do all the data collecting. -ActivityWatch comes with two watchers enabled by default: +ActivityWatch comes with two watchers enabled by default supporting Windows, macOS and Linux (X11 only): - :gh-aw:`aw-watcher-afk` - Watches for mouse & keyboard activity to detect if the user is active (by default, an inactive period of at least 3 minutes is flagged as AFK: away from keyboard). - :gh-aw:`aw-watcher-window` - Watches the active window, its title, and it's url (on Chrome-based browsers & Safari). @@ -11,16 +11,19 @@ ActivityWatch comes with two watchers enabled by default: These default watchers are collecting some of the most important data. But there is more to collect, so here are some other watchers that let you do so. -.. _window-watchers: +.. note:: + For Wayland, see :ref:`wayland-watchers`. -Window watchers ---------------- +.. _wayland-watchers: + +Window and idle watchers for Wayland +------------------------------------------- -Watches the active window, its title, and application name. +Replaces :gh-aw:`aw-watcher-window` and :gh-aw:`aw-watcher-afk` to support Wayland, see issue :issue:`92`. -- :gh-aw:`aw-watcher-window` - The official window watcher for Windows, macOS, and Linux (X11 only). -- :gh-aw:`aw-watcher-window-wayland` - A window watcher for Wayland, by :gh-user:`johan-bjareholt`. -- :gh:`2e3s/awatcher` - A compiled watcher for X11 and Wayland to replace default window and AFK watchers, by :gh-user:`2e3s`. +- :gh-aw:`aw-watcher-window-wayland` - A window and idle watcher for Wayland, by :gh-user:`johan-bjareholt`, supports Posh, Sway. +- :gh:`2e3s/awatcher` - A compiled window and idle watcher for X11 and Wayland to replace default window and AFK watchers, + by :gh-user:`2e3s`, supports Sway, Hyprland, KDE, GNOME, and X11. Browser watchers ---------------- From e0a0cee3b2c76f305b0243b8d8a84e83fd59d9a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erik=20Bj=C3=A4reholt?= Date: Sun, 11 May 2025 13:03:22 +0200 Subject: [PATCH 3/6] docs: mention activitywatch-bin AUR package name explicitly --- src/getting-started.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/getting-started.rst b/src/getting-started.rst index e81bcec..b5aa1d0 100644 --- a/src/getting-started.rst +++ b/src/getting-started.rst @@ -24,7 +24,7 @@ Installation Download the `latest release from GitHub `_, unzip the archive into an appropriate directory, and add the ``aw-qt`` executable to your autostart applications. .. note:: - If you are using Arch Linux you can install ActivityWatch directly from `the AUR `_. + If you are using Arch Linux you can install using the official ``activitywatch-bin`` package in `the AUR `_. .. group-tab:: Android From ff00f4b96957126159b04f57f77a6e27e9df3613 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erik=20Bj=C3=A4reholt?= Date: Sun, 11 May 2025 13:06:40 +0200 Subject: [PATCH 4/6] ci: update Python to 3.12 --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 18b1954..fe4a294 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -17,7 +17,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v1 with: - python-version: 3.8 + python-version: 3.12 - name: Install APT dependencies run: | sudo apt-get install -y git build-essential apt-utils wget libfreetype6 libpng-dev libopenblas-dev gcc gfortran libsnappy-dev From 0d18382465b78cef818f7d0876bd9528f52e6ce9 Mon Sep 17 00:00:00 2001 From: Patrick Lenihan Date: Thu, 15 May 2025 16:36:18 +0100 Subject: [PATCH 5/6] Addressed feedback from @ErikBjare in PR #146 (ActivityWatch/docs): https://github.com/ActivityWatch/docs/pull/146 Restructured references and text, and removed the note from installing from source page. --- src/getting-started.rst | 2 +- src/installing-from-source.rst | 3 --- src/watchers.rst | 7 ++----- 3 files changed, 3 insertions(+), 9 deletions(-) diff --git a/src/getting-started.rst b/src/getting-started.rst index b5aa1d0..8c70117 100644 --- a/src/getting-started.rst +++ b/src/getting-started.rst @@ -53,7 +53,7 @@ If you want more advanced ways to run ActivityWatch (including running it withou If you are running GNOME 3 or another desktop environment that does not support system trays, or if for some reason Qt can't be used on your machine, read `Running on GNOME`. .. note:: - If your Linux system is using Wayland rather than X11, the default watchers will not work. Read :ref:`window and idle watchers for Wayland`. + If your Linux system is using Wayland rather than X11, the default watchers will not work. See :ref:`window watchers `. .. note:: If you are using a proxy ActivityWatch might not work out of the box. To fix this you can set the environment variable ``NO_PROXY`` to include ``127.0.0.1`` before starting aw-qt. How to set an environment variable depends on your operating system; use Google if you are unsure how to do this. diff --git a/src/installing-from-source.rst b/src/installing-from-source.rst index ef8a843..9983007 100644 --- a/src/installing-from-source.rst +++ b/src/installing-from-source.rst @@ -28,9 +28,6 @@ If you want to ensure you have the latest version of all submodules, preserving git submodule foreach --recursive git pull -.. note:: - If your Linux system is using Wayland rather than X11, the default watchers will not work. Read :ref:`window and idle watchers for Wayland` for replacement modules supporting Wayland. - Checking dependencies --------------------- diff --git a/src/watchers.rst b/src/watchers.rst index 33437ea..668826b 100644 --- a/src/watchers.rst +++ b/src/watchers.rst @@ -11,12 +11,9 @@ ActivityWatch comes with two watchers enabled by default supporting Windows, mac These default watchers are collecting some of the most important data. But there is more to collect, so here are some other watchers that let you do so. -.. note:: - For Wayland, see :ref:`wayland-watchers`. - -.. _wayland-watchers: +.. _window-watchers: -Window and idle watchers for Wayland +Window watchers ------------------------------------------- Replaces :gh-aw:`aw-watcher-window` and :gh-aw:`aw-watcher-afk` to support Wayland, see issue :issue:`92`. From 5d5c24979410048196b4e71aac5e333d4c05c521 Mon Sep 17 00:00:00 2001 From: Patrick Lenihan Date: Thu, 15 May 2025 16:48:42 +0100 Subject: [PATCH 6/6] Seperated Wayland Watchers into their own section --- src/getting-started.rst | 2 +- src/watchers.rst | 10 ++++++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/src/getting-started.rst b/src/getting-started.rst index 8c70117..ad56316 100644 --- a/src/getting-started.rst +++ b/src/getting-started.rst @@ -53,7 +53,7 @@ If you want more advanced ways to run ActivityWatch (including running it withou If you are running GNOME 3 or another desktop environment that does not support system trays, or if for some reason Qt can't be used on your machine, read `Running on GNOME`. .. note:: - If your Linux system is using Wayland rather than X11, the default watchers will not work. See :ref:`window watchers `. + If your Linux system is using Wayland rather than X11, the default watchers will not work. See :ref:`wayland watchers `. .. note:: If you are using a proxy ActivityWatch might not work out of the box. To fix this you can set the environment variable ``NO_PROXY`` to include ``127.0.0.1`` before starting aw-qt. How to set an environment variable depends on your operating system; use Google if you are unsure how to do this. diff --git a/src/watchers.rst b/src/watchers.rst index 668826b..b64fe49 100644 --- a/src/watchers.rst +++ b/src/watchers.rst @@ -3,6 +3,12 @@ Watchers Watchers are the parts of ActivityWatch that do all the data collecting. + +.. _window-watchers: + +Window watchers +------------------------------------------- + ActivityWatch comes with two watchers enabled by default supporting Windows, macOS and Linux (X11 only): - :gh-aw:`aw-watcher-afk` - Watches for mouse & keyboard activity to detect if the user is active (by default, an inactive period of at least 3 minutes is flagged as AFK: away from keyboard). @@ -11,9 +17,9 @@ ActivityWatch comes with two watchers enabled by default supporting Windows, mac These default watchers are collecting some of the most important data. But there is more to collect, so here are some other watchers that let you do so. -.. _window-watchers: +.. _wayland-watchers: -Window watchers +Wayland watchers ------------------------------------------- Replaces :gh-aw:`aw-watcher-window` and :gh-aw:`aw-watcher-afk` to support Wayland, see issue :issue:`92`.