mdabbagh88 / activitywatch Goto Github PK

Records what you do so that you can know how you've spent your time.
All in a secure way where you control the data.

Website — Forum — Documentation — Releases
Contributor stats — CI overview

Do you want to receive email updates on major announcements?
Signup for the newsletter!

The goal of ActivityWatch is simple: Enable the collection of as much valuable lifedata as possible without compromising user privacy.

We've worked towards this goal by creating a application for safe storage of the data on the users local machine and as well as a set of watchers which record data such as:

• Currently active application and the title of its window
• Currently active browser tab and it's title and URL
• Keyboard and mouse activity, to detect if you are afk or not

It is up to you as user to collect as much as you want, or as little as you want (and we hope some of you will help write watchers so we can collect more).

Note: This screenshot is outdated and alone, we will fix that Soon™.

Downloads are available on our releases page.

For instructions on how to get started, please see our guide in the documentation.

Interested in building from source? There's a guide for that too.

Yes, but we found that most time trackers lack in one or more important features.

Common dealbreakers:

• Not open source
• The user does not own the data (common with non-open source options)
• Lack of synchronization (and when available: it's centralized and the sync server knows everything)
• Difficult to setup/use (most open source options tend to target programmers)
• Low data resolution (low level of detail, does not store raw data, long intevals between entries)
• Hard or impossible to extend (collecting more data is not as simple as it could be)

To sum it up:

• Closed source solutions suffer from privacy issues and limited features.
• Open source solutions aren't developed with end-users in mind and are usually not written to be easily extended (they lack a proper API). They also lack synchronization.

We have a plan to address all of these and we're well on our way. See the table below for our progress.

For a complete list of the things ActivityWatch can track, see the page on watchers in the documentation.

This repo is a bundle of the core components and official modules of ActivityWatch (managed with git submodule). It's primary use is as a meta-package providing all the components in one repo; enabling easier packaging and installation. It is also where releases of the full suite are published (see releases).

aw-server is the official implementation of the core service which the other ActivityWatch services interact with. It provides a REST API to a datastore and query engine. It also serves the web interface developed in the aw-webui project (which provides the frontend part of the webapp).

The REST API includes:

• Access to a datastore suitable for timeseries/timeperiod-data
• A query engine and language for such data

The webapp includes:

• Data visualization & browser
• Query explorer
• Export functionality
  • Import is not currently implemented, see issue #103.

• aw-watcher-afk - logs the presence/absence of user activity from keyboard and mouse input
• aw-watcher-window - logs the currently active application and it's window title
• aw-watcher-web - logs your web browsing in better detail (notably the URL in addition to the title of the page)

• aw-core - core library, provides no runnable modules
• aw-client - client library, useful when writing watchers

Want to help? Great! Check out the CONTRIBUTING.md file!

Have a question, suggestion, problem, or just want to say hi? Post on the forum!