org-report-stats/README.md

63 lines
2.9 KiB
Markdown
Raw Permalink Normal View History

2022-07-20 15:35:36 +02:00
# org-report-stats
Compte rendu html des tâches réalisées dans des fichiers Orgmode.
Ce dépot permet plusieurs choses:
- convertir des fichiers orgmode en json
- faire fonctionner un serveur web express / node pour afficher un compte rendu HTML interprêtant un fichier json représentant des tâches orgmode exportées à partir d'ox-json dans emacs.
pour le lancer: npm start.
- convertir des exports de services numériques en fichier tsv et json, afin d'être utilisé par les autres parties pour en faire un compte rendu en html.
2023-07-19 23:06:55 +02:00
- un convertisseur de site wordpress vers orgmode. La source est un export au format json de la table des posts d'un site wordpress, réalisé dans un client de base de données comme phpmyadmin ou un IDE tel que PhpStorm.
2022-07-20 16:03:28 +02:00
2022-07-20 22:36:12 +02:00
![report in preview](screenshot.png "screenshot of the report in html")
2022-07-20 16:03:28 +02:00
# Prérequis
2022-07-20 22:36:12 +02:00
* une connaissance d'Orgmode pour exporter les tâches archivées
2022-07-20 16:03:28 +02:00
* un export json de vos tâches archivées (voir ox-json)
* mettre l'export json dans le dossier source
* avoir Nodejs en version stable et installer les modules node.
2022-07-20 16:03:28 +02:00
# Utilisation
2023-09-22 10:16:46 +02:00
## Configuration
Vérifiez les variables de chemin dans **parse_orgmode_to_json.mjs**, surtout outputAbsolutePath pour avoir un lieu de génération de fichier.
2023-09-22 10:16:46 +02:00
## compiler les fichiers org et les convertir en json
Il suffit de lancer cette commande du Makefile
```bash
make convert
```
Elle réalise la concaténation des fichiers tasks.org et tasks.org_archive faite dans all_tasks.org qui est ensuite utilisé par le script **parse_orgmode_to_json.mjs** pour fabriquer un fichier json.
la sortie est générée dans "outputAbsolutePath" définie dans "parse_orgmode_to_json.mjs"
2023-09-22 15:47:12 +02:00
## rendu graphique
` ts-node render_chart.ts`
sort un graphique des tâches crées et complétées selon les différents agrégats de temps. à configurer dans le fichier render_chart.ts.
2023-09-22 10:16:46 +02:00
## Données générées
### Des statistiques
* Les nombres et le type de tâches agrégées par semaine, mois et années.
* le nombre de tâches avec une date.
* le nombre de tâches sans date.
* la date de la tâche la plus ancienne
* données agrégées
* Les nombres de fois que des tags sont utilisés dans les tâches.
* Les nombres de fois que des mots sont utilisés dans les tâches.
* des données sur l'auteur, la date de génération du json, le fichier source .org ayant servi à la conversion.
2023-09-22 10:16:46 +02:00
## voir le rendu
2022-07-20 16:03:28 +02:00
Lancer l'exécution du fichier app avec node, et consulter l'output html.
```bash
npm start
2022-07-20 22:36:12 +02:00
```
2023-09-22 10:16:46 +02:00
## Memacs
Les scripts inspirés de Memacs (le package python-pip) sont dans le dossier **converters**, ils permettent de convertir des fichiers exportés de divers outils numériques en feuilles de calcul pour avoir un historique général d'activités simple à lire pour les humains, et facile à analyser pour d'autres scripts.
# feuille de route TODO
2023-09-22 10:16:46 +02:00
- Proposer une sortie json qui soit du même format que l'export ox-json d'emacs.
- Inclure les sous tâches aux catégories
# DONE