Skip to content

INSTALL.md

Latest commit

 

History

History
294 lines (251 loc) · 16.5 KB

INSTALL.md

File metadata and controls

294 lines (251 loc) · 16.5 KB

Guide d'installation de l'environnement de TPs Python

Installer Python

Python est un langage de programmation interprété. Pour exécuter un programme écrit dans ce langage, il faut disposer d'un interpréteur Python ainsi que de certaines bibliothèques installées sur la machine.

Nous utiliserons la version 3.9 de Python. En 2021, c'est la version la plus récente du langage disponible sur la plupart des architectures de machine.

Pour simplifier l'installation des outils nécessaires, nous allons utiliser une distribution Python. Il en existe plusieurs mais nous nous appuyerons sur la distribution Miniconda qui est une version allégée de la distribution Anaconda.

Installer la distribution Miniconda

  1. Télécharger la version de Miniconda pour Python 3.9 et adaptée à votre système. La plupart des machines ont des processeurs de 64-bits, si vous avez sur 32-bits, téléchargez la version adaptée.

  2. Installer Miniconda

    • pour Windows, double-cliquer sur le fichier .exe téléchargé précédemment puis accepter les choix par défaut sauf à la dernière étape :
      • accepter la licence ("I Agree")
      • "Install for", "Just Me (recommended)" ("Next")
      • "Choose Install Location", ("Next")
      • "Register Miniconda3 as my default Python 3.9", ("Install")
      • "Installation Complete", ("Next")
      • "Completing Miniconda3...", décocher tout ("Finish")
    • pour Mac OS, double-cliquer sur le fichier .pkg téléchargé précédemment puis accepter les choix par défaut
    • pour Linux, ouvrir un terminal dans le répertoire où se trouve le fichier téléchargé et taper : 
      sh Miniconda3-latest-Linux-x86_64.sh
      À l'affichage de : 
      Welcome to Miniconda3 py39_4.10.3

In order to continue the installation process, please review the license
agreement.
Please, press ENTER to continue
>>>
      Appuyer sur la touche ENTRÉE, puis la licence du logiciel va s'afficher : 
      [...]
Do you accept the license terms? [yes|no]
[no] >>> yes
      Taper yes, puis à la question : 
      Miniconda3 will now be installed into this location:
/home/user/miniconda3

- Press ENTER to confirm the location
- Press CTRL-C to abort the installation
- Or specify a different location below

[/home/user/miniconda3] >>>
      Accepter le choix par défaut, enfin, répondre yes à 
      Do you wish the installer to initialize Miniconda3
by running conda init? [yes|no]
[no] >>> yes
      Fermer ensuite votre terminal.

  3. Tester l'installation

    • sous Windows, ouvrir un Anaconda Prompt; sous Mac OS ou Linux, ouvrir un terminal et taper : 
      conda list
      doit afficher une liste de bibliothèques : 
      # packages in environment at /home/user/miniconda3:
#
# Name                    Version                   Build  Channel
brotlipy                  0.7.0           py39h2bbff1b_1003
ca-certificates           2021.7.5             haa95532_1
certifi                   2021.5.30        py39haa95532_0
cffi                      1.14.6           py39h2bbff1b_0
chardet                   4.0.0           py39haa95532_1003
conda                     4.10.3           py39haa95532_0
conda-package-handling    1.7.3            py39h8cc25b3_1
console_shortcut          0.1.1                         4
cryptography              3.4.7            py39h71e12ea_0
idna                      2.10               pyhd3eb1b0_0
[...]
      Pour vérifier la version de Python, taper : 
      python -V
      qui doit afficher (le dernier chiffre peut varier) : 
      Python 3.9.5

Plus d'informations (en anglais) peuvent être trouvées sur le site officiel de Miniconda (Installation pour Windows, installation pour Max OS, installation pour Linux).

Installer un éditeur de texte

De nombreuses applications peuvent être utilisées pour saisir un document textuel sur un ordinateur (LibreOffice Writer, Notepad++, ...). Dans le contexte de la programmation, il est important que le texte du programme ne soit pas modifié par des informations de mise en forme comme le ferait un logiciel de traitement de texte comme LibreOffice Writer.

Il faut donc choisir un logiciel dans la catégorie des éditeurs de texte ou des environnement de développement intégré (integrated development environment ou IDE en anglais). Les différents outils de ce type varient beaucoup en terme de fonctionnalités et de complexité d'usage.

Nous avons choisi le logiciel Visual Studio Code. Il est un bon compromis entre fonctionnalités et complexité tout en étant disponible pour les principales architectures et systèmes d'exploitation.

Installer Visual Studio Code

  1. Télécharger la version de Visual Studio Code adaptée à votre système
  2. Lancer l'installation du programme à partir du fichier téléchargé (pour Windows, pour Mac OS, pour Linux)

