[PIGET] Sauvegarder et partager vos projets facilement

[PIGET] Sauvegarder et partager vos projets facilement

Nous allons voir comment utiliser le module git pour créer un module.

Créer un module est un bon moyen pour travailler sur un projet sur le Raspberry Pi.
Cela vous permet de le sauvegarder et de le rendre disponible dès le début du projet, tout en fournissant au fur et à mesure les scripts pour automatiser les tâches.

Vous profitez de plus de tous les modules déjà disponibles sur Piget et pouvait collaborer facilement avec n’importe qui !

Dans ce tutoriel nous allons :

  • Installer le module git
  • Créer un module exemple
  • Sauvegarder le module

Installer le module git

Le module git permet de créer et de sauvegarder des modules facilement.

Pour installer le module git tapez :

/pi/install git

Git doit connaitre votre nom d’utilisateur et votre email pour vous identifiez.
Ces informations sont facultatives, mais il est conseillé de les remplir.
Pour paramétrer git tapez :

/do/git/setup

  • Entrez votre pseudo sur github
  • Puis votre email
Lorsque vous sauvez un module, votre mot de passe est gardé en cache pendant 15 minutes, puis vous devrez le rerentrer

Créer un module

Vous pouvez faire tout ceci depuis Windows avec le module samba

Nous allons créer un module nommé example.

  • Créer le dossier /do/example

mkdir /do/example

Un module ne doit pas contenir de majuscules
  • Créer le script install

nano /do/example/install

  • Le rendre exécutable (vérifie la compatibilité aussi)

/system/convertScript /do/example/install

Un module commence toujours par un script install
Le script install contient tout ce qu’il est nécessaire d’installer pour que le module fonctionne, il est exécuté lorsque l’on installe un module.

Un bon moyen de commencer un projet et de recopier les commandes d’un tutoriel dans ce script , ainsi vous n’aurez pas besoin de revenir dessus et pourraient y apporter vos modifications.
Pensez à mettre en commentaire du script le lien vers le tutoriel et le nom de son auteur.

Il est recommandé de faire que le script d’installation puisse être relancé et ne nécessite pas l’intervention de l’utilisateur

Nous avons déjà les bases pour notre module, il est temps de le créer afin de pouvoir facilement le sauvegarder.

Répliquer le module

Sur github

  • Créer un nouveau repository

repo

  • Entrez dans Repository name le nom du module

name

  • Cliquez sur Create repository

Dans le terminal

  • Aller dans le dossier du module /do/example

cd /do/example

  • Tapez

/do/git/create nom_utilisateur/example
/do/git/create benzaie/example

  • Entrez votre email (github)
  • Entrez votre mot de passe (github)

Et voilà votre module est disponible sur github !

Quelques conseils

  • Aucune configuration ou mot de passe ne doit pas être inclus dans le module ! Utiliser le dossier /user/config/nom_du_module pour cela !
  • Mettez uniquement les scripts dans la base de votre module, mettez le code / configurations / documentations dans des dossiers.
  • Aller voir les modules sur github.com/pigetnet en particulier ceux qui sont documentés pour voir comment faire.
  • Nous verrons comment documenter les scripts dans un autre tutoriel à venir
  • Nous verrons comment utiliser les commandes system dans un autre tutoriel.

Les autres commandes

A venir …

 

 

Les commentaires sont clos.