ynop · italogsfernandes · Apr 3, 2020 · Apr 3, 2020 · Apr 3, 2020 · Apr 3, 2020
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "python.pythonPath": "venv/bin/python3.6"
+}
diff --git a/README.md b/README.md
@@ -1,23 +1,61 @@
 # togglore
+
 Tool for the timetracker [toggle](http://toggl.com/) to calculate the difference between tracked time and the time you should have worked in a given range.
 
+![result](docs/result.jpg)
+
 ## Setup
 
-Create a config file and save it at ~/.togglore.
+Create a virtual env using python3 and install the requirements.
+
+```sh
+virtualenv --python=python3 venv
+source venv/bin/activate
+pip install -r requirements.txt
+```
+
+Create a config file and save it at `~/.togglore`.
+
 ```sh
 [Authentication]
 API_KEY = 5b9f5e3fd7745a022781daf205f62c72
 
 [Work Hours]
 hours_per_day = 8.4
-excluded_days = 2016.01.01
+excluded_days = 2020.01.01,2020.01.30
 
 [User Info]
-id = 1
-workspace = 1
+id = 123123123
+workspace = 123123123
+project = 123123123
 ```
 
+Where to find your information:
+
+* **API_KEY**: You can find in the section "API Token" in your [profile page](https://toggl.com/app/profile).
+
+
+* **id**, **workspace** and **project**: Open your reports summary in the toggl web app ([link](https://toggl.com/app/reports/summary/)). Then select a filter by Team (select your user) and by project (select the project you want to follow) as showed in the images. Copy the ids showed in the path: `https://toggl.com/app/reports/summary/<workspace_id>/period/thisWeek/projects/<project_id>/users/<user_id>`
+
+![toggl](docs/image0.png)
+
+![toggl](docs/image1.png)
+
+## Running notifications
+
+Open your crontab file (`crontab -e` in a terminal).
+Then add the following line in your crontab file:
+
+```bash
+*/10 * * * * eval "export $(egrep -z DBUS_SESSION_BUS_ADDRESS /proc/$(pgrep -u $LOGNAME gnome-session)/environ)" && ~/Documents/GitHub/togglore/venv/bin/python ~/Documents/GitHub/togglore/run.py --notify today
+```
+
+This will run the script with the notify option for today. The first part of the command is used to allow the use of notifications in gnome env when a script is called by crontab.
+
+Obs: You should add to the crontab of your user, if you insists and add this to the sudo crontab you have to fix the HOME path.
+
 ## Run
+
 ```sh
 # show diff for today
 python3 run.py today
@@ -37,8 +75,10 @@ python3 run.py month 08
 # show diff from 2016.08.01 until today
 python3 run.py since 2016.08.01
 ```
+
 The output is something like:
-```
+
+```text
 Hours to do: 176.00h (22.00 days)
 Hours worked: 186.65h (23.33 days)
 Difference: 10.65h (1.33 days)

diff --git a/config_template.txt b/config_template.txt
@@ -3,8 +3,9 @@ API_KEY = 5b9f5e3fd7745a022781daf205f62c72
 
 [Work Hours]
 hours_per_day = 8.4
-excluded_days = 2016.1.1,2016.12.30
+excluded_days = 2020.01.01,2020.01.30
 
 [User Info]
-id = 1
-workspace = 1
+id = 123123123
+workspace = 123123123
+project = 123123123
diff --git a/docs/image0.png b/docs/image0.png
diff --git a/docs/image1.png b/docs/image1.png
diff --git a/docs/result.jpg b/docs/result.jpg
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,9 @@
+get==2019.4.13
+post==2019.4.13
+public==2019.4.13
+query-string==2019.4.13
+request==2019.4.13
+ruamel.yaml==0.16.10
+ruamel.yaml.clib==0.2.0
+vext==0.7.3
+vext.gi==0.7.0