doc: more doc

Co-authored-by: mco-system <michael.costa@mcos.nc>
Reviewed-on: #4

Makefile

@@ -1,45 +1,50 @@
-.PHONY: clean distclean install run stop
+.PHONY: clean distclean install run stop all docker-build docker-run docker-stop docker-all
 
 install:
 	set -e ;\
-	THSF_DIR=$$(pwd); \
-	echo [+] Déploiement dans $$THSF_DIR; \
-	python3 -m venv thsf_venv; \
+	python -m venv thsf_venv; \
 	. thsf_venv/bin/activate; \
-	pip3 install -r requirements.txt ;\
-	pip3 install . ;\
-	pip3 install gunicorn; \
+	pip install -r requirements.txt ;\
+	pip install . ;\
+	pip install gunicorn;
 
 run:
 	set -e ;\
 	THSF_DIR=$$(pwd); \
-	echo [+] Démarrage dans $$THSF_DIR; \
 	. thsf_venv/bin/activate; \
-	thsf_venv/bin/gunicorn -D -p thsf.pid -w 4 -b 127.0.0.1:8042 'thsf:app'
+	thsf_venv/bin/gunicorn -p thsf.pid -w 4 -b 0.0.0.0:8042 'thsf:app'
 
 debug:
 	set -e ;\
 	THSF_DIR=$$(pwd); \
-	echo [+] Démarrage dans $$THSF_DIR; \
 	. thsf_venv/bin/activate; \
-	thsf_venv/bin/gunicorn -p thsf.pid -w 4 -b 127.0.0.1:8042 'thsf:app'
+	thsf_venv/bin/gunicorn -p thsf.pid -w 4 -b 0.0.0.0:8042 'thsf:app'
 
 stop:
 	-set -e;\
 	THSF_DIR=$$(pwd); \
-	echo [+] Arrêt dans $$THSF_DIR; \
 	kill -15 $$(cat $$THSF_DIR/thsf.pid); \
 	rm thsf.pid
 
 clean:
 	-set -e ;\
 	THSF_DIR=$$(pwd); \
-	echo [+] Nettoyage dans $$THSF_DIR; \
 	rm -Rf ./build ./src/thsf.egg-info ./thsf.pid ./thsf.log; \
 	. thsf_venv/bin/activate; \
-	pip3 uninstall thsf -y
+	pip uninstall thsf -y
 
 distclean: clean
 	rm -Rf thsf_venv/
 
 all: stop clean install run
+
+docker-build:
+	docker-compose build
+
+docker-run:
+	docker-compose up -d
+
+docker-stop:
+	-docker-compose down
+
+docker-all: docker-stop docker-build docker-run

README.md

@@ -1,36 +1,66 @@
 # THSF.NET
 
-Le site du THSF
+Le site du **THSF**
 
-## Modifier le site
+## Fonctionnement du site
+
+Le site du **THSF** est une application *Python Flask* configurée à partir du fichier `config.yml` situé à la racine du dépôt.
+
+Il n'est généralement pas nécessaire de modifier ce fichier de configuration, cependant il ets possible d'augmenter le niveau de *log* en modifiant la clef de configuration `log::root::level` en la passant à `DEBUG` (valeur en production: `INFO`).
+
+### Conteneur
+
+Un fichier `thsf.Dockerfile` ainsi que le fichier `docker-compose.yml` correspondant permettront de rapidement démarrer localement une instance du site du **THSF**.
+
+### Démarrer une instance du site du **THSF**
+
+Assurez vous d'avoir l'environnement de conteneurisation adéquat (i.e: *docker* + *docker-compose*) puis exécuter directement les commandes suivantes depuis la racine du dépôt:
+
+```shell
+docker-compose build
+docker-compose up -d
+```
+
+Le site du **THSF** écoutera alors sur le port *TCP/8042*:
+
+`http://127.0.0.1:8042`
+
+### Arrêter une instance du site du **THSF**
+
+```shell
+docker-compose down
+```
+
+## Apporter des modifications au site
+
+**Important**: Avant d'apporter la moindre modification, pensez à créer une nouvelle branche à l'aide de la commande suivante en remplaçant `ma_branche` par le nom de votre branche:
+
+```shell
+git checkout -b ma_branche
+```
+
+Le code de l'application *Python Flask* se situe dans le répertoire `src` et une fois votre branche créée, vous pouvez apporter toutes les modification souhaitées.
+
+### Créer un patch contenant toutes vos modifications
+
+Une fois satisfaits de vos modifications vous pouvez créer un *patch* regroupant l'ensemble de vos modifications à l'aide la commande suivante
+
+```shell
+git diff -u --patch  master..ma_branche > mes_modifications.patch
+```
+
+Vous pouvez faire parvenir votre fichier de *patch* à **contact@tetalab.org** pour que vos modifications soient incorporées au site après vérification.
+
+### Publication automatisée des modifications
+
+**Note**: Cette partie ne concerne que les personnes ayant un accès en écriture sur le dépôt *Git*.
 
 Il n'est **pas possible** de pousser directement des modifications sur la branche `master`.
 
 Pour modifier le site, il est nécessaire de créer une branche spécifique et d'y pousser vos modifications.
 
