agenda_culturel/README.md
Jean-Marie Favreau d2ca848412 Petits ajustements
2024-04-22 11:20:42 +02:00

1.7 KiB

Agenda culturel

L'agenda culturel est un projet django créé à partir de Django Docker Quickstard pour faciliter son développemnt et déploiement. Il est distribué sous licence AGPL.

Une instance de démonstration est disponible à l'adresse https://pommesdelune.fr/.

Installation

Pour installer une version de développement, reportez-vous à la documentation de Django Docker Quickstard. En résumé:

  • git pull
  • make build-dev

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
  • se rendre sur le site, page administration, et ajouter un import récurrent correspondant à cette nouvelle source