CONTRIBUTING.md 2.65 KB
Newer Older
Krophil's avatar
Krophil committed
1
*Contribuer c'est la vie*
Krophil's avatar
Krophil committed
2 3 4 5
=========================

Hey ! Tu veux devenir un mec bien et en plus devenir bon en python si tu l'es pas déjà ?
Il se trouve que le sith AE prévu pour l'été 2016 a besoin de toi !
Krophil's avatar
Krophil committed
6

7
Pour faire le sith, on utilise le framework Web [Django](https://docs.djangoproject.com/fr/1.11/intro/)  
Krophil's avatar
Krophil committed
8 9
N'hésite pas à lire les tutos et à nous demander (ae.info@utbm.fr).

10
Bon, passons aux choses sérieuses, pour bidouiller le sith sans le casser :  
Krophil's avatar
Krophil committed
11 12
Ben en fait, tu peux pas le casser, tu vas juste t'amuser comme un petit fou sur un clone du sith.

Krophil's avatar
Krophil committed
13 14
C'est pas compliqué, il suffit d'avoir [Git](http://www.git-scm.com/book/fr/v2), python et pip (pour faciliter la gestion des paquets python).

15
Tout d'abord, tu vas avoir besoin d'un compte Gitlab pour pouvoir te connecter.  
Krophil's avatar
Krophil committed
16 17 18 19 20
Ensuite, tu fais :
`git clone https://ae-dev.utbm.fr/ae/Sith.git`
Avec cette commande, tu clones le sith AE dans le dossier courant.

    cd Sith
21
    virtualenv --clear --python=python3 env_sith
Krophil's avatar
Krophil committed
22 23
    source env_sith/bin/activate
    pip install -r requirements.txt
Sli's avatar
Sli committed
24 25 26

Maintenant, faut passer le sith en mode debug dans le fichier de settings personnalisé.

Sli's avatar
Sli committed
27
    echo "DEBUG=True" > sith/settings_custom.py
Krophil's avatar
Krophil committed
28
    echo 'EXTERNAL_RES = "False"' >> sith/settings_custom.py
29
    echo 'SITH_URL = "localhost:8000"' >> sith/settings_custom.py
Sli's avatar
Sli committed
30

Sli's avatar
Sli committed
31
Enfin, il s'agit de créer la base de donnée de test lors de la première utilisation
Sli's avatar
Sli committed
32

33
	./manage.py setup
Krophil's avatar
Krophil committed
34

Krophil's avatar
Krophil committed
35
Et pour lancer le sith, tu fais `python3 manage.py runserver`
Krophil's avatar
Krophil committed
36

Sli's avatar
Sli committed
37
Voilà, c'est le sith AE. Il y a des issues dans le gitlab qui sont à régler. Si tu as un domaine qui t'intéresse, une appli que tu voudrais développer, n'hésites pas et contacte-nous.
Krophil's avatar
Krophil committed
38 39
Va, et que l'AE soit avec toi.

Soldat's avatar
Soldat committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
Black
------------------
Pour uniformiser le formattage du code nous utilisons [Black](https://github.com/ambv/black). Cela permet d'avoir le même codestyle et donc le codereview prend moins de temps. Tout etant dans le même format, il est plus facile pour chacun de comprendre le code de chacun ! Cela permet aussi d'éviter des erreurs (y parait 🤷‍♀️).

Installation de black:

    cd Sith
    virtualenv --clear --python=python3 env_sith
    source env_sith/bin/activate
    pip install black
    
Sous VsCode:
Ajouter ces deux lignes dans les settings de VsCode

    "python.formatting.provider": "black",
    "editor.formatOnSave": true,


Krophil's avatar
Krophil committed
58 59
Sites et doc cools
------------------
Krophil's avatar
Krophil committed
60

61
[Classy Class-Based Views](http://ccbv.co.uk/projects/Django/1.11/)
Skia's avatar
Skia committed
62 63 64 65 66

Helpers:

`./manage.py makemessages --ignore "env/*" -e py,jinja`

67
`for f in $(find . -name "*.py" ! -path "*migration*" ! -path "./env/*" ! -path "./doc/*"); do cat ./doc/header "$f" > /tmp/temp && mv /tmp/temp "$f"; done`
Skia's avatar
Skia committed
68 69 70 71