canSnippet : le voilà !

Nous vous l'avions annon­cé il y a qua­si­ment un an jour pour jour lors de notre pré­sen­ta­tion à JOBIM2017 à Lille. Il est main­te­nant là, dis­po­nible, consul­table et à por­tée de tous : canS­nip­pet Com­mu­ni­ty Edi­tion.

A vos marques pages, c'est ici que ça se pas­se­ra doré­na­vant : https://​cans​nip​pet​.bioin​fo​-fr​.net/ !

Le principe

Avoir une col­lec­tion de snip­pets (petits bouts de codes réuti­li­sables) axés autour de la bio­in­for­ma­tique faci­le­ment trou­vables et retrou­vables pour le com­mun des bio­in­for­ma­ti­ciens.

La notion de par­tage est une notion impor­tante dans notre com­mu­nau­té. Certes, de tels outils exis­taient déjà, mais aucun d'entre eux n'étaient alors dédié vrai­ment à notre chère bioin­fo.

Comment je partage mes snippets ?

Pre­mière étape : se créer un compte en cli­quant sur le bou­ton "Iden­ti­fi­ca­tion" en bas à gauche de la barre laté­rale.

Vous arri­vez ensuite sur la page de connexion/​création de compte.

Pour la pre­mière fois vous uti­li­se­rez donc l'encart du bas. Par défaut à la créa­tion, un nou­veau compte n'est pas actif. Il fau­dra attendre qu'un admi­nis­tra­teur valide votre nou­veau compte pour pou­voir jouer avec.

Une fois ce compte acti­vé, vous uti­li­se­rez l'encart du haut pour vous connec­ter à chaque fois.

Votre écran d'accueil sera cen­tré sur vos snip­pets, que vous pour­rez trier rapi­de­ment en uti­li­sant les bou­tons pré­vus à cet effet.

De là vous cli­que­rez sur le bou­ton vert à gauche "ajou­ter un snip­pet" et arri­ve­rez sur le for­mu­laire d'ajout. Vous n'aurez alors plus qu'à rem­plir les champs et à vali­der le tout pour rajou­ter votre bout de code fort utile à la col­lec­tion de la com­mu­nau­té des Gee­kus bio­lo­gi­cus.

Les "tags" vous per­met­tront de retrou­ver très faci­le­ment vos snip­pets. La des­crip­tion n'est sur­tout pas à négli­ger, elle com­plète le code et per­met aux autres de bien tout com­prendre. Le titre doit être bien pen­sé : pri­vi­lé­gier un "par­seur de fas­ta" à un simple "par­seur" par exemple…

Der­nière pré­ci­sion mais non des moindres : afin d'apparaitre aux yeux de tous, votre snip­pet doit être vali­dé par un admi­nis­tra­teur.

Nous avons mis cette règle en place afin de mai­tri­ser entiè­re­ment ce qui appa­rai­tra sur la pla­te­forme. Nous sommes 4 admins : nor­ma­le­ment le temps d'attente pour la publi­ca­tion d'un snip­pet visible devrait être accep­table. Si ce n'est pas le cas, nous ouvri­rons les portes à d'éventuels autres admins s'il y a des intéressé(e)s.

Enfin, consé­cra­tion ultime : un snip­pet publié pour­ra être "noté". Un sys­tème de vote existe en effet, sym­bo­li­sé par des petites étoiles sous le snip­pet. Pour pou­voir voter, il faut avoir un compte et être connec­té.

Compte canSnippet obligatoire ?!

C'est mal nous connaitre que de pen­ser ça. Le but est l'ouverture, si nous fer­mons la col­lec­tion au public, nous fer­mons la porte à d'éventuel(le)s timide(s) ou visiteur(s) occasionnel(s).

C'est pour cela qu'aucun compte n'est requis pour consul­ter l'intégralité des snip­pets sur cans​nip​pet​.bioin​fo​-fr​.net

Les avan­tages pour les pos­ses­seurs de compte sont donc :

• pou­voir créer des snip­pets
• pou­voir noter les snip­pets

Le petit plus ?

On vous l'avait déjà dit lors de la pré­sen­ta­tion, mais une des choses à rete­nir sur canS­nip­pet Com­mu­ni­ty Edi­tion c'est qu'il a été implé­men­té de A à Z en exclu­si­vi­té pour bioin​fo​-fr​.net par Adem Bili­can, un de nos tout pre­miers contri­bu­teurs. Il fait don de cette ver­sion à la com­mu­nau­té en lui atta­chant une éti­quette open source. Le code source se trouve sur ce dépôt.

Il avait aupa­ra­vant pro­duit une ver­sion Desk­top, qui elle est acces­sible moyen­nant un petit pas­sage par le porte-mon­naie. A vous de voir si ça vous tente.

L'ensemble des admi­nis­tra­teur remer­cient encore cha­leu­reu­se­ment Adem pour son temps et son inves­tis­se­ment dans le pro­jet.

Nous remer­cions éga­le­ment nos beta tes­teuses et beta tes­teurs qui se sont succédé.e.s au cours du temps, une tache par­fois pas très simple mais qui reste pri­mor­diale dans un pro­jet comme celui-ci.

Enfin, sachez que canS­nip­pet Com­mu­ni­ty Edi­tion est voué à évo­luer et qu'il ne tient qu'à vous de faire des pro­po­si­tions sur le dépot offi­ciel de l'application. D'ailleurs, pour les plus motivé(e)s : Adem ne refuse jamais un coup de main et reste très faci­le­ment acces­sible sur Twit­ter : @ademcan_net !

canS­nip­pet est main­te­nant votre : à vos snip­pets !

Mer­ci à Oli­vier et Ismaël pour leur relec­ture.