Nous ne détaillons pas ici la procédure d'installation car elle ne présente pas de difficulté majeure.

Installer un système de gestion de versions

Un système de gestion de versions (Version Control System ou VCS en anglais) est un logiciel qui conserve une trace de chaque modification importante effectuée sur un ensemble de documents. Dans le contexte de la programmation, il sauvegarde et suit les modifications d'un ensemble de fichiers sources.

L'outil que nous allons utiliser pour cela se nomme git. C'est à l'heure actuelle (en 2020) le logiciel open source le plus utilisé pour cette tâche.

L'outil git gérera votre projet localement sur une machine mais il est très utile de faire héberger son projet sur le web. C'est ce que propose la plateforme github. Ce service offre la possibilité de sauvegarder son projet dans le cloud afin de pouvoir le récupérer de n'importe quelle machine connectée.

Création d'un compte github

À l'adresse https://github.com/join, créer un compte en précisant :

  • le nom d'utilisateur (username) uvsqXXXXXXXX en remplaçant XXXXXXXX par votre numéro d'étudiant,
  • l'adresse mail (Email address) prenom.nom@ens.uvsq.fr,
  • et un mot de passe (Password).

Il faut ensuite consulter les mails à cette adresse pour confirmer l'adresse d'inscription.

Copier le projet dans son espace github personnel

Un "projet" sous git et github se nomme un dépôt (repository en anglais). Attention car la notion de projet (project) sous github est différente.

Le dépôt git contenant l'ensemble du projet n'est pas modifiable par tout le monde. Pour pouvoir faire des changements dessus, il faut donc d'abord le copier dans votre espace personnel. Sous github, cette opétation se nomme un fork et est utilisée pour copier un dépôt entre deux espaces utilisateurs.

La procédure pour cela est la suivante :

  1. se rendre sur la page github du dépôt à copier (https://github.com/uvsq-info/l1-python dans notre cas),
  2. cliquer sur le bouton Fork en haut à droite de l'écran
  3. sélectionner votre espace personnel comme destination du fork

Vous disposez maintenant d'une copie personnelle du dépôt avec une URL qui devrait ressembler à https://github.com/uvsqXXXXXXXX/l1-python.

Installer git

L'étape suivante consiste à récupérer une copie locale du projet. Nous utiliserons pour cela l'interface git intégrée à l'éditeur de texte. Cependant, cette dernière s'appuie sur l'outil en ligne de commande git que nous allons installer maintenant.

Sous Windows

  1. Télécharger git sous Windows
  2. Double-cliquer sur le fichier téléchargé pour lancer l'installation
  3. Conserver les choix par défaut proposés lors de l'installation sauf pour les étapes en gras ci-dessous :
    • accepter la licence ("Next")
    • "Select Destination Location", ("Next")
    • "Select Components", ("Next")
    • "Select Start Menu Folder", ("Next")
    • "Choosing the default editor used by Git", choisir "Use Visual Studio Code as Git's default editor" ("Next")
    • "Let Git decide" ("Next")
    • "Adjusting your PATH environment", déjà sélectionné "Git from the command line and also from 3rd-party software" ("Next")
    • "Choosing the SSH executable", déjà sélectionné "Use OpenSSH" ("Next")
    • "Choosing HTTPS transport backend", déjà sélectionné "Use the OpenSSL library" ("Next")
    • "Configuring the line ending conversions", déjà sélectionné "Checkout Windows-style, commit Unix-style line endings" ("Next")
    • "Configuring the terminal emulator to use with Git Bash", déjà sélectionné "Use MinTTY (the default terminal of MSYS2)" ("Next")
    • "Choose the default behavior of 'git pull'", déjà sélectionné "Default (fast-forward or merge)" ("Next")
    • "Choose a credentiel helper", choisir "None"("Next")
    • "Configuring extra options", "Enable file system caching" (déjà sélectionné) et "Enable symbolic links" ("Next")
    • "Configuring experimental options", rien n'est sélectionné ("Install")
    • "Completing the Git Setup Wizard", décocher tout ("Next")

Sous Mac OS

  1. Installer Homebrew
  2. Dans un terminal, taper : 
    brew install git

Une alternative pourrait être d'installer git par l'intermédiaire de conda (package git pour conda).

Sous Linux

L'installation de git est très simple mais dépend de la distribution Linux installée. Par exemple, avec une distribution debian, il suffit de taper dans un terminal :

sudo apt update
sudo apt install git

Pour trouver la commande correspondant à votre système, rendez-vous sur la page Download for Linux and Unix et choisissez les commandes adéquates.

Finaliser et vérifier l'installation

  1. Sous Windows, ouvrir un Git Bash; sous Mac OS et Linux, ouvrir un terminal et taper : 
    git --version
    qui devrait afficher (les deux derniers numéros peuvent être différents) : 
    git version 2.33.0
  2. Dans le même terminal, taper (en substituant votre prénom et votre nom) : 
    git config --global user.name "Prénom NOM"
git config --global user.email "prenom.nom@ens.uvsq.fr"
git config --global color.ui auto
  3. Fermer le terminal

Récupérer et initialiser le projet localement

Cette étape va consister à créer sur votre machine une copie du dépôt github. Nous utiliserons pour cela Visual Studio Code (abrégé en VSCode dans la suite). Cela nous permettra également d'en finaliser l'installation en ajoutant les extensions utiles pour le développement logiciel en Python.

Création d'une copie locale du projet

  1. Lancer VSCode
  2. Cliquer sur l'icone en forme de graphe à 3 noeuds à gauche de l'écran (Source Control ou Ctrl+Shift+G)
  3. Cliquer sur le bouton "Clone Repository" à gauche de l'écran ou Ctrl+Shift+P puis sélectionner "Clone from Github"
  4. Cliquez sur "Allow" dans la boite de dialogue puis accepter les différents choix proposés dans le navigateur ou dans une boite de dialogue VSCode (le navigateur doit être celui où le fork a été fait dans votre espace personnel github)
  5. Sélectionner le dépôt "uvsqXXXXXXXX/l1-python" dans la liste déroulante puis choisissez l'emplacement local du projet
  6. Ouvrir ensuite le répertoire créé ci-dessus

Choisir le shell de commande par défaut

Cette étape précise à VSCode quel shell utiliser pour le terminal.

  1. Appuyer sur Ctrl+Shift+P pour ouvrir la palette de commandes
  2. Taper "Terminal: Select Default Profile"
  3. Sélectionner
    • "Command Prompt" sous Windows
    • "bash" sous Mac OS ou Linux

Créer l'environnement Python du projet

Pour isoler l'environnement du projet d'éventuelles autres versions de Python ou de bibliothèques, nous allons créer un environnement conda spécifique.

  1. Dans VSCode, après s'être assuré que le répertoire du projet est ouvert, ouvrir un terminal (menu Terminal/New Terminal ou View/Terminal)
    • sous Windows, conda n'est pas accessible dans le "Command Prompt"; pour palier ce problème, il faut personnaliser le paramètre terminal.integrated.shellArgs.windows de VSCode (Ctrl , (Ctrl et virgule en même temps), rechercher "terminal.integrated.profiles.windows", cliquer sur "Edit in settings.json"). Par exemple (adapter les chemins selon l'installation de miniconda) : 
      "path": "C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\powershell.exe",
