diff --git a/README.md b/README.md index 548b8c2..3125e55 100644 --- a/README.md +++ b/README.md @@ -14,3 +14,14 @@ Pour installer une version de développement, reportez-vous à la documentation On peut aussi peupler les catégories avec un choix de catégories élémentaires: * ```make create-categories``` + +## Notes aux développeurs + +### Ajout d'une nouvelle source *custom* + +Pour ajouter une nouvelle source custom: +- ajouter un fichier dans ```src/agenda_culturel/import_tasks/custom_extractors``` en s'inspirant des autres fichiers présents. Il existe de nombreuses facilités dans les classes mères correspondantes +- s'inspirer des scripts présents dans ```experimentations/``` pour créer son propre script de test +- quand l'import fonctionne de manière indépendante dans ces expérimentations, il est tant de l'ajouter au site internet: + - ajouter à la classe ```RecurrentImport.PROCESSOR``` présente dans le fichier ```src/agenda_culturel/models.py``` une entrée correspondant à cette source pour qu'elle soit proposée aux utilisateurs + - ajouter à la fonction ```run_recurrent_import``` présente dans le fichier ```src/agenda_culturel/celery.py``` le test correspondant à cet ajout, pour lancer le bon extracteur \ No newline at end of file