Skip to content

writing-watchers.rst

Latest commit

 

History

History
36 lines (24 loc) · 983 Bytes

writing-watchers.rst

File metadata and controls

36 lines (24 loc) · 983 Bytes
Raw

Writing your first watcher

Writing watchers for ActivityWatch is pretty easy, all you need is the aw-client library.

Note

These examples runs the client in testing mode, which means that it will try to connect to a aw-server in testing mode on the port 5666 instead of the normal 5600.

Minimal client

Below is a minimal template client to quickly get started. This example will:

  • create a bucket
  • insert an event
  • fetch an event from an aw-server bucket
  • delete the bucket again
.. literalinclude:: examples/minimal_client.py

Reference client

Below is a example of a watcher with more in-depth comments. This example will describe how to:

  • how to create buckets
  • how to send events by heartbeats
  • how to insertion events without heartbeats
  • how to do syncronous as well as asyncronous requests
  • fetch events from a aw-server bucket
  • delete buckets
.. literalinclude:: examples/client.py