README.md 1.33 KB
Newer Older
Daniel Steuer's avatar
Daniel Steuer committed
1
# outatime
2

Daniel Steuer's avatar
Daniel Steuer committed
3
simple flex time tracker
4

5
## Usage
6
7
8
9
When started the programm will automatically assume the user has arrived at
work. By clicking the tray icon the user can switch between work and break
time. The current state and accumulated time can be observed via the tooltip
of the tray icon or in the timesheet overview.
Daniel Steuer's avatar
Daniel Steuer committed
10
It is reccommended to launch outatime at windows startup.
11
12
13

## Features
- Tracks work time and break time separately
Daniel Steuer's avatar
Daniel Steuer committed
14
15
- Edit contractual daily working hours using a toml configuration file
- Edit or remove timestamps of activity switches to enable the user to correct mistakes
16
17
18
19
20

## Setup
```
python3 -m venv venv
source venv/Scripts/activate
Daniel Steuer's avatar
Daniel Steuer committed
21
22
23
24
25
26
```

To install dependencies you can use the requirements file
```
pip install -r requirements.txt
```
27

28
29
Alternatively you can install dependencies manually. Keep in mind that some
libraries are version dependant
Daniel Steuer's avatar
Daniel Steuer committed
30
31
```
pip install pystray==0.19.1
32
pip install pyinstaller
33
pip install PySimpleGUI
34
pip install toml
35
```
36

37
38
## Delivery Creation
To compile into an single executable file ready for distribution run the delivery script.
39
```
40
python make-delivery.py
Daniel Steuer's avatar
Daniel Steuer committed
41
```
42
43
44
45
46
47

## Troubleshooting and Reporting
In case you encounter a bug and know a way to reproduce it, please consider
running the application with the parameter --debug. This will enable extensive
logoutput to the console.

Daniel Steuer's avatar
Daniel Steuer committed
48
```
49
outatime.exe --debug
50
```