https://github.com/azaurus1/lifevisor
System for syncing local Activitywatch data to Metabase for Data analytics
https://github.com/azaurus1/lifevisor
activitywatch analytics go kubernetes
Last synced: 4 months ago
JSON representation
System for syncing local Activitywatch data to Metabase for Data analytics
- Host: GitHub
- URL: https://github.com/azaurus1/lifevisor
- Owner: azaurus1
- Created: 2024-12-13T04:07:15.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-01-25T09:51:47.000Z (4 months ago)
- Last Synced: 2025-01-25T10:24:35.837Z (4 months ago)
- Topics: activitywatch, analytics, go, kubernetes
- Language: Go
- Homepage:
- Size: 30.3 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# lifevisor
---
# **Lifevisor**
**Lifevisor** is a quantified self-data platform designed to empower users with insights into their screentime habits. Built on top of ActivityWatch, it aggregates, analyses, and visualises screentime data to help users make informed decisions about their productivity and digital habits.
---
## **Tech Stack**
- **ActivityWatch**: Screentime tracking and data generation.
- **PostgreSQL**: Reliable database for syncing and storing activity data every 5 minutes.
- **Metabase**: Powerful visualization tool for creating customizable dashboards and reports.
---
## **Getting Started**
### **Prerequisites**
- [Go](https://go.dev/doc/install): Ensure Go is installed on your system.
- PostgreSQL: A running PostgreSQL database instance.
- ActivityWatch: Install and configure ActivityWatch to track screentime.
---
### **Installation**
1. **Clone the Repository**:
```bash
git clone https://github.com/azaurus1/lifevisor.git
cd lifevisor
```
2. **Build the CLI Application**:
```bash
cd app
go build -o lifevisor main.go
```
This will generate the `lifevisor` binary in the current directory.
3. **Move the Binary to Your Path**:
For easier usage, move the `lifevisor` binary to a directory in your system’s PATH:
```bash
mv lifevisor /usr/local/bin/
```
---
### **Initial Setup**
Before syncing data, initialize the platform with the `init` command:
```bash
lifevisor init pg
```
- **``**: Path to your ActivityWatch SQLite database file, typically `~/.local/share/activitywatch/aw-server/peewee-sqlite.v2.db`.
- **``**: Connection string for your PostgreSQL database (e.g., `postgres://username:password@host:port/dbname`).
- **``**: Number of records to process in each batch during synchronization.
**Example**:
```bash
lifevisor init pg ~/.local/share/activitywatch/aw-server/peewee-sqlite.v2.db postgres://postgres:[email protected]:30136/lifevisor 10000
```
---
### **Set Up the Cronjob**
To keep your data up-to-date, configure a cronjob to run the `sync` command every 5 minutes:
1. Open your crontab editor:
```bash
crontab -e
```
2. Add the following entry:
```bash
*/5 * * * * /usr/local/bin/lifevisor sync pg ~/.local/share/activitywatch/aw-server/peewee-sqlite.v2.db postgres://postgres:[email protected]:30136/lifevisor 300
```
- **`sync` Command**: Updates the PostgreSQL database with the latest data from ActivityWatch.
- **``**: Same as above.
- **``**: Same as above.
- **`300`**: Sync records within the last 300 seconds (5 minutes).
**Note**: Replace `/usr/local/bin/lifevisor` with the actual path to your `lifevisor` binary if it differs.
---
### **Verify Setup**
1. Run the `sync` command manually to ensure it works:
```bash
lifevisor sync pg ~/.local/share/activitywatch/aw-server/peewee-sqlite.v2.db postgres://postgres:[email protected]:30136/lifevisor 300
```
2. Check your PostgreSQL database to confirm that screentime data is being updated.
3. Verify that the cronjob is running as expected by checking your system logs:
```bash
grep CRON /var/log/syslog
```