Création package avec PkgTemplates.jl (conseillé dans Pkg.jl)

Prérequis

1. Pour ce tuto, on ouvre un terminal avec un shell intégré (powershell pour Windows).
2. Un compte Github doit avoir été créé au préalable
3. Le package Revise.jl doit être installé et using Revise doit appraître dans /Users/rcqls/.julia/config/startup.jl
4. Tous mes packages julia ou autres repo qui sont sur Github sont placés dans ~/Github. Si vous changez d'emplacement, pensez bien à en tenir compte pour la suite du tutoriel.
   • Si ce répertoire n'existe pas encore:
     • cd~ (powershell) ou cd ~ (linux/macOS)
     • puis mkdir Github
   • Pour la suite se placer dans ce répertoire: cd Github
   • Lancer la session julia (en tapant dans le terminal, julia)
5. Installation (UNE SEULE FOIS) du package PkgTemplates.jl en charge de la création de nouveaux packages
   • Dans le terminal, lancer julia
   • puis taper ] (pour passer en mode package) et add PkgTemplates
   • taper [Effacer en Arrière] pour revenir en mode julia normal

Création du package

1. PkgTemplates.jl étant installé
   1. Pour lancer la création du package appliquer l'une des méthodes suivantes:
      • PkgTemplates.generate()
      • using PkgTemplates puis generate()
   2. Suivez ensuite les instructions:
      • Attention: le nom du package doit finir par .jl comme dans MonPackage.jl (où ici MonPackage est à changer par le nom de package de votre choix)
      • Ainsi, en mode interactif, sélectionner:
        • user (nom du compte utilisateur Github)
        • dir (le répertoire où installer le package: . signifiant répertoire courant)
        • julia (depuis la sortie de la version 1.11, la version de julia minimale est la 1.10)
      • Enfin, appuyer sur d (pour done) et finaliser les modifications demandées.
2. Une fois le package MonPackage.jl créé, quitter la console julia (en tapant le racourci clavier [Ctrl]+[D]) pour retourner dans le terminal dans le répertoire couranr (~/Github)
   • Lancer VSCode: code -n MonPackage.jl
   • Tous les éléments créés par PkgTemplates.generate() doivent être visibles
   • Aussi noter (preuve de la réussite de la création du package) qu'en bas de VSCode vous voyez: Julia env: MonPackage.jl. Cela signifie que le package est dans un environnement local activé et géré par les fichiers Project.toml et Manifest.toml
3. Publication du package
   • Dans le navigateur, aller sur la page de votre compte Github
   • Créer un repo MonPackage.jl (dans l'onglet "repositories" cliquer sur "new")
   • Ouvrir votre application GithubDesktop,
     1. ajouter le repo git existant (ici, ~/Github/MonPackage.jl) en tant que "ajout de repo existant"
     2. deux "commits" ont déjà été faits à la création du package donc faire "push" pour déplacer le projet sur le serveur Github
   • Hourra! Votre projet local du package MonPackage.jl est accessible sur le serveur Github

Vos premières fonctions (phase de test)

• Modifier le fichier ~/Github/MonPackage.jl/src/MonPackage.jl comme suit

   1  module MonPackage
   2  export bonjour # pour organiser
   3  
   4  # Write your package code here.
   5  include("bonjour.jl")
   6  
   7  end

• et créer le fichier ~/Github/MonPackage.jl/src/bonjour.jl

   1  bonjour() = "coucou le monde!"

• Pour tester les fonctionnalités du package:
  • j'aime créer un répertoire examples à la racine du package (mkdir ~/Github/MonPackage.jl/examples) pour y mettre mes fichiers julia pour jouer avec le package
  • ce répertoire examples n'est pas un nom spécifique, l'avantage est toutefois que comme VSCode a activé le package MonPackage.jl, en ouvrant un fichier dans examples on peut faire using MonPackage sans avoir à le réinstaller à chaque modification du package.
  • par exemple, créer le fichier examples/essai.jl comme suit:

   1  using MonPackage
   2  bonjour()

• [Shift]+[Enter] sur chaque ligne permet de vérifier que tout marche bien

Les changements faits ici ne sont pas assez importants pour être enregistrés sur Github mais vous aurez compris qu'avec l'application GithubDesktop vous pouvez incrémentalement mettre à jour vos modifications sur le serveur Github.

Libre à vous maintenant de faire évoluer votre package MonPackage.jl et d'en créer de nouveaux.

Utilisation du package MonPackage.jl

• Notez tout de suite que votre package MonPackage.jl n'est pas installé globalement sur votre ordinateur (en ouvrant un terminal et en lançant julia dans un répertoire extérieur à ~/Github/MonPackage.jl)
• Pour l'installer ouvrir julia (dans un répertoire à l'extérieur de ~/Github/MonPackage.jl) et passer en mode pkg (en tapant touche ]) et lancer add https://github.com/<user>/MonPackage.jl (<user> étant le nom de l'utilisateur Github)