Metadata-Version: 2.4
Name: elabftw-toolbox-osur
Version: 0.1.1
Summary: Toolbox Python pour interagir avec l'API eLabFTW (OSUR)
Project-URL: Homepage, https://github.com/gpayen/elabftw-toolbox-osur
Project-URL: Repository, https://github.com/gpayen/elabftw-toolbox-osur
Project-URL: Issues, https://github.com/gpayen/elabftw-toolbox-osur/issues
Author-email: Guillaume Payen <guillaume.payen@univ-rennes.fr>
License: MIT
License-File: LICENSE
Keywords: api,elabftw,laboratory,notebook,osur
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: openpyxl>=3.1.0
Requires-Dist: pandas>=2.0.0
Requires-Dist: python-dateutil>=2.8.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: requests>=2.31.0
Description-Content-Type: text/markdown

# elabftw-toolbox-osur

Collection de scripts Python permettant d'interagir avec l'API REST de
**eLabFTW** afin d'automatiser la gestion, l'analyse et l'export des
données expérimentales et instrumentales.

---

## Installation

### En local

## 🚀 Fonctionnalités

### Commande de base

Permet de récupérer toutes les ressources accessibles via l’API.

```bash
python -m elabftw_toolbox.cli resources-list
````

### Export Excel uniquement (filtré sur export_direction)
```bash
elabftw-toolbox-osur resources-list --format xlsx --outdir ./exports
````

### Export Excel + json/csv
```bash
elabftw-toolbox-osur resources-list --format both --outdir ./exports
````

### Changer le tag et le nom du fichier
```bash
elabftw-toolbox-osur resources-list --format xlsx --tag export_direction --xlsx direction.xlsx
````

Cas d’usage
- Audit des ressources existantes
- Vérification des statuts
- Extraction de métadonnées
- Préparation d’exports CSV


------------------------------------------------------------------------

### 2. Inventaire des instruments (NOUVEAU)

Commande :

``` bash
python -m elabftw_toolbox.cli resources-inventory-diff
```

Options :

``` bash
--outdir ./exports
--category 12 --category 18
--tag lidar --tag atmos
--since 2026-01-01
```

### Champs extraits

-   Titre collection
-   Observatoire
-   PI
-   co-I
-   Responsable technique
-   SNO CAES
-   Infrastructure de Recherche (IR)
-   Autre réseau

### Règle métier

title = "Titre collection" si présent, sinon titre de la ressource

### Fichiers générés

-   liste_instrument_YYYYMMDD.csv
-   liste_instrument_diff_YYYYMMDD.csv

### Cas d'usage

-   Inventaire instrument
-   Suivi des modifications
-   Synchronisation SI

------------------------------------------------------------------------

### 3. Expériences liées

``` bash
GET /api/v2/experiments?related=<ID>&related_origin=items
```

------------------------------------------------------------------------

### 4. Export PDF

Téléchargement automatique des expériences pour archivage.

------------------------------------------------------------------------

### 5. To-Do & Templates

Gestion des statuts, tâches et permissions.

------------------------------------------------------------------------

## ⚙️ Architecture

Structure des métadonnées :

metadata_decoded 
└── extra_fields 
└── `<champ>`{=html} 
└── value

------------------------------------------------------------------------

## 🧩 Bonnes pratiques

-   Versionner les CSV
-   Utiliser --since
-   Automatiser via cron

------------------------------------------------------------------------

## 📅 Exemple

``` bash
resources-inventory-diff --outdir ./exports
```
