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.15.tar.gz
(20.5 kB
view details)
Built Distribution
File details
Details for the file aw_client-0.5.15.tar.gz
.
File metadata
- Download URL: aw_client-0.5.15.tar.gz
- Upload date:
- Size: 20.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.9.9 Darwin/22.6.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
d6b0aeae82ded2dc0469b29109068d01ddf9e4195a5b7b8055849173b5edff7e
|
|
MD5 |
2839bd82501586f00a81ee8753fd42b5
|
|
BLAKE2b-256 |
f72210e30a013ae9f197194846966ebf38128a87c5249f6a475628d24f359938
|
File details
Details for the file aw_client-0.5.15-py3-none-any.whl
.
File metadata
- Download URL: aw_client-0.5.15-py3-none-any.whl
- Upload date:
- Size: 21.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.9.9 Darwin/22.6.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
2d2a61d1d75e29d1e850aca1bc3390f40536929d361c7a891ed9fb394844ad50
|
|
MD5 |
cd027da9ab165106396c29c18124335c
|
|
BLAKE2b-256 |
6a0c7003298b33a5fafefe786fca96dec2018829d4465c54313419ad5eb1ca10
|