https://github.com/pizzapanther/zulip-doc
Zulip service that checks user presence for Duty of Care responsibilities for remote teams
https://github.com/pizzapanther/zulip-doc
Last synced: 3 months ago
JSON representation
Zulip service that checks user presence for Duty of Care responsibilities for remote teams
- Host: GitHub
- URL: https://github.com/pizzapanther/zulip-doc
- Owner: pizzapanther
- License: mit
- Created: 2023-08-01T15:00:21.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-02T14:53:11.000Z (almost 2 years ago)
- Last Synced: 2025-03-22T13:04:41.038Z (3 months ago)
- Language: Python
- Homepage: https://pypi.org/project/zulip-doc/
- Size: 15.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zulip Duty of Care Service
A small script to check user presence in Zulip. If a user hasn't been around for a while it will send you a message in Zulip so you can check up on them and see if they are ok.
## Install
`pipx install zulip-doc`
Then setup your `.zuliprc` file (for API usage):
```
[api]
key=
email=
site=
```
## Usage
```
Usage: zdoc [OPTIONS] [SEND_TO]...
Arguments:
[SEND_TO]...
Options:
--max-idle INTEGER [env var: MAX_IDLE; default: 86400]
--ignore-weekends / --no-ignore-weekends
[env var: IGNORE_WEEKENDS; default: ignore-
weekends]
--config-file FILE [env var: CONFIG_FILE; default:
/home/{username}/.zuliprc]
--help Show this message and exit.
```
Example: `zdoc 12 22`
## Cron Job Setup
`crontab -e`
Then add something like:
`0 12 * * * /home/paul/.local/bin/zdoc --config-file /home/paul/.zuliprc 12 22`
*runs everyday at noon*