initial commit
This commit is contained in:
59
README.md
Normal file
59
README.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# Timesheet
|
||||
|
||||
CLI nástroj pro vypsání timesheetu z GitLabu jako ASCII tabulky.
|
||||
|
||||
## Použití
|
||||
|
||||
```bash
|
||||
GITLAB_TOKEN=glpat-... \
|
||||
GITLAB_USERNAME=foo.bar \
|
||||
HOURLY_RATE=100 \
|
||||
go run . --month 2026-04
|
||||
```
|
||||
|
||||
Volitelně lze zadat vlastní GitLab instanci:
|
||||
|
||||
```bash
|
||||
GITLAB_URL=https://gitlab.example.com \
|
||||
GITLAB_TOKEN=glpat-... \
|
||||
GITLAB_USERNAME=foo.bar \
|
||||
HOURLY_RATE=100 \
|
||||
go run . --month 2026-04
|
||||
```
|
||||
|
||||
Filtrovat lze také podle issue nebo merge request IID:
|
||||
|
||||
```bash
|
||||
GITLAB_TOKEN=glpat-... \
|
||||
GITLAB_USERNAME=foo.bar \
|
||||
HOURLY_RATE=100 \
|
||||
go run . --month 2026-04 --id 123
|
||||
```
|
||||
|
||||
## Example Output
|
||||
|
||||
```text
|
||||
GitLab Timesheet — Duben 2026
|
||||
Hodinová sazba: 100 Kč/h | Norma: 8 h/den
|
||||
|
||||
+---------------------------------------------------------------+
|
||||
| Datum | Den | Odpracováno | Rozdíl | Částka |
|
||||
+---------------------------------------------------------------+
|
||||
| 2026-04-01 | St | 8.00 h | +0.00 h | 800 Kč |
|
||||
| 2026-04-02 | Čt | 6.50 h | -1.50 h | 650 Kč |
|
||||
| 2026-04-03 | Pá | 8.00 h | +0.00 h | 800 Kč |
|
||||
+---------------------------------------------------------------+
|
||||
| Souhrn týdne | 22.50 h | -1.50 h | 2250 Kč |
|
||||
+---------------------------------------------------------------+
|
||||
|
||||
+===============================================================+
|
||||
| SOUHRN MĚSÍCE | 160.00 h | +0.00 h | 16000 Kč |
|
||||
+===============================================================+
|
||||
```
|
||||
|
||||
## Význam proměnných
|
||||
|
||||
- `GITLAB_TOKEN` - GitLab Personal Access Token se scope `read_api`. Povinná proměnná.
|
||||
- `GITLAB_USERNAME` - GitLab username uživatele, pro kterého se timesheet načítá. Povinná proměnná.
|
||||
- `GITLAB_URL` - základní URL GitLabu. Volitelná proměnná, výchozí hodnota je `https://gitlab.com`.
|
||||
- `HOURLY_RATE` - hodinová sazba v Kč za hodinu, ze které se počítá výsledná cena. Povinná proměnná.
|
||||
Reference in New Issue
Block a user