https://github.com/yeswiki/yeswiki-extension-importer
Import datas from various sources to YesWiki as bazar entries
https://github.com/yeswiki/yeswiki-extension-importer
Last synced: about 1 year ago
JSON representation
Import datas from various sources to YesWiki as bazar entries
- Host: GitHub
- URL: https://github.com/yeswiki/yeswiki-extension-importer
- Owner: YesWiki
- License: agpl-3.0
- Created: 2024-05-10T16:51:07.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T10:22:16.000Z (about 2 years ago)
- Last Synced: 2024-05-16T14:02:16.980Z (about 2 years ago)
- Language: PHP
- Size: 35.2 KB
- Stars: 0
- Watchers: 14
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Importer YesWiki extension
Pouvoir injecter des données dans Bazar depuis une API externe, qui dans un premier temps sera la source de vérité.
## Use cases
- yunohost listes d'apps publiques/privées `YunohostAppImporter`
- Flux RSS `RssImporter`
- json custom Odoo events `OdooEventsImporter`
- caldav/cardcard
- peertube en embed
- mastodon activityPub
- YesWiki to YesWiki
- Données géographiques de l'état
## Configuration
add arrays of dataSources in wakka.config.php
```php
'dataSources' => [
'korben-rss' => [
'url' => 'https://korben.info/feed',
'formId' => '6',
'importer' => 'Rss',
]
],
```
## Utilisation
**Dans le répertoire racine du yeswiki**.
Tout importer
```bash
./yeswiki importer:sync
```
Importer la source korben-rss
```bash
./yeswiki importer:sync -s korben-rss
```
Plus d'infos
```bash
./yeswiki importer:sync -h
```
## Cdc
Une classe abstraite `Importer` et on implémente le code specifique a chaque usage
les donnees sensibles (token, credentials) sont sauvées de le fichier de conf
pour commencer on lancera la sync en ligne de commande (cli symfony), qui pourra etre appelée dans un CRON
Pour chaque usage d'importation :
- on indique une url d'acces
- modalités de sync :
- [ ] bourrine (on efface tout et on recommence)
- [ ] plus subtil
- [ ] ajouter les nouvelles fiches
- [ ] supprimer les fiches disparues
- [ ] mettre à jour les fiches modifiées
- [ ] conserver les fiches créées manuellement
- [ ] garder les champs customs ajoutés
on définit les méthodes suivantes:
- `authenticate` : pour passer les herses http et/ou ajouter un header, un systeme de login
- `parseData` : récuperer les données depuis la source de vérité et les mapper pour qu'elles puissent alimenter le modèle de formulaire bazar créé par `createFormModel`
- questions : que faire des images/fichiers ? garder l'url ou importer
- `createFormModel` : générer le formulaire de base de données
- `syncData` : selon la stratégie choisie ajouter/supprimer/modifier les fiches du modele de formulaire
## Références
- https://priorites.yeswiki.net/posts/55/pouvoir-consommer-automatiquement-de-la-donnees-externe-via-api
- Doc de nouvelle API YunoHost (TODO Aleks x_x)
- https://lab12.io/wiki/?MonInfrastructureNomade (voir le bazarliste en bas de page)
- https://projetclic.cc/modele/?PagePrincipale
- identifiants yunohost créés par champs bazar https://forge.mrflos.pw/yeswiki/yeswiki-custom-reseau.s-mart.fr/src/branch/main/fields/YunohostUserField.php