aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2016-07-19 23:29:23 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2016-07-19 23:29:23 +0300
commit00a87519cce24d130f193cf8d2a540469f38efdc (patch)
tree1138bc4bfb8634dfa5f4fef7fb7621f51fd4cee2 /docs
parentminimize Pylint configuration (diff)
downloadvk-scripts-00a87519cce24d130f193cf8d2a540469f38efdc.tar.gz
vk-scripts-00a87519cce24d130f193cf8d2a540469f38efdc.zip
online_duration.py -> online_sessions.py
Diffstat (limited to 'docs')
-rw-r--r--docs/online_sessions.md (renamed from docs/online_duration.md)24
-rw-r--r--docs/track_status.md4
2 files changed, 14 insertions, 14 deletions
diff --git a/docs/online_duration.md b/docs/online_sessions.md
index f5c703b..e6b4b08 100644
--- a/docs/online_duration.md
+++ b/docs/online_sessions.md
@@ -1,4 +1,4 @@
-online_duration.py
+online_sessions.py
==================
View/visualize the amount of time people spend online.
@@ -9,8 +9,8 @@ Usage
Run from the top-level directory using `python -m`:
```
-> python -m bin.online_duration -h
-usage: online_duration.py [-h] [-g {user,date,weekday,hour}]
+> python -m bin.online_sessions -h
+usage: online_sessions.py [-h] [-g {user,date,weekday,hour}]
[-i {csv,log,null}] [-o {csv,json,plot}]
[-a TIME_FROM] [-b TIME_TO]
input [output]
@@ -24,7 +24,7 @@ For example (assuming the database in "db.csv" was generated by
[track_status.py] before):
```
-> python -m bin.online_duration db.csv
+> python -m bin.online_sessions db.csv
89497105,John,Smith,john.smith,0:12:31
3698577,Jane,Smith,jane.smith,1:34:46
```
@@ -36,7 +36,7 @@ The output format is CSV (comma-separated values) by default.
You can also get a JSON document:
```
-> python -m bin.online_duration --output-format json db.csv
+> python -m bin.online_sessions --output-format json db.csv
[
{
"uid": 89497105,
@@ -63,7 +63,7 @@ For example (assuming that both Jane and Joe spent their time online on Friday,
June 17, 2016).
```
-> python -m bin.online_duration --output-format json --group-by date db.csv
+> python -m bin.online_sessions --output-format json --group-by date db.csv
[
{
"date": "2016-06-17",
@@ -73,7 +73,7 @@ June 17, 2016).
```
```
-> python -m bin.online_duration --output-format csv --group-by weekday db.csv
+> python -m bin.online_sessions --output-format csv --group-by weekday db.csv
Monday,0:00:00
Tuesday,0:00:00
Wednesday,0:00:00
@@ -84,7 +84,7 @@ Sunday,0:00:00
```
```
-> python -m bin.online_duration --group-by hour db.csv
+> python -m bin.online_sessions --group-by hour db.csv
0:00:00,0:00:00
1:00:00,0:00:00
2:00:00,0:00:00
@@ -117,25 +117,25 @@ To produce a plot, pass `plot` as the `--output-format` parameter value and add
a file path to write the image to.
```
-> python -m bin.online_duration --output-format plot db.csv user.png
+> python -m bin.online_sessions --output-format plot db.csv user.png
```
![user.png]
```
-> python -m bin.online_duration --output-format plot --group-by date db.csv date.png
+> python -m bin.online_sessions --output-format plot --group-by date db.csv date.png
```
![date.png]
```
-> python -m bin.online_duration --output-format plot --group-by weekday db.csv weekday.png
+> python -m bin.online_sessions --output-format plot --group-by weekday db.csv weekday.png
```
![weekday.png]
```
-> python -m bin.online_duration --output-format plot --group-by hour db.csv hour.png
+> python -m bin.online_sessions --output-format plot --group-by hour db.csv hour.png
```
![hour.png]
diff --git a/docs/track_status.md b/docs/track_status.md
index be4764a..8fe0746 100644
--- a/docs/track_status.md
+++ b/docs/track_status.md
@@ -30,11 +30,11 @@ For example (using made up user IDs/"screen names"),
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 using
-[online_duration.py], specify the path to a database using the `--output`
+[online_sessions.py], specify the path to a database using the `--output`
parameter.
Be careful: if the file already exists, it will be overwritten!
-[online_duration.py]: online_duration.md
+[online_sessions.py]: online_sessions.md
See also
--------