Ingestion des données (kadi.market.data_ingestion)¶
Le module WFPDataBridgesClient gère la connexion à l'API WFP DataBridges
(Programme Alimentaire Mondial — VAM) et le cache local des données de prix.
Il constitue la couche d'accès aux données du module kadi.market.
Architecture du client¶
WFPDataBridgesClient
├── get_market_prices() ← Récupère les prix d'un marché
├── get_commodities() ← Liste les cultures disponibles
├── get_markets() ← Liste les marchés disponibles
└── Cache SQLite ← Stocke les résultats pour l'accès hors-ligne
Initialisation¶
from kadi.market.data_ingestion import WFPDataBridgesClient
# Le token est lu automatiquement depuis le fichier .env
client = WFPDataBridgesClient()
Via la façade Market (recommandé) :
from kadi.market import Market
marche = Market(lat=9.30, lon=2.08, location="Parakou")
# marche.data_client est un WFPDataBridgesClient prêt à l'emploi
Configuration requise¶
Ajoutez votre clé API dans le fichier .env à la racine du projet :
Sans clé, le client bascule automatiquement sur le mode simulation :
client = WFPDataBridgesClient()
print(client.token) # "" si WFP_API_Token est absent du .env
df = client.get_market_prices("cotonou", "maize")
print(df["is_simulated"].iloc[0]) # True — données fictives
Méthodes¶
get_market_prices(market, crop, days_back)¶
Récupère les prix historiques pour un marché et une culture. Interroge le cache SQLite en premier ; si les données sont absentes ou périmées, lance un appel à l'API WFP.
Stratégie de sélection des données :
| Étape | Condition | Action |
|---|---|---|
| 1 | Cache frais (< 7 jours) | Retourne depuis le cache SQLite |
| 2 | Token WFP disponible | Appel à l'API WFP DataBridges |
| 3 | API indisponible ou erreur | Génère des données simulées |
Retour : pd.DataFrame avec les colonnes date, price, unit,
is_simulated, source, confidence_score, fetched_at.
Cache SQLite¶
Les données récupérées sont persistées dans ~/.kadi/market_prices.db. La
durée de vie du cache est configurable dans config.py :
Le module kadi.market._cache expose les fonctions de gestion du cache si
vous devez l'interroger directement :
from kadi.market._cache import recuperer_prix, vider_cache
# Vérifier les données en cache pour le maïs à Cotonou
df_cache = recuperer_prix("cotonou", "maize", max_age_jours=30)
# Vider uniquement le cache de Cotonou/maïs
vider_cache("cotonou", "maize")
Endpoints WFP utilisés¶
| Endpoint | Usage |
|---|---|
/Commodities/List |
Récupère les IDs officiels des cultures |
/Markets/List |
Récupère les IDs officiels des marchés |
/MarketPrices/alldata |
Historique de prix par marché et culture |
WFPDataBridgesClient ¶
Client HTTP pour l'API WFP DataBridges (VAM).
Gère l'authentification, le cache SQLite local, le retry avec backoff exponentiel, et le repli transparent sur des données simulées.
Fonctionnement sans clé API
Si aucun token WFP n'est configuré, le client retourne des données simulées (is_simulated=True, confidence_score=0.1) sans erreur. Cela permet de développer et tester sans accès réseau.
Colonnes toujours présentes dans les DataFrames retournés
- is_simulated : True si les données sont fictives
- source : 'wfp-vam', 'ratin', 'scrape-local', ou 'simulated'
- fetched_at : horodatage ISO de la récupération
- confidence_score: score 0.0 à 1.0 (source + fraîcheur)
Source code in kadi/market/data_ingestion.py
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 | |
__init__ ¶
__init__(use_local_mirror: bool = False, env_file: str = '.env', cache_file: str = None, retry_attempts: int = RETRY_ATTEMPTS_DEFAULT, retry_backoff_sec: float = RETRY_BACKOFF_SEC_DEFAULT)
Initialise le client WFP DataBridges.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
use_local_mirror
|
bool
|
Si True, ignore l'API et retourne directement des données simulées. Utile pour les tests. |
False
|
env_file
|
str
|
Chemin vers le fichier .env contenant le token API. |
'.env'
|
cache_file
|
str
|
Chemin vers le fichier JSON de cache des IDs (commodités et marchés). Par défaut : ~/.kadi/wfp_cache.json. |
None
|
retry_attempts
|
int
|
Nombre maximum de tentatives par requête HTTP. |
RETRY_ATTEMPTS_DEFAULT
|
retry_backoff_sec
|
float
|
Délai initial en secondes pour le backoff. |
RETRY_BACKOFF_SEC_DEFAULT
|
Source code in kadi/market/data_ingestion.py
get_market_prices ¶
Récupère les prix historiques pour un marché et une culture.
Stratégie en cascade (la première source disponible est utilisée) : 1. Cache SQLite local (~/kadi/market_prices.db) si les données sont fraîches 2. API WFP DataBridges (si le token WFP_API_Token est configuré) 3. Données simulées en dernier recours (is_simulated=True)
Le DataFrame retourné contient toujours ces colonnes standards :
- date : datetime de l'observation
- price : prix en XOF/kg
- unit : unité d'origine ('KG', 'XOF/kg', etc.)
- is_simulated : True si les données sont fictives
- source : 'wfp-vam', 'cache', 'simulated'
- fetched_at : horodatage ISO de la récupération
- confidence_score : score 0.0 à 1.0 (source + fraîcheur)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
market_name
|
str
|
Nom normalisé du marché (ex: 'cotonou'). |
required |
commodity
|
str
|
Code de la culture (ex: 'maize'). |
required |
time_range
|
tuple
|
(date_debut, date_fin) en 'YYYY-MM-DD'. |
None
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pd.DataFrame: DataFrame enrichi avec toutes les colonnes standards. |
Source code in kadi/market/data_ingestion.py
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 | |
get_market_functionality_index ¶
Retourne l'indice de fonctionnalité d'un marché.
Note : stub V1. Retourne une valeur fixe en attendant l'intégration de données réelles (FEWSNET ou WFP Market Monitor).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
market_id
|
str
|
L'identifiant du marché. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
Indice de fonctionnalité (stub : 7.9 / 10). |