-## Publication du site
-
 Lorsque vous êtes satisfaits de vos modifications, vous pouvez créer [une demande d'ajout](https://git.tetalab.org/tetalab/thsf.net/pulls) de votre branche sur la branche `master`.
 
-Lorsque la demande de fusion sera acceptée (vous pouvez auto-accepter vos demandes de fusion), vos modifications seront automatiquement publiées sur [le site du THSF](https://www.thsf.net).
+Lorsque la demande de fusion sera acceptée, vos modifications seront automatiquement publiées sur [le site du THSF](https://www.thsf.net).
 
-### Personnalisation de la publication
-
-Afin de rendre le processus plus souple, il est possible de personnaliser la livraison en plaçant **à la racine du dépôt** un fichier `Makefile` contenant une cible `all` qui sera systématiquement exécutée.
-
-C'est dans cette cible `all` que vous pourrez mettre toutes vos commandes personnalisées, typiquement l'installation de modules `python`, etc.
-
-Le processus de publication est le suivant:
-
-1. Le site actuellement en production est **supprimé**
-
-2. La branche `master` du présent dépôt est cloné sur le serveur hébergeant le site du **THSF**
-
-3. Si un fichier `Makefile` se trouve **à la racine du dépôt**, la cible `all` (i.e: `make all`) est automatiquement exécutée.
-
-
-## Contrôle de qualité et tests
-
-Aucun contrôle de qualité ou de tests n'est mis en place. Vous êtes seuls sur le coup.
-
-Soyez responsable et **testez vos modifications sur votre machine locale avant de fusionner votre branche** sur la branche `master`.
+Vous pouvez auto-accepter vos demandes de fusion si vous faites partie des développeurs autorisés.

config.yml

@@ -14,7 +14,7 @@ log:
       handlers: [wsgi]
       propagate: no
   root:
-    level: DEBUG
+    level: INFO
     handlers: [wsgi]
 app:
   secret_key: xxx
@@ -57,7 +57,7 @@ navbar:
     - name: Tables rondes
       classes: fa-solid fa-users-line
       url: /discussions
-    - name: Installations artistiques
+    - name: Installation
       classes: fa-solid fa-palette
       url: /exhibitions
     - name: Présentations

docker-compose.yml

@@ -0,0 +1,12 @@
+version: "2"
+services:
+  thsf:
+    build:
+      dockerfile: thsf.Dockerfile
+      context: .
+    extra_hosts:
+      - "23.thsf.net:192.168.122.26"
+    ports:
+      - "127.0.0.1:8042:8042"
+    image: thsf:latest
+    container_name: thsf

src/thsf/__init__.py

@@ -60,10 +60,10 @@ def get_slots():
 def get_speaker_biography(name):
   try:
     speaker_info = backend.get(endpoint=f"events/{app.local_config['pretalx']['event']}/speakers/", params={"q": name}).json()
-    logging.info(speaker_info)
+    logger.debug(speaker_info)
     return speaker_info["results"][0]["biography"].strip()
   except Exception as err:
-    logging.error(f"UnknownSpeakerError: {name}")
+    logger.warning(f"UnknownSpeakerError: {name}")
     return None
 
 # ------------------------------------------------------------------------------
@@ -98,7 +98,7 @@ def date2dmyhm(slot_type):
                 "Présentation": "fa-solid fa-person-chalkboard",
                 "Table Ronde": "fa-solid fa-users-line",
                 "Atelier": "fa-solid fa-screwdriver-wrench",
-                "Exposition": "fa-solid fa-palette"}
+                "Installation": "fa-solid fa-palette"}
   return slot_types[slot_type]
 
 # ------------------------------------------------------------------------------
@@ -123,16 +123,17 @@ def planning():
   return render_template("planning.html",
                          slots=sorted(slots.get("slots"),
                          key=lambda slot: slot.get("slot").get("start")),
-                         navbar=navbar.get_from_page(page="/planning"))
+                         navbar=navbar.get_from_page(page="/planning"),
+                         filter=["concert", "dj set", "panel discussion", "talk", "screening"])
 
 @app.route('/place', methods=['GET'])
 def place():
