À noter: le tutoriel ci-bas est à réaliser après avoir consulté le jupyter notebook intitulé intro_TP0.ipynb La visualisation des jupyter notebook est possible directement via l'environnement PyCharm ou Visual Studio Code que vous avez déjà installé.
- TP0: Introduction au terminal et à Git/GitHub
Qu'est-ce que Git/GitHub?Se familiariser avec les commandes les plus communes que vous allez utiliser sur Git/GitHub via un terminal (voir les instructions particulières pour l'accès au terminal pour votre système d'exploitation) en modifiant un fichier à l'exercice ci-bas.
Git est un système de gestion de versions, il vous permet de garder un historique de toutes les modifications que vous faites dans un répertoire (lieu où vous sauvegardez un TP/Projet dans votre cas) aux fichiers qui y sont présents. Ainsi, il est plus facile de vous rappeler les divers modifications qui y ont été faites en les associant à un message informatif. Ceci enlève le risque de perdre votre travail puisque tout est inventorié. Également, Git facilite le travail collaboratif puisque deux personnes peuvent avoir une copie locale du même projet auquel ils font des modifications en parallèle. Quant à lui, GitHub est un site web qui permet d'entreposer des répertoires Git en ligne.
Afin de débuter, il faut s'assurer d'avoir installé Git au préalable en suivant le lien. Par la suite, voici les étapes à réaliser:
- Se créer un dossier INF1007 quelque part sur son ordinateur pour y garder les prochains TPs et projets en plus du TP0 actuel. Il est aussi possible de le faire directement via un terminal en utilisant la commande
mkdir - Ouvrir VSCode ou PyCharm et cliquer sur
Open Foldertel qu'illustré sur la Figure 1 ci-dessous et choisir le nouveau dossier INF1007 créé - Cliquer sur
Terminaldans la barre de recherche de VSCode puisNew Terminalpour commencer avec la première commande git soit git clone ou bien sur PyCharm c'est en bas de la page et nomméTerminalaussi. - Maintenant, vous pouvez fermer le VSCode ou bien cliquer sur
FilepuisOpen Folder...et ouvrir maintenant le répertoire GitHub qui a été cloné (intitulé par exemple L01-TP0-votre-username-git) - Vous être prêts à faire toutes les commandes les plus utilisées de Git à partir de git add jusqu'à git push, c'est parti!
- (Optionnel) Vérifier que tout a été mis sur GitHub en cliquant sur refresh et en voyant vos modifications!
 |
|---|
| Figure 1 |
Habituellement, tout commence par cloner un répertoire disponible en ligne sur GitHub. Vous pouvez cliquer sur le rectangle vert intitulé '<>Code' puis rendez-vous sur le terminal où vous écrirez la commande suivant:
git clone https://github.com/exemple-de-lien/2023H-TP0.gitCette commande permet d'ajouter un fichier que vous voulez répertorier les changements que vous y apportez. C'est la première étape à faire après avoir fait un changement à un fichier quelconque:
git add nom-du-fichier.pyLorsque vous êtes satisfait des changements apportés, il faut maintenant 's'engager' et ajouter un message (-m) qui explique ce qui a été modifié tel que:
git commit -m "Réponse à la question 1 complétée"Qui vous retourne par exemple comme message:
[main 1dfd86a] Réponse à la question 1 complétée
1 file changed, 3 insertions(+), 1 deletion(-)Un moyen de faire un git add sur tous les fichiers modifiés dans un répertoire en même temps est d'ajouter un -a (signifiant 'all') avant d'inscrire votre message informatif. Lorsque cette commande est utilisée, il n'est pas nécessaire de faire un git add auparavant.
git commit -a -m "Réponse à la question 1 complétée"Ceci est la dernière étape qui rend visible vos modifications à un autre collaborateur potentiel puisque les changements seront maintenant disponibles sur le répertoire GitHub.
git push origin mainLorsque vous commencez à travailler sur un projet d'équipe dont vous savez potentiellement que votre coéquipier a fait des changements, il faut aller 'tirer' les changements vers la version locale du répertoire que vous avez sur votre ordinateur. Ainsi, simplement tapez:
git pull origin mainCette commande qui est souvent négligée ou oubliée, mais pourtant très utile, permet de vous dire où vous en être rendu dans le 'workflow' de Git. Ainsi, il vous avise à quelle étape vous êtes rendue... Dois-je 'add', 'commit' ou bien suis-je prêt à 'push' ma version locale vers GitHub? Toutes vos questions seront répondues! Des exemples de statuts sont:
nothing to commit, working tree cleanVous êtes donc prêts à push, ou bien:
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
modified: README.md
no changes added to commit (use "git add" and/or "git commit -a")Il vous faut donc faire un 'commit' avant de pouvoir 'push' vos modifications sur le serveur virtuel GitHub!
À noter qu'il existe beaucoup plus de commandes Git utiles, mais les commandes ci-haut sont celles que vous utiliserez le plus souvent
L'exercice consiste tout simplement à faire des modifications sur le fichier python intitulé hello.py qui est disponible sur ce répertoire GitHub en suivant les TODO indiqués. Il faut ajouter l'équation de l'aire d'un cercle afin d'y afficher par la suite l'aire. Aussi, à l'aide d'un second 'print statement', affichez votre nom et prénom. N'oubliez pas d'écrire un message indiquant les modifications que vous avez réalisées!
Sur Windows, afin de travailler sur le terminal, il est plus simple d'installer Anaconda via ce lien. Par la suite, aller chercher 'Anaconda Prompt (Anaconda 3)' dans la barre de recherche afin de commencer à l'utiliser! Vous pouvez aussi utiliser l'application 'Git CMD' qui s'installe automatiquement après avoir installé Git et qui est également un terminal.
Pour ouvrir le terminal, appuyez sur les touches Commande + Espace, écrivez Terminal et choisissez la 1ère application qui s'affiche, ça devrait être un carré noir avec un > dans le coin en haut à gauche.
Pour ouvrir le terminal, appuyez sur la touche Windows, écrivez Terminal et choisissez la 1ère application qui s'affiche. Vous pouvez aussi utiliser le raccourci CTRL + ALT + T pour ouvrir un terminal directement.
Voici les commandes les plus utilisées afin de naviguer sur le terminal pour vous mettre, par exemple, à l'endroit où vous voulez cloner un répertoire GitHub. Le terminal fonctionne selon des chemins vers vos fichiers qui peuvent s'apparenter à une adresse. Initialement le terminal ressemblera à ceci si vous êtes sur Windows:
(base) C:\Users\votre-username>Disons que vous voulez aller vers votre dossier Documents puis INF1007, vous allez utiliser la commande 'cd' qui veut dire 'change directory' afin de vous déplacer vers ce nouveau chemin:
(base) C:\Users\votre-username> cd Documents/INF1007Dont le résultat sera:
(base) C:\Users\votre-username\Documents\INF1007>Ainsi, on est bel et bien à la bonne place maintenant! Il suffit de faire votre git clone à l'endroit voulu. Pour revenir en arrière si vous vous êtes trompés de chemin, ne paniquez pas la commande est simple, il s'agit de:
(base) C:\Users\votre-username\Documents\INF1007>cd ..Qui vous remet donc à:
(base) C:\Users\votre-username\Documents>Finalement, pour savoir à tout moment vous vous situez à quel endroit, et bien tapez 'pwd' signifiant 'print working directory' qui vous imprimera le chemin auquel vous êtes présentement.
Voilà, le tour est joué! 🎇