Index of /besson/publis/selfspy-vis

	Name	Last modified	Size	Description
	Parent Directory		-	Root of the website (in English or in French)
	LICENSE	2016-01-31 22:36	34K
	clicks-hours.png	2016-02-04 11:51	42K
	clicks-total.png	2016-02-04 11:51	27K
	git-complete-stats.txt	2016-02-04 11:44	512
	keystrokes-hours.png	2016-02-04 11:51	43K
	keystrokes-total.png	2016-02-04 11:51	28K
	requirements.txt	2016-01-31 22:36	26
	selfvis.py	2016-06-20 21:38	28K
	simplification_rules.txt	2016-02-04 11:44	1.0K
	selfvis.html	2016-02-01 10:21	953	Selfstats Visualization
	README.md	2016-06-27 21:59	3.7K	Some details about this page

# Visualization for selfspy | Plots for selfstats
## Examples
### :mouse: *Clicks*
#### Last hours (*bar* chart)
![Clicks Hours](clicks-hours.png)

#### Total (*pie* chart)
![Clicks Total](clicks-total.png)

### :musical_keyboard: *Keystrokes*
#### Last hours (*bar* chart)
![Keystrokes Hours](keystrokes-hours.png)

#### Total (*pie* chart)
![Keystrokes Total](keystrokes-total.png)

### Other visualizations
> Not yet :santa:.

----

## Command line
The graphs above have been generated by these commands.

You need to add [selfvis.py](./selfvis.py) in your PATH.
And then run:

    $ selfvis.py --human-readable --pactive --back 8 h

Or:

    $ selfvis.py --human-readable --ratios --back 8 h

----

## Installation
Install [selfspy](https://github.com/gurgeh/selfspy), then the requirements with [pip](http://www.pip-installer.org/) :

    $ pip install -r requirements.txt

You might need to give it [sudo rights](https://help.ubuntu.com/community/RootSudo) :

    $ sudo pip install -r requirements.txt

## Usage
The script is a modified version of the [`selfstats` program](https://github.com/gurgeh/selfspy#example-statistics).
The same options apply. Try e.g.

    $ python selfvis.py

## Code status
Currently implemented is a breakdown of hours (stacked bar chart) and a pie
chart (all time totals).
Both plots are saved for [clicks](clicks-total.png) and for [keypresses](keystrokes-total.png), respectively.

It's very likely that long intervals aren't split correctly.

## :wrench: Options
Filtering options of original `selfstats` continue to work.
[See here](https://github.com/gurgeh/selfspy#selfstats-reference).

----

## :memo: Config
In  `~/.selfspy/simplification_rules.txt`, add rules of the form
``regexp --> name``

For examples:

    ^\s*::\s*$ --> unknown
    ^(.+)::\s*$ --> \1
    ^(.+)::.*$ --> \1
    # ^(.+)::(\w+).*$ --> \1:\2
    ^Firefox::.*YouTube.*$ --> Browser (Youtube)
    ^Firefox::.*GitHub.*$ --> Browser (GitHub)
    ^Firefox::.*Google Search.*$ --> Browser (search)
    # ^.*Skype.*$ --> Skype
    # ^.*Zimbra.*$ --> Mail
    # ^.*\bmutt\b.*$ --> Mail
    # ^.*\bzsh\b.*$ --> shell

to keep descriptions in legends short and expressive.
Last matching rule (LHS) wins.

See [this example](./simplification_rules.txt) for the rules I like.

----

## FAQ :mag:
#### Q: *Is there a nice webpage to display the graphs?*
> A: Yes, use [this HTML file](./selfvis.html), **host it locally**.

1. Download it [raw from here](https://cdn.rawgit.com/Naereen/selfspy-vis/master/selfvis.html),
2. Put it somewhere where your **local** web server can find it (``~/Public/``, ``~/www/`` or whatever, depending on your system),
3. Generate the graphs in the same folder (you can do it on a daily basis, e.g. with [a cron job](https://help.ubuntu.com/community/CronHowto),
4. Access the page on your web-browser. Tadaa!

> It uses [StrapDown.js](https://github.com/Naereen/StrapDown.js).

#### Q: *Is it supposed to be that slow?*
> A: Yup, don't expect your graphs to be produced in two seconds, it can take up-to 15 seconds.

> A: Note: You can use an option to shorten the time window used for the plot: for instance ``selfvis.py --back 8 h`` only uses the data from the last 8h.

#### Q: *Can I ...?*
> A: Yes, as long as you respect [the terms of the GPLv3 License](./LICENSE).

----

## :information_desk_person: About
### :pencil: Authors?
- [Forked by](https://github.com/Naereen/selfspy-vis/): [Lilian Besson (Naereen)](https://github.com/Naereen/),
- Original author: [Hannes Schulz (temporaer)](https://github.com/temporaer/selfspy-vis).

### :scroll: License?
[GPL v3](./LICENSE).

[![Analytics](https://ga-beacon.appspot.com/UA-38514290-17/github.com/Naereen/selfspy-vis/README.md?pixel)](https://github.com/Naereen/selfspy-vis/)