diff options
Diffstat (limited to 'docs/track_status.md')
| -rw-r--r-- | docs/track_status.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/track_status.md b/docs/track_status.md new file mode 100644 index 0000000..8bbb380 --- /dev/null +++ b/docs/track_status.md @@ -0,0 +1,42 @@ +track_status.py +=============== + +Track when people go online/offline. + +Usage +----- + +Run from the top-level directory using `python -m`. +For example: + + > python -m bin.track_status -h + usage: track_status.py [-h] [-t TIMEOUT] [-l LOG] + [--output-format {csv,log,null}] [-o OUTPUT] + UID [UID ...] + ... + +For example (using made up user IDs/"screen names"), + + > track_status.py john.doe jane.smith + [2016-06-18 01:43:34] John Doe is ONLINE. + [2016-06-18 01:43:34] John Doe was last seen at 2016-06-18 01:33:58+03:00 using the official iPhone app. + [2016-06-18 01:43:34] Jane Smith is OFFLINE. + [2016-06-18 01:43:34] Jane Smith was last seen at 2016-06-18 01:15:47+03:00 using the web version (or an unrecognized app). + [2016-06-18 01:59:09] Jane Smith went ONLINE. + [2016-06-18 01:59:09] Jane Smith was last seen at 2016-06-18 01:59:07+03:00 using the official Android app. + [2016-06-18 02:10:00] John Doe went OFFLINE. + [2016-06-18 02:10:00] John Doe was last seen at 2016-06-18 01:54:58+03:00 using the official iPhone app. + ... + +By default, the script produces a human-readable log. +Use the `--log` parameter to write the log to a file. +If you want to record when people go online/offline for [further analysis], +specify the path to a database using the `--output` parameter. +Be careful: if the file already exists, it will be overwritten! + +See also +-------- + +* [License] + +[License]: ../README.md#license |