agenda_culturel/README.md

28 lines
1.7 KiB
Markdown
Raw Normal View History

2023-09-17 11:19:14 +02:00
# Agenda culturel
L'agenda culturel est un projet django créé à partir de [Django Docker Quickstard](https://github.com/godd0t/django-docker-quickstart/) pour faciliter son développemnt et déploiement. Il est distribué sous licence AGPL.
2023-09-17 11:19:14 +02:00
Une instance de démonstration est disponible à l'adresse https://pommesdelune.fr/.
2023-09-17 11:19:14 +02:00
## Installation
2023-09-17 11:19:14 +02:00
Pour installer une version de développement, reportez-vous à la documentation de [Django Docker Quickstard](https://github.com/godd0t/django-docker-quickstart/). En résumé:
2023-05-10 14:02:09 +02:00
* ```git pull```
* ```make build-dev```
2023-05-10 21:51:26 +02:00
On peut aussi peupler les catégories avec un choix de catégories élémentaires:
2023-05-10 14:02:09 +02:00
* ```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
2024-04-22 11:20:42 +02:00
- 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