Client library for ActivityWatch
Project description
aw-client
Client library for ActivityWatch in Python.
Please see the documentation for usage, and take a look at examples/
.
How to install
Install from pip: pip install aw-client
Install the latest version directly from github without cloning: pip install git+https://github.com/ActivityWatch/aw-client.git
To install from a cloned version:
- clone repo:
git clone https://github.com/ActivityWatch/aw-client.git
- cd into the directory:
cd aw-client
- run
poetry install
(will create a virtualenv, if none activated)- If you don't want to use poetry you can also use
pip install .
, but that might not get the exact version of the dependencies (due to not reading thepoetry.lock
file).
- If you don't want to use poetry you can also use
Usage
For the CLI:
$ aw-client --help
Usage: aw-client [OPTIONS] COMMAND [ARGS]...
CLI utility for aw-client to aid in interacting with the ActivityWatch
server
Options:
--host TEXT Address of host
--port INTEGER Port to use
-v, --verbose Verbosity
--testing Set to use testing ports by default
--help Show this message and exit.
Commands:
buckets List all buckets
canonical Query 'canonical events' for a single host (filtered,...
events Query events from bucket with ID `bucket_id`
heartbeat Send a heartbeat to bucket with ID `bucket_id` with JSON `data`
query Run a query in file at `path` on the server
report Generate an activity report
Debugging
- Run python with
LOG_LEVEL=debug
to get additional debugging output - If invalid events have been queued for submission, you may need to delete the file-based queues generated by this library
- To use the development version of this library use
aw-client = {path = "../aw-client" }
inpyproject.toml
Examples
The examples/
directory contains a couple of example scripts, including:
time_spent_today.py
- fetches all non-afk events and sums their duration to get the total active time for the day.working_hours.py
- computes hours worked per day (matching a "work" category rule), and exports matching events to a JSON file (for auditing).load_dataframe.py
- loads events from a host using a categorizing & AFK-filtering query, put result in a pandas dataframe, and export as CSV.merge_buckets.py
- merges two buckets with non-intersecting events by moving all events from one into the other.redact_sensitive.py
- redact sensitive events.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
aw_client-0.5.12.tar.gz
(20.0 kB
view details)
Built Distribution
File details
Details for the file aw_client-0.5.12.tar.gz
.
File metadata
- Download URL: aw_client-0.5.12.tar.gz
- Upload date:
- Size: 20.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.0 CPython/3.9.9 Darwin/21.6.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 824b5e83abe755d5f089bbbf87eaabdc8895220c1642904a5aa6b66fba09b6ba |
|
MD5 | 47852b9e6c6f56d6c75436a350825788 |
|
BLAKE2b-256 | 1dac0c80c62b0417d23f7550224acb8909fee750e83db1d0ab2778b808779e9e |
File details
Details for the file aw_client-0.5.12-py3-none-any.whl
.
File metadata
- Download URL: aw_client-0.5.12-py3-none-any.whl
- Upload date:
- Size: 21.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.0 CPython/3.9.9 Darwin/21.6.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12bd6cbc02a06e970267f7f192a31a0036b4a9f9ae0852bd0a8bc718b9b8ea5a |
|
MD5 | 5c98ef3242b0339a11fcc68dc2ba515b |
|
BLAKE2b-256 | c33b7787f889fc1b568528a36d7bda82bfded1f331a55e9916fa632cafaf97b1 |