-  return render_template("index.html",
+  return render_template("place.html",
                          navbar=navbar.get_from_page(page="/place"))
 
 @app.route('/food', methods=['GET'])
 def food():
-  return render_template("index.html",
+  return render_template("food.html",
                          navbar=navbar.get_from_page(page="/food"))
 
 @app.route('/goodies', methods=['GET'])
@@ -183,7 +184,7 @@ def exhibitions():
                          slots=sorted(slots.get("slots"),
                          key=lambda slot: slot.get("slot").get("start")),
                          navbar=navbar.get_from_page(page="/exhibitions"),
-                         filter=["exhibition"])
+                         filter=["installation"])
 
 @app.route('/talks', methods=['GET'])
 def talks():

src/thsf/templates/base.html

@@ -64,12 +64,24 @@
           </a>
         </div>
         <div class="subpartners">
+          <a href="https://www.tvbruits.org/" target="_new">
+            <img src="{{ url_for('static', filename='images/tv-bruits.png')}}"
+                 alt="TV Bruits"
+                 title="TV Bruits"
+                 class="logo_partner">
+          </a>
           <a href="https://www.tetaneutral.net/" target="_new">
             <img src="{{ url_for('static', filename='images/tetaneutral.png')}}"
                  alt="Tetaneutral"
                  title="Tetaneutral"
                  class="logo_partner">
           </a>
+          <a href="https://www.radio-fmr.net/" target="_new">
+            <img src="{{ url_for('static', filename='images/fmr.png')}}"
+                 alt="Radio FMR"
+                 title="Radio FMR"
+                 class="logo_partner">
+          </a>
         </div>
         <div class="subpartners">
           <a href="https://clutchmag.fr/" target="_new">

src/thsf/templates/food.html

@@ -0,0 +1,14 @@
+{% extends "base.html" %}
+{% block content %}
+      <div class="logo_wrapper">
+        <img class="logo"
+            src="{{ url_for('static', filename='images/logo.svg') }}"
+            alt="THSF 2023 - S/Extraire"
+            title="THSF 2023 - S/Extraire">
+      </div>
+      <div class="content">
+        <h2>Restauration</h2>
+        <p>La restauration sur place est prévue.</p>
+        <p>Détails à venir...</p>
+      </div>
+{% endblock %}

src/thsf/templates/goodies.html

@@ -13,7 +13,7 @@
                src="{{ url_for('static', filename='images/stickers.webp') }}"
                alt="Stickers"
                title="Stickers">
-          Pour faire du <strong>Toulouse Hacker Space Factory</strong> un événement toujours différent des autres festivals <strong>votre soutien financier</strong> est nécessaire.
+          Pour faire du <strong>Toulouse Hacker Space Factory</strong> un événement toujours différent des autres festivals <a href="https://www.leetchi.com/c/thsf23" target="_new">votre soutien financier</a> est nécessaire.
         </p>
         <p class="goodies">
           <img class="right"

src/thsf/templates/index.html

@@ -16,12 +16,12 @@
         <h2>Le THSF est enfin de retour !</h2>
         <p>Nous vous invitons à passer un week-end de 3 jours à <a href="https://www.cinemas-utopia.org/toulouse/" target="_new">Utopia Borderouge Toulouse</a> pour partager avec vous nos projets, nos réflexions, nos performances, nos poésies et nos doutes sur la technologie.</p>
 
-        <p>Après avoir été soutenu et accueilli pendant 10 ans par <a href="https://vive.mixart-myrys.org/" target="_new">Mix'Art Myrys</a>, le <strong>Toulouse HackerSpace Factory</strong> se tient désormais dans un autre lieu où l'utopie nécessaire est inscrite programme.</p>
+        <p>Après avoir été soutenu et accueilli pendant 10 ans par <a href="https://vive.mixart-myrys.org/" target="_new">Mix'Art Myrys</a>, le <strong>Toulouse HackerSpace Factory</strong> se tient désormais dans un autre lieu où l'utopie nécessaire est inscrite au programme.</p>
 
-        <p>Cette année nous mettons en avant des réflexions sur <a href="https://fr.wikipedia.org/wiki/Extractivisme" target="_new">l'extractivisme des ressources</a> planétaires, des données, de la valeur travail.</p>
+        <p>Cette année nous mettons en avant des réflexions sur <a href="https://fr.wikipedia.org/wiki/Extractivisme" target="_new">l'extractivisme des ressources</a> planétaires, des données et du produit du travail.</p>
 
         <p>Comme toujours, notre objectif est de créer un festival qui poétise les bifurcations de nos idées communes et qui réinvente le sens de certains schémas imposés par notre époque. Rejoignez-nous pour une expérience enrichissante et pleine de surprises !</p>
 
