Aujourd’hui, un petit billet pour vous présenter et faire un rapide tour d’un projet Github qu’un collègue de bureau m’a fait découvrir récemment.

Que vous soyez un développeur fou ou que vous scriptiez de temps en temps, si vous utilisez quotidiennement « Git », je pense que cela va vous plaire ;)

Le nom de ce projet ? GRIP, développé par Joe Esposito. [ https://github.com/joeyespo/grip ]
Pensez à noter ce mot dans un coin, car je n’arrive jamais à m’en rappeler quand j’en ai besoin ^^

Rapide présentation :

Grip est une application serveur en ligne de commande écrite en Python. Son principe est très simple, elle utilise l’API « Markdown » de Github pour générer en local les README.md et vous permettre de les visualiser en temps réel dans un navigateur.

Les styles appliqués à votre fichier Readme.md viennent directement de GitHub, cela permet alors d’obtenir un rendu exact de la mise en page avant de commiter les modifications.

Cerise sur le gâteau, les modifications apportées au fichier Readme.md seront visibles instantanément dans votre navigateur sans avoir besoin d’actualiser la page et ça, c’est magique !

Comment ça s’installe ?

Tout est détaillé dans la documentation du projet, mais pour les fainéants et/ou les personnes qui n’auraient pas encore installé le gestionnaire de paquets de Python « pip », je copie/colle les quelques lignes de commandes à jouer sur votre machine et j’ajoute également la méthode d’installation de pip.

Vérifier tout d’abord si pip est installé sur votre machine :

pip --help

Si ce n’est pas le cas, installez le :

sudo apt install python-pip

Une fois cela fait, installer grip :

sudo pip install grip

Et … et ben c’est tout en fait :)

Utilisation ?

Là encore, rien de bien compliqué, avec l’aide de votre Terminal, positionnez vous dans un répertoire contenant un README.md que vous souhaiteriez visualiser et exécuter grip :

cd /mon/super/depot/git/
grip 
# Pour info :
# grip -b ouvre automatiquement un nouvel onglet dans votre navigateur

Vous verrez un message affichant les informations suivantes :

 * Running on http://localhost:6419/ (Press CTRL+C to quit)

Il ne vous reste plus qu’à lancer votre navigateur et à consulter votre README.md via l’URI qui vous a été donnée : http://localhost:6419/

Petit exemple avec un README.md créé pour l’occasion :

Un super README pour Sublimigeek !
==================================
Voici un exemple de README généré en local grâce au programme **grip**  
Pour visualiser le README avant de le commiter (pousser) dans son dépôt, rien de plus simple.  
Il suffit de consulter le lien suivant : [http://localhost:6419/](http://localhost:6419/ "Consulter le rendu du README.md en cliquant ici")  

* Ce petit outil écrit en `Python`est quand même pratique non ?!
* A garder dans sa trousse à outils, c'est toujours utile !

Enjoy :)

Puis un petit coup de grip et voilà le résultat :

C’est tout simplement magique, j’adore le concept de cet outil surtout lorsque l’on utilise les README.md pour faire de la documentation un peu velue ou autre méthode de développement conduite par les README des dépôts Git.

Et n’hésitez pas à aller lire le README.md du projet sur Github. Grip est capable de faire pas mal de choses plus ou moins complexes. Je vous laisse découvrir le reste !

Sources utilisées pour la rédaction de l’article :
* Le projet Github dont je parle dans ce billet : Grip

Sources des images utilisées en illustrations :
* L’illustration principale de ce billet est un imprime écran d’un exemple de README.md préalablement écrit par mes soins