Mangaki

Voici le manuel d'installation de Mangaki. Vous ne pouvez pas savoir comme ça fait plaisir que vous me lisiez !

Comment contribuer ?

Que vous soyez simple otaku, data expert, codeur Python, passionné d'algo, data scientist ou designer, vous pouvez contribuer à Mangaki ! Quelques pistes sont sur le wiki, mais aussi dans le fichier CONTRIBUTING.md !

Prérequis

Python ≥ 3.4
PostgreSQL ≥ 9.3 (9.4.2 étant mieux)

python3-sqlparse pour la Debug Toolbar (inutile en production).

Si vous n'avez jamais fait de Django, je vous renvoie vers leur super tutoriel.

Configurer PostgreSQL

Vous aurez besoin de l'utilitaire pwgen pour générer un mot de passe aléatoire lors de la configuration.

sudo -u postgres -H createdb mangaki
sudo -u postgres -H createuser django
export DB_PASSWORD=$(pwgen -s -c 30 1)
sudo -u postgres -H DB_PASSWORD=$DB_PASSWORD psql -d mangaki -c \
  "alter user django with password '$DB_PASSWORD'; \
  grant all privileges on database mangaki to django; \
  create extension if not exists pg_trgm; \
  create extension if not exists unaccent"

Configurer un environnement virtuel

Il est fortement recommandé d'installer les dépendances de Mangaki dans un environnement virtuel, ce qui est fait par les commandes ci-dessous.

python3 -m venv venv --system-site-packages
. venv/bin/activate
pip install -r requirements/dev.txt # S'il s'agit d'une instance de développement, sinon utilisez requirements/production.txt

Pour activer l'environnement virtuel dans le futur, il faudra faire

. venv/bin/activate

Configurer Mangaki

Pour configurer Mangaki, il faut créer un fichier settings.ini à la racine de l'application. Pour une installation de développement, il suffit de faire :

cat > mangaki/settings.ini <<EOF
[debug]
DEBUG = True

[secrets]
SECRET_KEY = $(pwgen -s -c 60 1)
DB_PASSWORD = ${DB_PASSWORD}

[email]
EMAIL_BACKEND = django.core.mail.backends.console.EmailBackend
EOF

Si vous souhaitez mettre en production une instance de Mangaki, le fichier de configuration est un peu plus complexe - regardez dans mangaki/settings.py pour un aperçu des options utiles.

Remplir la base de données

cd mangaki
./manage.py migrate
./manage.py loaddata ../fixtures/{partners,seed_data}.json
./manage.py ranking # Compute cached ranking information. This should be done regularly.
./manage.py top director # Store data for the Top20 page. This should be done regularly.

Voilà ! Vous avez une installation de Mangaki fonctionnelle.

Afficher les notebooks

. venv/bin/activate
pip install jupyter[notebook]

Ensuite, vous pourrez faire ./mangaki/manage.py shell_plus --notebook pour lancer Jupyter Notebook. Les notebooks se trouvent… dans le dossier notebook.

Lancer les tests

. venv/bin/activate
./mangaki/manage.py test

Ceci va lancer les doctests et les tests unitaires contenus dans chaque application avec un dossier tests.

Pour calculer la couverture de test, il faut plutôt faire:

coverage run ./mangaki/manage.py test --with-coverage --cover-package=mangaki,irl,discourse --cover-html

Ainsi, vous aurez un dossier cover qui contiendra les informations de couverture en HTML.

Installation facile (Vagrant)

Vous devez installer Vagrant.

vagrant up
vagrant ssh
./manage.py runserver 0.0.0.0:8000

Votre machine virtuelle est maintenant prête. Vous pouvez utiliser Mangaki à l'adresse app.mangaki.dev:8000 (si vous avez le plugin vagrant-hostsupdater) ou 192.168.33.10:8000.

Pour plus de détails, lisez le script provisioning/bootstrap.sh qui s'occupe de mettre en place la machine.

⚠️ Attention ⚠️ : L'installation vous prendra environ 3 Gio, une fois terminée. C'est en raison principalement de l'image Debian qui est téléchargée puis installée dans la machine virtuelle.

Remarques utiles

Si vous vous rendez sur la page des mangas, la troisième colonne chargera en boucle. C'est parce que le Top Manga est vide, pour des raisons intrinsèques à ranking.py.

Si vous obtenez des erreurs 400 lorsque vous mettez Mangaki en production (c'est-à-dire que DEBUG = False), faites bien attention à modifier les ALLOWED_HOSTS qui se trouvent dans votre configuration (mangaki/settings/) afin d'autoriser votre FQDN dedans.

Pour une mise en production, veillez à faire ./manage.py collectstatic afin d'obtenir les assets: il est possible de changer le repertoire dans mangaki/settings.py (la variable STATIC_ROOT).

Mangaki a été testé et fonctionne parfaitement avec NGINX et Gunicorn.

Nous contacter

En cas de pépin, créez un ticket ou contactez-moi à vie@jill-jenn.net.

ameicler/mangaki