SocialWatch Module

This module fetches contacts and calendar events from a CalDAV+CardDAV server and presents a bunch of information about your social activity.

Setup

(This module lives at /modules/socialwatch)

Make sure to install all the dependencies in requirements.txt
Copy .env.example to .env and populate all fields

Usage

Calendar

All events from the specified calendar will be treated as social gatherings. In the summary section of the event, you can list the names of participants by prefixing them with CALDAV_PARTICIPANT_PREFIX (set in .env). One name per line is allowed. Names will be matched with CardDAV names, or nicknames if available (preferred).

Contacts

If there is a contact you want to exclude from tracking, even though they're included in events already, just add CARDDAV_IGNORE_STR to the notes field.

Endpoints

Endpoint	Contents
`GET /modules/socialwatch/api/events`	List of all calendar events
`GET /modules/socialwatch/api/people`	List of all contacts
`GET /modules/socialwatch/api/people/<person-uid>`	Info about a person, by their UID
`GET /modules/socialwatch/api/events/<person-uid>`	Info about an event, by its UID
`GET /modules/socialwatch/api/people/<person-uid>/photo`	A person's profile picture, if they have one
`GET /modules/socialwatch/api/scores`	Information about social scores (frequency, diversity, total)

1.4 KiB Raw Permalink Blame History