docs: update README.md

This commit is contained in:
Matthieu Bessat 2024-01-21 23:59:46 +01:00
parent b044dddbed
commit 99800b8814

View file

@ -1,16 +1,26 @@
# HelloAsso Paheko Adapter # Paheko Adapter
[HelloAsso](https://www.helloasso.com/) <-> [Paheko](https://paheko.cloud/) [HelloAsso](https://www.helloasso.com/) <-> [Paheko](https://paheko.cloud/)
CSV <-> [Paheko](https://paheko.cloud/)
The goal is to provide a way for organizations: The goal is to provide a way for organizations to import members and memberships data into the Paheko software from Helloasso or from CSV.
- to import helloasso membership information and members into paheko
**WARNING: This is a very custom script adapted for my environment and requirements**, but I plan to make it more flexible in the future.
And with some specifics features: And with some specifics features:
- manage subscriptions and activities - clean-up and normalization of data
- implement helloasso custom fields mapping to paheko custom fields - handle subscriptions and activities
- avoid duplication - handle linked users
- handle additional donations
- implement additional custom fields
- WIP: update the data without duplication.
Written in ust. IO:
- read from stdin for the CSV
- use the Helloasso unofficial API to read data
- use the [Paheko API](https://paheko.cloud/api)
Written in the Rust programming language.
## Getting started ## Getting started
@ -42,11 +52,6 @@ PB: l'API permet d'importer des activités, mais pas de lier une écriture compt
ya une table `acc_transactions_users` qui permet de lier une transaction avec une activité d'un utilisateur ya une table `acc_transactions_users` qui permet de lier une transaction avec une activité d'un utilisateur
### références helloasso
le `order.id` et le `answer.id` que retourne l'API d'helloasso sont en fait les mêmes,
## Import from CSV ## Import from CSV
``` ```
@ -60,3 +65,10 @@ cat ./tmp/adhesions_papier_nov2023.csv | cargo run -- --source csv
``` ```
cat ~/.mnt/etoiledebethleem/copyparty/adhesions/to_import.csv | head -n 25 | sed ':a;N;$!ba;s/\(Champ complémentaire [0-9]\)\n/\1 /g' | sed 's/Champ complémentaire \([0-9]\)/CC \1/g' cat ~/.mnt/etoiledebethleem/copyparty/adhesions/to_import.csv | head -n 25 | sed ':a;N;$!ba;s/\(Champ complémentaire [0-9]\)\n/\1 /g' | sed 's/Champ complémentaire \([0-9]\)/CC \1/g'
``` ```
## Run in prod
```
cargo run -- --source helloasso | tee ./.out/2024-01-21_2_ha.log
cargo run -- --source helloasso | tee ./.out/2024-01-21_2_ha.log
```