timereport 0.3.1

A small command-line utility for reporting working time and displaying it in different formats.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

# timereport


A small command-line utility for reporting working time and displaying it in different formats.

```
+--------------------+------------+------------+------------+------------+------------+
|                    | 2025-02-03 | 2025-02-04 | 2025-02-05 | 2025-02-06 | 2025-02-07 |
+--------------------+------------+------------+------------+------------+------------+
|                    | Monday     | Tuesday    | Wednesday  | Thursday   | Friday     |
+--------------------+------------+------------+------------+------------+------------+
| start              |            |            | 08:00      |            |            |
+--------------------+------------+------------+------------+------------+------------+
| stop               |            |            | 17:00      |            |            |
+--------------------+------------+------------+------------+------------+------------+
| lunch              |            |            | 00:45      |            |            |
+--------------------+------------+------------+------------+------------+------------+
| 1. Default project |            |            | 06:15      |            |            |
+--------------------+------------+------------+------------+------------+------------+
| 2. Project A       |            |            | 02:15      |            |            |
+--------------------+------------+------------+------------+------------+------------+
| 3. Project B       |            |            |            |            |            |
+--------------------+------------+------------+------------+------------+------------+
```

## Installation


Timereport stores both configuration and time report data in a file `timereport.json`, by default at .

1. Run `cargo install --path .`
2. Set the `TIMEREPORT_PATH` environment variable to where you want to create the .json file containing settings and time report data. Default is `C:\Users\$USERNAME\Dropbox\timereport.json`.
3. Run `timereport`. `timereport.json` will be created in the chosen location.
4. Set the `working_time_per_day` variable in the json file to the appropriate value in seconds. Default is 27900 seconds (7 hours and 45 minutes).
5. Add projects as appropriate (see [Adding Projects](#adding-projects)).

## Usage


### General


It is recommended to assign an alias to timereport. Below the alias `t` is assumed.

Saturdays and Sundays will only be shown if they are affected. To always show them, use `--weekend`.

### Adding Data


```
$ t 2025-02-08 start 08:30
$ t monday lunch 45m 
$ t last monday stop 16:45
```

If date is omitted, the current date will be used:

```
$ t start 08:30
$ t start 08:30 stop 16:00 lunch 45m
```

### Projects


#### Adding Projects


```
$ t add myproject
$ t add "Project containing spaces"
```

#### Reporting Time on Projects


These are all equivalent, provided that myproject is number 2 in the list:

```
$ t project myproject 8
$ t project myproject 8:00
$ t project 2 8:00
```

### Showing Data


Data can be shown one week or one month at a time, either in the terminal or in a web browser.

Add `last` to show the previous week.

#### Console


```
$ t
$ t show week
$ t show last week
$ t show january
```

#### Browser


```
$ t show week html
```

#### Weekend


Add the `--weekend` flag to any command to show Saturday and Sunday:

```
$ t --weekend
$ t show week html --weekend
$ t start 8:30 --weekend
```

## Development


### Running Tests


```
cargo test
```

### Running Tests with Coverage


```
cargo llvm-cov [--html]
```

### Publishing to Github and Crates.io


1. Update version in Cargo.toml
2. Add version description to Changelog below
3. Commit
4. `git tag x.y.z; git push --tags`
5. `cargo publish`

## Changelog


### 0.2.4


First working version

### 0.2.8


Add workflow to deploy for Windows

### 0.3.0


Bold formatting for changed cells

### 0.3.1


Fix flex display in `show week html`