-        <p>Consulter <a href="/planning">le programme du THSF</a>.</p>
+        <p>Retrouvez <a href="/planning">le programme du THSF</a> avec ses <a href="/workshops">ateliers</a>, ses <a href="/exhibitions">expositions et installations</a> mais également ses <a href="/concerts">concerts</a>, ses <a href="/projections">projections</a>, ses <a href="/talks">présentations</a> et ses <a href="/discussions">tables rondes</a>.</p>
       </div>
 {% endblock %}

src/thsf/templates/place.html

@@ -0,0 +1,34 @@
+{% extends "base.html" %}
+{% block content %}
+      <div class="logo_wrapper">
+        <img class="logo"
+            src="{{ url_for('static', filename='images/logo.svg') }}"
+            alt="THSF 2023 - S/Extraire"
+            title="THSF 2023 - S/Extraire"
+            onclick="document.getElementById('wemakeporn').style.visibility='visible';">
+        <div id="wemakeporn" class="wemakeporn"
+             onclick="document.getElementById('wemakeporn').style.visibility='hidden';">
+          <div class="wemake">WE MAKE</div>
+          <div class="porn">PORN</div>
+        </div>
+      </div>
+      <div class="content">
+        <h2>Toujours plus d'utopies</h2>
+        <p>
+          La fermeture administrative imposée à <a href="https://vive.mixart-myrys.org/" target="_new">Mix'Art Myrys</a>, terre d'accueil des 10 éditions antérieures du THSF, nous montre qu'il est plus que jamais important de continuer à bâtir, consolider et faire vivre nos utopies face à la repression systémique qu'on voudrait nous imposer.
+        </p>
+        <p>
+          Connu pour sa programmation alternative et engagée, ainsi que pour son ambiance conviviale et chaleureuse, le cinéma d'art et d'essai indépendant <a href="https://www.cinemas-utopia.org/toulouse/">Utopia Borderouge</a>, dont l'utopie est naturellement au programme, s'est proposé pour accueillir le <strong>THSF 2023</strong>.
+        </p>
+        <h3>Plan d'accès</h3>
+        <ul>
+          <li><strong>Adresse:</strong> 59, avenue Maurice Bourgès-Maunoury, Les Izards - Toulouse</li>
+          <li><strong>GPS:</strong> 43°38'22.7"N 1°27'07.3"E</li>
+          <li><strong>Métro:</strong> Ligne B - Borderouge</li>
+          <li><strong>Velooz:</strong> Station 175 - Métro Borderouge - Maunoury</li>
+        </ul>
+        <div class="map">
+          <iframe width="425" height="350" frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="https://www.openstreetmap.org/export/embed.html?bbox=1.4502596855163576%2C43.63879667815726%2C1.4538002014160158%2C43.64046408342326&amp;layer=mapnik&amp;marker=43.639631357124614%2C1.4520299434661865" style="border: 1px solid black"></iframe><br/><small><a href="https://www.openstreetmap.org/?mlat=43.63963&amp;mlon=1.45203#map=19/43.63963/1.45203">Afficher une carte plus grande</a></small>
+        </div>
+      </div>
+{% endblock %}

src/thsf/templates/slot.html

@@ -6,6 +6,7 @@
       <span class="title">{{slot.title}}</span>
     </div>
     <div class="slot_info">
+      {% if slot.slot.room.fr != "Workshops" %}
       <div class="start">
         <i class="fa-solid fa-caret-right"></i>
         {{slot.slot.start | date2dmyhm}} - {{slot.duration}} minutes ({{slot.content_locale | capitalize}})
@@ -14,6 +15,7 @@
         <i class="fa-solid fa-caret-right"></i>
         {{slot.slot.room.fr}}
       </div>
+      {% endif %}
       <div class="speakers">
         {% for speaker in slot.speakers %}
           <div class="speaker">

thsf.Dockerfile

@@ -0,0 +1,15 @@
+ARG PRETALX_HOSTS_ENTRY
+FROM python:3.9.16-bullseye as thsf_base
+RUN apt-get update -y && \
+    apt-get install -y bash make python3-pip && \
+    useradd -m -d /home/thsf -s /bin/bash thsf
+
+from thsf_base as thsf_build
+COPY . /home/thsf/
+RUN chown -R thsf:thsf /home/thsf/
+USER thsf
+WORKDIR /home/thsf/
+
+from thsf_build
+RUN	make install
+CMD ["make", "run"]

thsf.net.code-workspace

@@ -0,0 +1,8 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+	],
+	"settings": {}
+}