"args": [
        "/K",
        "C:\\Users\\moi\\miniconda3\\Scripts\\activate.bat C:\\Users\\moi\\miniconda3"
    ]
    • une autre option sous Windows est de lancer VSCode à partir d'un "Anaconda prompt"
  2. Taper (Il faut garder sa connexion internet pendant la création de l'environnement) 
    conda env create
conda activate l1-python
  3. Fermer le terminal en tapant 
    exit

Finaliser l'installation de VSCode

  1. Dans la liste "EXPLORER" à gauche de l'écran, sélectionner le fichier "examples/hello/hello.py"
  2. Sélectionner l'interpréteur Python 3.9 dans l'environnement l1-python "Python 3.9.X XX-bit ('l1-python': conda)"
    • cliquer en bas à gauche dans la barre d'état ou Ctrl+Shift+P puis sélectionner "Python: Select Interpreter"
  3. Activer les outils de vérification statique (Linters)
    1. Ouvrir la palette de commande (Ctrl+Shift+P)
    2. Sélectionner la commande "Python: Select Linter"
    3. Choisir flake8 dans la liste

Utiliser le projet

Pour utiliser le projet, consulter le README.md du projet.

Dépannage des problèmes d'installation

conda n'est pas accessible dans le terminal VSCode

Ce problème survient sur une plateforme Windows lors de l'étape "Créer l'environnement Python du projet". La solution suggérée ci-dessus dans le guide d'installation est délicate à mettre en œuvre.

Une alternative consiste à :

  1. ouvrir un anaconda prompt (hors de VSCode)
  2. se placer dans le répertoire du projet
  3. taper les commandes dans ce terminal (conda env create, ...)

Le shell est zsh

Le dernier MacOS (nommé Catalina depuis 2019) n'utilise plus le shell bash mais zsh. Cela pose des soucis lors de l'installation de miniconda. Une solution est décrite dans Installing miniconda with zsh :

  1. Modifier la variable d'environnement PATH dans le ~/.zshrc : 
    export PATH="~/miniconda3/bin:$PATH"
  2. Ouvrir un terminal et taper : 
    cd ~/miniconda3/bin && conda update conda
conda init zsh

Guide pour les anciennes versions du cartable numérique

Le guide d'utilisation est se trouve dans CARTABLE_NUM.md.