An open API service indexing awesome lists of open source software.

https://github.com/remylavergne/ktoggl-cli

CLI for Toggl API in Kotlin. Generate timesheets for SAP, and other platforms ⏳
https://github.com/remylavergne/ktoggl-cli

Last synced: 3 months ago
JSON representation

CLI for Toggl API in Kotlin. Generate timesheets for SAP, and other platforms ⏳

Awesome Lists containing this project

README

        

# Ktoggl CLI

**Ktoggl CLI** vous permet de générer vos timesheets / fichiers de pointages via le logiciel [**Toggl Track**](https://toggl.com/track/toggl-desktop/).

**Ktoggl CLI n'est pas affilié à la marque / société / logiciel Toggl.**

## Fonctionnalités

### Export pointages **SAP CATS** 🐈

![](./readme-resources/toggl-to-sap.png)

⚠️ La seule contrainte de cette feature est que les informations des projets pointés doivent se trouver dans le titre du
projet. En effet, avec la version gratuite de **Toggl**, vous ne pouvez pas avoir accès aux **Tasks**. Prenez cela comme
un workaround 🤓

Les projets dans **Ktoggl CLI** doivent être sous cette
forme : ` ` pour représenter au mieux le fonctionnement de **SAP CATS**.

Si un nom de client est disponible, il faut le rajouter aussi (*Attention à la casse !*) :

![](./readme-resources/project-formating-example.png)

C'est la seule manipulation nécessaire en amont pour que la génération du fichier *Excel* fonctionne.

Exemple de commande pour générer ce fichier :

- 🗄 Avec le fichier **JAR** :

```shell
$ java -jar ktoggl-cli-0.0.2.jar timesheet sap --api-key --workspace --since 2021-04-15 -g
```

- 🐳 Avec **DockerHub** [Ktoggl-CLI](https://hub.docker.com/r/remylavergne/ktoggl-cli) :

```shell
$ docker pull remylavergne/ktoggl-cli

$ docker run -d -it -v $PWD/output:/usr/src/ktoggl/ktoggl-cli-output --name ktoggl-cli remylavergne/ktoggl-cli

$ docker exec -it ktoggl-cli bash

bash-4.4# ktoggl-cli timesheet sap --api-key --workspace --since 2021-04-15 -g
```

- 🐳 Avec le **Dockerfile** :

```shell
$ docker build --no-cache --rm -t remylavergne/ktoggl-cli .

$ docker run -d -it -v $PWD/output:/usr/src/ktoggl/ktoggl-cli-output --name ktoggl-cli remylavergne/ktoggl-cli

$ docker exec -it ktoggl-cli bash

bash-4.4# ktoggl-cli timesheet sap --api-key --workspace --since 2021-04-15 -g
```

`--api-key`, `-a` : Votre clef API se trouve dans vos paramètres de compte Toggl

`--workspace`, `-w` : L'id du workspace visé (se trouve facilement dans l'url)

`--since`, `-s` : Date de début pour la récupération des données

`--until`, `-u` : Date de fin pour la récupération des données (si vide, `since` + 6 jours)

`-g` / `--no-group` : Grouper / ne pas grouper les mêmes projets sur une journée

`-t`, `--tag` : Permet de filtrer sur un tag spécifique (ex : `-t private -t maths`)

À la fin du processus, des logs permettent d'avoir un aperçu de ce qui a été généré, avec les différences de temps en
plus, ou en moins.

Exemple de résultat (⚠️ ceci risque de changer dans le temps) :

```bash
-> (2021-04-05 to 2021-04-22) Excel generation done with 100 entries

-> Summary
14 days exported
Total: 110.0 hours
Total expected: 112 hours

-> Differences based on 8 hours shift / day:
- 2021-04-22: - 1.0
- 2021-04-21: - 1.5
- 2021-04-20: + 0.25
- 2021-04-19: - 0.25
- 2021-04-16: + 0.25
- 2021-04-15: + 0.5
- 2021-04-12: + 0.5
- 2021-04-09: - 0.25
- 2021-04-08: - 0.25
- 2021-04-06: + 2.5
- 2021-04-05: - 7.25
```

Le fichier Excel généré est directement importable dans **SAP CATS**. Vous pouvez ainsi ajuster vos pointages avec le
compte rendu.

![](./readme-resources/excel-export-example.png)

Vous remarquerez que les heures ont été arrondies au quart supérieur, ou inférieur, pour respecter le standard de
pointage de **SAP CATS**.

Vous pouvez maintenant uploader cet Excel dans votre **SAP CATS**.