Skip to content

Latest commit

 

History

History
1861 lines (1166 loc) · 64.2 KB

WINDOWS.md

File metadata and controls

1861 lines (1166 loc) · 64.2 KB

Setup instructions

You will find below the instructions to set up you computer for Le Wagon Data Science course

Please read them carefully and execute all commands in the following order. If you get stuck, don't hesitate to ask a teacher for help 🙋

Let's start 🚀

Zoom

To be able to interact when we are not in the same physical room, we will be using Zoom, a video conferencing tool.

⚠️ If you already have Zoom installed, please make sure that the version is at least 5.6.

Go to zoom.us/download.

Under Zoom Client click the Download button.

Open the file you have just downloaded to install the app.

Open the Zoom app.

If you already have a Zoom account, sign in using your credentials.

If not, click on the Sign Up Free link:

Sign Up Free to Zoom

You will be redirected to Zoom's website to complete a form.

When it's done, go back to the Zoom app and sign in using your credentials.

You should then see a screen like this:

Zoom Home Screen

You can now close the Zoom app.

GitHub account

Have you signed up to GitHub? If not, do it right away.

👉 Upload a picture and put your name correctly on your GitHub account. This is important as we'll use an internal dashboard with your avatar. Please do this now, before you continue with this guide.

GitHub picture

👉 Enable Two-Factor Authentication (2FA). GitHub will send you text messages with a code when you try to log in. This is important for security and also will soon be required in order to contribute code on GitHub.

Windows version

Before we start, we need to check that the version of Windows installed on your computer is compatible with this setup instructions.

Windows 10 or Windows 11

To be able to set up your computer, you need to have Windows 10 or Windows 11 installed.

To check your Windows version:

  • Press Windows + R
  • Type winver
  • Press Enter

✔️ If the first words of this window are Windows 10 or Windows 11 you're good to go 👍

❌ If not, you cannot proceed with this setup. You have to upgrade to Windows 10 first 👇

Upgrade to Windows 10
  • Download Windows 10 from Microsoft
  • Install it. It should take roughly an hour, but this depends on your computer.
  • When the installation is over, execute the commands above ☝️ to check that you now have Windows 10.

ℹ️ Windows 11 upgrade is rolling out now, which means it may or may not be available for your computer just yet.

⚠️ If you have Windows 10 installed, you don't need to upgrade to Windows 11 to proceed with this setup.

Latest updates

Once you're sure that you're using Windows 10 or 11, you need to install all the latest updates.

Open Windows Update:

  • Press Windows + R
  • Type ms-settings:windowsupdate
  • Press Enter
  • Click on Check updates

✔️ If you see a green check mark and the message "You're up to date", you're good to go 👍

⚠️ If you have a red exclamation mark and the message "Update available", please install them and repeat the process until it says that you are up to date ➿

❌ If you have an error message about Windows not being able to apply updates, please contact a teacher.

Activate Windows Update Service to fix Updates

Some antiviruses and pieces of software deactivate the Update service we need, resulting in the error you see. Let's fix that!

  • Press Windows + R
  • Type services.msc
  • Press Enter
  • Double Click Windows Update Service
  • Set its Startup to Automatic
  • Click on Start
  • Click on Ok Then let's try updates again!

Minimum version

Some of the tools we need to install have been release with the 1903 version or above of Windows 10 so we need to make sure you have at least this one.

  • Press Windows + R
  • Type winver
  • Press Enter

Check the Version number:

✔️ If it says at least 1903, you are good to go 👍

❌ If it is below 1903, please contact a teacher.

Virtualization

We need to ensure that the Virtualization options are enabled in the BIOS of your computer.

For many computers, this is already the case. Let's check:

  • Press Windows + R
  • Type taskmgr
  • Press Enter
  • Click on the Performance tab
  • Click on CPU

Windows task manager

✔️ If you see "Virtualization: Enabled", you're good to go 👍

❌ If the line is missing or if the virtualization is disabled, please contact a teacher before trying to activate the Virtualization

Activate Virtualization

We need to access the BIOS / UEFI of the computer to activate it.

  • Press Windows + R
  • Type shutdown.exe /r /o /t 1
  • Press Enter
  • Wait for the computer to shutdown
  • Click on Troubleshoot
  • Click on Advanced Options
  • Click on UEFI Firmware Settings
  • Click on Restart

You need to activate the virtualization option for your processor here:

  • Most of the time, in the advanced settings, the CPU settings, or the Northbridge settings
  • The option can be called differently according to your computer:
    • Intel: Intel VT-x, Intel Virtualization Technology, Virtualization Extensions, Vanderpool...
    • AMD: SVM Mode or AMD-V
  • Save the changes after activation and reboot the computer through the appropriate option

Windows Subsystem for Linux (WSL)

WSL is the development environment we are using to run Ubuntu. You can learn more about WSL here.

ℹ️ The following instructions depend on your version of Windows. Please execute only the instructions corresponding to your version 👇

Windows 11

If you are running Windows 11, we will install WSL 2 and Ubuntu in one command through the Windows Terminal.

⚠️ In the following instruction, please be aware of the Ctrl + Shift + Enter key stroke to execute Windows Terminal with administrator privileges instead of just clicking on Okor pressing Enter.

  • Press Windows + R
  • Type wt
  • Press Ctrl + Shift + Enter

⚠️ You may have to accept the UAC confirmation about the privilege elevation.

A blue terminal window will appear:

  • Copy the following command (Ctrl + C)
  • Paste it into the terminal window (Ctrl + V or by right-clicking in the window)
  • Run it by pressing Enter
wsl --install

✔️ If the command ran without any error, please restart your computer and continue below 👍

❌ If you encounter an error message (or if you see some text in red in the window), please contact a teacher

Windows 10

Install WSL 1

If you are running Windows 10, we will first install WSL 1 through the PowerShell Terminal.

⚠️ In the following instruction, please be aware of the Ctrl + Shift + Enter key stroke to execute Windows PowerShell with administrator privileges instead of just clicking on Okor pressing Enter.

  • Press Windows + R
  • Type powershell
  • Press Ctrl + Shift + Enter

⚠️ You may have to accept the UAC confirmation about the privilege elevation.

A blue terminal window will appear:

  • Copy the following commands one by one (Ctrl + C)
  • Paste them into the PowerShell window (Ctrl + V or by right-clicking in the window)
  • Run them by pressing Enter
Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart

✔️ If all three commands ran without any error, please restart your computer and continue below 👍

❌ If you encounter an error message (or if you see some text in red in the window), please contact a teacher

Upgrade to WSL 2

If you are running Windows 10, we will then upgrade WSL to version 2.

Once your computer has restarted, we need to download the WSL2 installer.

  • Go to the download page
  • Download "WSL2 Linux kernel update package"
  • Open the file you've just downloaded
  • Click Next
  • Click Finish

Update WSL from version 1 to 2

✔️ If didn't encounter any error message, you're good to go 👍

❌ If you encounter the error "This update only applies to machines with the Windows Subsystem for Linux", right click on the program and select uninstall; you shall be able to install it normally this time.

Make WSL 2 the default Windows Subsystem for Linux

If you are running Windows 10, we will set WSL default version to 2.

Now that WSL 2 is installed, let's make it the default version:

  • Press Windows + R
  • Type cmd
  • Press Enter

In the window which appears, type:

wsl --set-default-version 2

✔️ If you see "The operation completed successfully", you can close this terminal and continue to follow the instructions below 👍

❌ If the message you get is about Virtualization, please contact a teacher

Enable Virtual Machine Platform Windows feature

Follow the steps described here until you enable Virtual Machine Platform and Windows Subsystem for Linux

Enable Hyper-V Windows feature

Follow the steps described here until you enable the group Hyper-V

ℹ️ If you are running Windows 10 Home edition, Hyper-V feature is not available for your operating system. It's non-blocking and you can still continue to follow the instructions below 👌

Ubuntu

Installation

ℹ️ The following instructions depend on your version of Windows. Please execute only the instructions corresponding to your version 👇

Windows 11

If you are running Windows 11, after restarting you computer, you should see a terminal window saying WSL is resuming the Ubuntu installation process. When it's done, Ubuntu will be launched.

Windows 10

If you are running Windows 10, let's install Ubuntu throught the Microsoft Store:

  • Click on Start
  • Type Microsoft Store
  • Click on Microsoft Store in the list
  • Search for Ubuntu in the search bar
  • Select version without any number, just plain "Ubuntu"
  • Click on Get

⚠️ Don't install Ubuntu 18.04 LTS nor Ubuntu 20.04!

Uninstall wrong versions of Ubuntu

To uninstall a wrong version of Ubuntu, you just have to go to the Installed Program List of Windows 10:

  • Press Windows + R
  • Type ms-settings:appsfeatures
  • Press Enter

Find the software to uninstall and click on the uninstall button.

Once the installation is finished, the Get button becomes a Open button: click on it.

First launch

At first launch, you will be asked some information:

  • Choose a username:
    • one word
    • lowercase
    • no special characters
    • for example: lewagon or your firstname
  • Choose a password
  • Confirm your password

⚠️ When you type your password, nothing will show up on the screen, that's normal. This is a security feature to mask not only your password as a whole but also its length. Just type your password and when you're done, press Enter.

You can close the Ubuntu window now that it is installed on your computer.

Check the WSL version of Ubuntu

  • Press Windows + R
  • Type cmd
  • Press Enter

Type the following command:

wsl -l -v

✔️ If the version of Ubuntu WSL is 2, you are good to go 👍

❌ If the version of Ubuntu WSL is 1, we will need to convert it to version 2.

Convert Ubuntu WSL V1 to V2

In the Command Prompt window, type:

wsl --set-version Ubuntu 2

✔️ After a few seconds, you should get the following message: The conversion is complete.

❌ If it does not work, we need to be sure that Ubuntu files are not compressed.

Check for Uncompressed Files
  • Press Windows + R
  • Type %localappdata%\Packages
  • Press Enter
  • Open the folder named CanonicalGroupLimited.UbuntuonWindows...
  • Right Click on the LocalState folder
  • Click on Properties
  • Click on Advanced
  • Make sure that the option Compress content is not ticked, then click on Ok.

Apply changes to this folder only and try to convert the Ubuntu WSL version again.

❌ If the conversion still does not work, please contact a teacher.

Check the locale

The locale is a mechanism allowing to customize programs to your language and country.

Let's verify that the default locale is set to English, please type this in the Ubuntu terminal:

locale

If the output does not contain LANG=en_US.UTF-8, run the following command in a Ubuntu terminal to install the english locale:

sudo locale-gen en_US.UTF-8

If after, you receive a warning (bash: warning: setlocale: LC_ALL: cannot change locale (en_US.utf-8)) in your terminal, please do the following:

Generate locale

Please, run this lines in your terminal.

sudo update-locale LANG=en_US.UTF8
sudo apt-get update
sudo apt-get install language-pack-en language-pack-en-base manpages

You can now close this terminal window.

Chrome - your browser

Install the Google Chrome browser if you haven't got it already and set it as a default browser.

Follow the steps for your system from this link 👉 Install Google Chrome

Why Chrome?

We recommend to use it as your default browser as it's most compatible with testing or running your code, as well as working with Google Cloud Platform. Another alternative is Firefox, however we don't recommend using other tools like Opera, Internet Explorer or Safari.

Visual Studio Code

Installation

Let's install Visual Studio Code text editor.

VS Code installation options

When the installation is finished, launch VS Code.

Connecting VS Code to Ubuntu

To make VS Code interact properly with Ubuntu, let's install the Remote - WSL VS Code extension.

Open your Ubuntu terminal.

Copy-paste the following commands in the terminal:

code --install-extension ms-vscode-remote.remote-wsl

Then open VS Code from your terminal:

code .

✔️ If you see WSL: Ubuntu in the bottom left corner of the VS Code window, you're good to go 👍

WSL Ubuntu Remote

❌ Otherwise, please contact a teacher

Windows Terminal

Installation

ℹ️ The following instructions depend on your version of Windows.

If you are running Windows 11, the Windows Terminal is already installed and you can proceed to the next section 👇

If you are running Windows 10, let's install Windows Terminal, a real modern terminal:

  • Click on Start
  • Type Microsoft Store
  • Click on Microsoft Store in the list
  • Search for Windows Terminal in the search bar
  • Select Windows Terminal"
  • Click on Install

⚠️ DO NOT install Windows Terminal Preview, just Windows Terminal!

Uninstall wrong version of Windows Terminal

To uninstall a wrong version of Windows Terminal, you just have to go to the Installed Program List of Windows 10:

  • Press Windows + R
  • Type ms-settings:appsfeatures
  • Press Enter

Find the software to uninstall and click on the uninstall button.

Once the installation is finished, the Install button becomes a Launch button: click on it.

Ubuntu as the default terminal

Let's make Ubuntu the default terminal of your Windows Terminal application.

Press Ctrl + ,

It should open the terminal settings:

Windows Terminal Settings

  • Change the default profile to "Ubuntu"
  • Click on "Save"
  • Click on "Open JSON file"

You may see an orange circle rather than a penguin as the logo for Ubuntu.

We have circle in red the part you will change:

Windows Terminal JSON settings file

First, let's ask Ubuntu to start directly inside your Ubuntu Home Directory instead of the Windows one:

  • Locate the entry with both "name": "Ubuntu", and "hidden": false,
  • Add the following line after it:
"commandline": "wsl.exe ~",

⚠️ Do not forget the comma at the end of the line!

Then, let's disable warning for copy-pasting commands between Windows and Ubuntu:

  • Locate the line "defaultProfile": "{2c4de342-...}"
  • Add the following line after it:
"multiLinePasteWarning": false,

⚠️ Do not forget the comma at the end of the line!

You can save these changes by pressing Ctrl + S

✔️ Your Windows Terminal is now setup 👍

This terminal has tabs: you can choose to open a new terminal tab by clicking on the + next to the current one.

From now on, every time we will refer to the terminal or the console it will be this one. DO NOT use any other terminal anymore.

VS Code Extensions

Installation

Let's install some useful extensions to VS Code.

code --install-extension ms-vscode.sublime-keybindings
code --install-extension emmanuelbeziat.vscode-great-icons
code --install-extension MS-vsliveshare.vsliveshare
code --install-extension ms-python.python
code --install-extension KevinRose.vsc-python-indent
code --install-extension ms-python.vscode-pylance
code --install-extension ms-toolsai.jupyter

Here is a list of the extensions you are installing:

Live Share configuration

Visual Studio Live Share is a VS Code extension which allows you to share the code in your text editor for debugging and pair-programming: let's set it up!

Launch VS Code from your terminal by typing code and pressing Enter.

Click on the little arrow at the bottom of the left bar 👇

VS Code Live Share

  • Click on the "Share" button, then on "GitHub (Sign in using GitHub account)".
  • A popup appears asking you to sign in with GitHub: click on "Allow".
  • You are redirected to a GitHub page in you browser asking you to authorize Visual Studio Code: click on "Continue" then "Authorize github".
  • VS Code may display additional pop-ups: close them by clicking "OK".

That's it, you're good to go!

Command line tools

Zsh & Git

Instead of using the default bash shell, we will use zsh.

We will also use git, a command line software used for version control.

Let's install them, along with other useful tools:

  • Open an Ubuntu terminal
  • Copy and paste the following commands:
sudo apt update
sudo apt install -y curl git imagemagick jq unzip vim zsh tree

These commands will ask for your password: type it in.

⚠️ When you type your password, nothing will show up on the screen, that's normal. This is a security feature to mask not only your password as a whole but also its length. Just type in your password and when you're done, press Enter.

GitHub CLI installation

Let's now install GitHub official CLI (Command Line Interface). It's a software used to interact with your GitHub account via the command line.

In your terminal, copy-paste the following commands and type in your password if asked:

sudo apt remove -y gitsome # gh command can conflict with gitsome if already installed
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
sudo apt update
sudo apt install -y gh

To check that gh has been successfully installed on your machine, you can run:

gh --version

✔️ If you see gh version X.Y.Z (YYYY-MM-DD), you're good to go 👍

❌ Otherwise, please contact a teacher

Oh-my-zsh

Let's install the zsh plugin Oh My Zsh.

In a terminal execute the following command:

sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"

If asked "Do you want to change your default shell to zsh?", press Y

At the end your terminal should look like this:

Ubuntu terminal with OhMyZsh

✔️ If it does, you can continue 👍

❌ Otherwise, please ask for a teacher

Linking your default browser to Ubuntu

To be sure that you can interact with your browser installed on Windows from your Ubuntu terminal, we need to set it as your default browser there.

⚠️ You need to execute at least one of the following commands below:

Google Chrome as your default browser

Run the command:

  ls /mnt/c/Program\ Files\ \(x86\)/Google/Chrome/Application/chrome.exe

Did you get an error like ls: cannot access...?

Yes, I had an error

Run the following commands:

  echo "export BROWSER=\"/mnt/c/Program Files/Google/Chrome/Application/chrome.exe\"" >> ~/.zshrc
  echo "export GH_BROWSER=\"'/mnt/c/Program Files/Google/Chrome/Application/chrome.exe'\"" >> ~/.zshrc
No, everything was fine

Run the following commands:

  echo "export BROWSER=\"/mnt/c/Program Files (x86)/Google/Chrome/Application/chrome.exe\"" >> ~/.zshrc
  echo "export GH_BROWSER=\"'/mnt/c/Program Files (x86)/Google/Chrome/Application/chrome.exe'\"" >> ~/.zshrc

Mozilla Firefox as your default browser

Run the command:

  ls /mnt/c/Program\ Files\ \(x86\)/Mozilla\ Firefox/firefox.exe

Did you get an error like ls: cannot access...?

Yes, I had an error

Run the following commands:

  echo "export BROWSER=\"/mnt/c/Program Files/Mozilla Firefox/firefox.exe\"" >> ~/.zshrc
  echo "export GH_BROWSER=\"'/mnt/c/Program Files/Mozilla Firefox/firefox.exe'\"" >> ~/.zshrc
No, everything was fine

Run the following commands:

  echo "export BROWSER=\"/mnt/c/Program Files (x86)/Mozilla Firefox/firefox.exe\"" >> ~/.zshrc
  echo "export GH_BROWSER=\"'/mnt/c/Program Files (x86)/Mozilla Firefox/firefox.exe'\"" >> ~/.zshrc

Microsoft Edge as your default browser

Run the commands:

  echo "export BROWSER='\"/mnt/c/Program Files (x86)/Microsoft/Edge/Application/msedge.exe\"'" >> ~/.zshrc
  echo "export GH_BROWSER=\"'/mnt/c/Program Files (x86)/Microsoft/Edge/Application/msedge.exe'\"" >> ~/.zshrc

Restart your terminal.

Then please make sure that the following command returns "Browser defined 👌":

[ -z "$BROWSER" ] && echo "ERROR: please define a BROWSER environment variable ⚠️" || echo "Browser defined 👌"

If it does not,

✔️ If you got this message, you can continue 👍

❌ If not, choose a browser in the list above and execute the corresponding command. Then don't forget to reset your terminal:

exec zsh

Do not hesitate to contact a teacher.

direnv

direnv is a shell extension. It makes it easy to deal with per project environment variables. This will be useful in order to customize the behavior of your code.

sudo apt-get update; sudo apt-get install direnv
echo 'eval "$(direnv hook zsh)"' >> ~/.zshrc

GitHub CLI

CLI is the acronym of Command-line Interface.

In this section, we will use GitHub CLI to interact with GitHub directly from the terminal.

It should already be installed on your computer from the previous commands.

First in order to login, copy-paste the following command in your terminal:

⚠️ DO NOT edit the email

gh auth login -s 'user:email' -w

gh will ask you few questions:

What is your preferred protocol for Git operations? With the arrows, choose SSH and press Enter. SSH is a protocol to log in using SSH keys instead of the well known username/password pair.

Generate a new SSH key to add to your GitHub account? Press Enter to ask gh to generate the SSH keys for you.

If you already have SSH keys, you will see instead Upload your SSH public key to your GitHub account? With the arrows, select your public key file path and press Enter.

Enter a passphrase for your new SSH key (Optional). Type something you want and that you'll remember. It's a password to protect your private key stored on your hard drive. Then press Enter.

Title for your SSH key. You can leave it at the proposed "GitHub CLI", press Enter.

You will then get the following output:

! First copy your one-time code: 0EF9-D015
- Press Enter to open github.com in your browser...

Select and copy the code (0EF9-D015 in the example), then press Enter.

Your browser will open and ask you to authorize GitHub CLI to use your GitHub account. Accept and wait a bit.

Come back to the terminal, press Enter again, and that's it.

To check that you are properly connected, type:

gh auth status

✔️ If you get Logged in to github.com as <YOUR USERNAME> , then all good 👍

❌ If not, contact a teacher.

Google Cloud CLI

Install the gcloud CLI to communicate with Google Cloud Platform through your terminal:

echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list
sudo apt-get install apt-transport-https ca-certificates gnupg
curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key --keyring /usr/share/keyrings/cloud.google.gpg add -
sudo apt-get update && sudo apt-get install google-cloud-sdk
sudo apt-get install google-cloud-sdk-app-engine-python

👉 Install documentation

Dotfiles

There are three options, choose one:

I already attended Web Development (FullStack) bootcamp at Le Wagon on the same laptop

This means that you already forked the GitHub repo lewagon/dotfiles, but at that time the configuration was maybe not ready for the new Data Science bootcamp.

Open your terminal and go to your dotfiles project:

cd ~/code/<YOUR_GITHUB_NICKNAME>/dotfiles
code . # Open it in VS Code

In VS Code, open the zshrc file. Replace its content with the newest version of that file that we provide. Save to disk.

Back to the terminal, run a git diff and ask a TA to come and check about this configuration change. You should see stuff about Python and pyenv.

Once this is good, commit and push your changes:

git add zshrc
git commit -m "Update zshrc for Data Science bootcamp"
git push origin master

OR

I did not attend the Web Dev bootcamp at Le Wagon

Hackers love to refine and polish their shell and tools. We'll start with a great default configuration provided by Le Wagon, stored on GitHub. As your configuration is personal, you need your own repository storing it, so you first need to fork it to your GitHub account.

➡️ Click here to fork the lewagon/dotfiles repository to your account (you'll need to click again on your picture to confirm where you do the fork).

Forking means that it will create a new repo in your GitHub account, identical to the original one. You'll have a new repository on your GitHub account, your_github_username/dotfiles. We need to fork because each of you will need to put specific information (e.g. your name) in those files.

Open your terminal and run the following command:

export GITHUB_USERNAME=`gh api user | jq -r '.login'`
echo $GITHUB_USERNAME

You should see your GitHub username printed. If it's not the case, stop here and ask for help. There seems to be a problem with the previous step (gh auth).

Time to fork the repo and clone it on your laptop:

mkdir -p ~/code/$GITHUB_USERNAME && cd $_
gh repo fork lewagon/dotfiles --clone

Run the dotfiles installer.

cd ~/code/$GITHUB_USERNAME/dotfiles && zsh install.sh

Check the emails registered with your GitHub Account. You'll need to pick one at the next step:

gh api user/emails | jq -r '.[].email'

Run the git installer:

cd ~/code/$GITHUB_USERNAME/dotfiles && zsh git_setup.sh

☝️ This will prompt you for your name (FirstName LastName) and your email. :warning: You need to put one of the emails listed above thanks to the previous gh api ... command. If you don't do that, Kitt won't be able to track your progress. 💡 Select the @users.noreply.github.com address if you don't want your email to appear in public repositories you may contribute to.

Please now quit all your opened terminal windows.

OR

I already attended Web Development (FullStack) bootcamp at Le Wagon but I have a new laptop

Open your terminal and run the following command:

export GITHUB_USERNAME=`gh api user | jq -r '.login'`
echo $GITHUB_USERNAME

You should see your GitHub username printed. If it's not the case, stop here and ask for help. There seems to be a problem with the previous step (gh auth).

Time to fork the repo and clone it on your laptop:

mkdir -p ~/code/$GITHUB_USERNAME && cd $_
gh repo fork lewagon/dotfiles --clone

Run the dotfiles installer.

cd ~/code/$GITHUB_USERNAME/dotfiles && zsh install.sh

Check the emails registered with your GitHub Account. You'll need to pick one at the next step:

gh api user/emails | jq -r '.[].email'

Run the git installer:

cd ~/code/$GITHUB_USERNAME/dotfiles && zsh git_setup.sh

☝️ This will prompt you for your name (FirstName LastName) and your email. :warning: You need to put one of the emails listed above thanks to the previous gh api ... command. If you don't do that, Kitt won't be able to track your progress. 💡 Select the @users.noreply.github.com address if you don't want your email to appear in public repositories you may contribute to.

Please now quit all your opened terminal windows.

Disable SSH passphrase prompt

You don't want to be asked for your passphrase every time you communicate with a distant repository. So, you need to add the plugin ssh-agent to oh my zsh:

First, open the .zshrc file:

code ~/.zshrc

Then:

  • Spot the line starting with plugins=
  • Add ssh-agent at the end of the plugins list

✔️ Save the .zshrc file with Ctrl + S and close your text editor.

Installing Python (with pyenv)

Uninstall conda

As we are using pyenv to install and manage our Python version, we need to uninstall conda, another package manager you may have on your machine if you previously installed Anaconda. Thus, we are preventing any possible Python version issue later.

Check if you have conda installed on your machine:

conda list

If you have zsh: command not found: conda, you can skip the uninstall of conda and jump to the Install pyenv section.

conda uninstall instructions
  • Install the Anaconda-Clean package from your terminal and run the cleaning
conda install anaconda-clean
anaconda-clean --yes
  • Remove every Anaconda directories
rm -rf ~/anaconda2
rm -rf ~/anaconda3
rm -rf ~/.anaconda_backup
  • Remove Anaconda path from your .bash_profile
    • Open the file with code ~/.bash_profile
    • If the file opens find the line matching the following pattern export PATH="/path/to/anaconda3/bin:$PATH" and delete the line
  • Restart your terminal with exec zsh
  • Remove Anaconda initialization from your .zshrc:
    • Open the file with code ~/.zshrc
    • Remove the code lines starting from >>> conda initialize >>> to <<< conda initialize <<<

Install pyenv

Ubuntu comes with an outdated version of Python that we don't want to use. You might already have installed Anaconda or something else to tinker with Python and Data Science packages. All of this does not really matter as we are going to do a professional setup of Python where you'll be able to switch which version you want to use whenever you type python in the terminal.

First let's install pyenv with the following Terminal command:

git clone https://github.com/pyenv/pyenv.git ~/.pyenv
exec zsh

Let's install some dependencies needed to build Python from pyenv:

sudo apt-get update; sudo apt-get install make build-essential libssl-dev zlib1g-dev \
libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm \
libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev \
python3-dev

Install Python

Let's install the latest stable version of Python supported by Le Wagon's curriculum:

pyenv install 3.10.6

This command might take a while, this is perfectly normal. Don't hesitate to help other students seated next to you!

🛠 Troubleshooting `pyenv` not found

If you encounter an error Command 'pyenv' not found: execute the following line:

source ~/.zprofile

Then try to install Python again:

pyenv install 3.10.6

If pyenv is still not found, contact a teacher.


OK once this command is complete, we are going to tell the system to use this version of Python by default. This is done with:

pyenv global 3.10.6
exec zsh

To check if this worked, run python --version. If you see 3.10.6, perfect! If not, ask a TA that will help you debug the problem thanks to pyenv versions and type -a python (python should be using the .pyenv/shims version first).

Python Virtual Environment

Before we start installing relevant Python packages, we will isolate the setup for the Bootcamp into a dedicated virtual environment. We will use a pyenv plugin called pyenv-virtualenv.

First let's install this plugin:

git clone https://github.com/pyenv/pyenv-virtualenv.git $(pyenv root)/plugins/pyenv-virtualenv
exec zsh

Let's create the virtual environment we are going to use during the whole bootcamp:

pyenv virtualenv 3.10.6 lewagon

Let's now set the virtual environment with:

pyenv global lewagon

Great! Anytime we'll install Python package, we'll do it in that environment.

Python packages

Now that we have a pristine lewagon virtual environment, it's time to install some packages in it.

First, let's upgrade pip, the tool to install Python Packages from pypi.org. In the latest terminal where the virtualenv lewagon is activated, run:

pip install --upgrade pip

Then let's install some packages for the first weeks of the program:

pip install -r https://raw.githubusercontent.com/lewagon/data-setup/master/specs/releases/linux.txt

Configuring Jupyter Notebook to open in your browser

Let's generate the configuration file for Jupyter Notebook...

jupyter notebook --generate-config

⚠️ Please copy the path returned by the previous command.

We will now edit the generated Jupyter configuration file:

code $HOME/.jupyter/jupyter_notebook_config.py

Locate the following line in the configuration file:

# c.NotebookApp.use_redirect_file = True

And replace it with this one precisely 👇 (including removing the # symbol)

c.NotebookApp.use_redirect_file = False

Let's try to run Jupyter:

jupyter notebook

This command should have opened a Jupyter page in your browser:

If it is not the case, please call a TA.

To stop the Jupyter server in the terminal, press Ctrl + C, enter y, then press Enter.

jupyter notebook extensions

Pimp your jupyter notebooks with awesome extensions:

# install nbextensions
jupyter contrib nbextension install --user
jupyter nbextension enable toc2/main
jupyter nbextension enable collapsible_headings/main
jupyter nbextension enable spellchecker/main
jupyter nbextension enable code_prettify/code_prettify

Custom CSS

Improve the display of the details disclosure elements in your notebooks.

Open custom/custom.css in the config directory:

cd $(jupyter --config-dir)
mkdir -p custom
touch custom/custom.css
code custom/custom.css

Edit custom.css with:

summary {
    cursor: pointer;
    display:list-item;
}
summary::marker {
    font-size: 1em;
}

You can close VS Code.

jupyter check up

Let's reset your terminal:

exec zsh

Now, check you can launch a notebook server on your machine:

jupyter notebook

Your web browser should open on a jupyter window:

jupyter.png

Click on New:

jupyter_new.png

A tab should open on a new notebook:

jupyter_notebook.png

nbextensions check up

Perform a sanity check for jupyter notebooks nbextensions. Click on Nbextensions:

jupyter_nbextensions.png

Untick "disable configuration for nbextensions without explicit compatibility" then check that at least all nbextensions circled in red are enabled:

nbextensions.png

You can close your web browser then terminate the jupyter server with CTRL + C.

Python setup check up

Check your Python version with the following commands:

zsh -c "$(curl -fsSL https://raw.githubusercontent.com/lewagon/data-setup/master/checks/python_checker.sh)" 3.10.6

Run the following command to check if you successfully installed the required packages:

zsh -c "$(curl -fsSL https://raw.githubusercontent.com/lewagon/data-setup/master/checks/pip_check.sh)"

Now run the following command to check if you can load these packages:

python -c "$(curl -fsSL https://raw.githubusercontent.com/lewagon/data-setup/master/checks/pip_check.py)"

Make sure you can run Jupyter:

jupyter notebook

And open a Python 3 notebook.

Make sure that you are running the correct python version in the notebook. Open a cell and run :

import sys; sys.version

Here you have it! A complete python virtual env with all the third-party packages you'll need for the whole bootcamp.

DBeaver

Download and install DBeaver, a free and open source powerful tool to connect to any database, explore the schema and even run SQL queries.

Windows settings

Exchange files between Windows and Ubuntu

We need an easy way to transfer files from Windows to Ubuntu and vice versa.

In order to do that, let's create shortcuts to Ubuntu directories in the Windows File Explorer:

  • Open the Windows File Explorer (or use the shortcut WIN + E)
  • In the Address Bar, enter \\wsl$\ (or \\wsl$\Ubuntu if it does not work)
  • You now have acces to the Ubuntu file system
  • Dive into the Ubuntu file system in order to look for directories of interest
  • Drag the desired folders into the Address Bar in order to create shortcuts

How to add a shortcut to Ubuntu file system on Windows

Open the Windows File Explorer from the Ubuntu terminal

Another option to move files around is to open the Windows File Explorer from the Ubuntu terminal:

  • Open an Ubuntu terminal
  • Go to the directory you wish to explore
  • Run the explorer.exe . command (alternatively, use wslview .)
  • If you get an input output error message, run wsl --shutdown in a Windows PowerShell and reopen an Ubuntu terminal

How to launch Windows Explorer from Ubuntu terminal

Find your way in the Ubuntu File System

You might want to figure out the exact location of a Windows directory in the Ubuntu file system, or the other way around.

In order to convert a Windows path to and from an Ubuntu path:

  • Open an Ubuntu terminal
  • Use the wslpath "C:\Program Files" command in order to translate a Windows path into an Ubuntu path
  • Use the wslpath -w "/home" command in order to translate an Ubuntu path into a Windows path
  • In particular, the wslpath -w $(pwd) command returns the Windows path of the current Ubuntu directory

How to access a Windows path from Ubuntu terminal

Pin apps to your taskbar

You are going to use most of the apps you've installed today really often. Let's pin them to your taskbar so that they are just one click away!

To pin an app to your taskbar, launch the app, right-click on the icon in the taskbar to bring up the context menu and choose "Pin to taskbar".

How to pin an app to the taskbar in Windows

You must pin:

  • Your terminal
  • Your file explorer
  • VS Code
  • Your Internet browser
  • Slack
  • Zoom

Visual C++ Redistributable

Some Python packages require a compiler to function properly. Let's install one:

For x64 systems

For x86 systems

If you're unsure about which system you're using please ask a teacher.

Docker 🐋

Docker is an open platform for developing, shipping, and running applications.

if you already have Docker installed on your machine please update with the latest version

Install Docker

Go to Docker for WSL2.

Download and install the Docker Desktop WSL 2 backend.

Once done, start Docker.

You should be able to run in a Ubuntu terminal:

docker run hello-world

The following message should print:

Permission denied?

Run the following commands one by one:

sudo groupadd docker
sudo usermod -aG docker $USER
newgrp docker

Try docker run hello-world again.

Seeing this error?

WARNING: Error loading config file: /home/user/.docker/config.json - stat /home/user/.docker/config.json: permission denied`?

Run the following command:

sudo rm -rf ~/.docker/

Try docker run hello-world again.

Google Cloud Platform setup

GCP is a cloud solution that you are going to use in order to deploy your Machine Learning-based products to production.

🚨 If you are a student of the Part-Time Bootcamp, SKIP THIS SECTION FOR NOW! GCP offers $300 worth of free credits for a duration of 3 months. You do not want to activate your GCP account too soon 🙅‍♂️

Project setup

  • Go to Google Cloud and create an account if you do not already have one
  • In the Cloud Console, on the project list, select or create a Cloud project

  • Give it a name such as Wagon Bootcamp for example
  • Notice the ID automatically created for the project, e.g. wagon-bootcamp-123456

Account language

In order to facilitate the following of the instructions during the bootcamp, open your GCP account preferences:

https://myaccount.google.com/language

If the preferred language is not:

  • English
  • United States

Then switch the language to english:

  • Click on the edit pen logo
  • Select English
  • Select United States
  • Click on Select

Billing account

You will now link your account to your credit card. This step is required or you will not be able to use the services provided by GCP. Do not worry, you will be able to consume most GCP services through free credits throughout the bootcamp.

  • Click on Billing
  • Click on MANAGE BILLING ACCOUNTS
  • Click on ADD BILLING ACCOUNT
  • Give a name to your billing account, e.g. My Billing Account
  • Click on "I have read..." and agree the to the terms of service
  • Click on CONTINUE
  • Select your account type: Individual
  • Fill your name and address

You should see that you have a free credit of "$300 credits over the next 90days".

  • Click on card details
  • Enter your credit card info
  • Click on START MY FREE TRIAL

Once this is done, verify that your billing account is linked to your GCP project.

  • Select your project
  • Go to Billing
  • Select LINK A BILLING ACCOUNT
  • Select My Billing Account
  • Click on SET ACCOUNT

You should now see:

Free trial status: $300 credit and 91 days remaining - with a full account, you'll get unlimited access to all of Google Cloud Platform.
👉 If you do not own a credit card 👈

If you do not own a credit card, an alternative is to setup a Revolut account. Revolut is a financial app that will allow you to create a virtual credit card linked to your mobile phone billing account.

Skip this step if you own a credit card and use your credit card for the setup.

Download the Revolut app, or go to revolut and follow the steps to download the app (enter your mobile phone number and click on Get Started).

  • Open the Revolut app
  • Enter your mobile phone number
  • Enter the verification code received by SMS
  • The app will ask for your country, address, first and last name, date of birth, email address
  • The app will also ask for a selfie and request your profession
  • The app will require a photo of your identification card or passport

Once this is done, select the standard (free) plan. No need to add the card to Apple pay, or ask for a the delivery of a physical card, or add money securely.

You now have a virtual card which we will use for the GCP setup.

In the main view of the Revolut the app

  • Click on Ready to use
  • Click on the card
  • Click on Show card details
  • Note down the references of the virtual credit card and use them in order to proceed with the GCP setup
👉 If you receive an email from Google saying "Urgent: your billing account XXXXXX-XXXXXX-XXXXXX has been suspended" 👈

This may happen especially in case you just setup a Revolut account.

  • Click on PROCEED TO VERIFICATION
  • You will be asked to send a picture of your credit card (only the last 4 digits, no other info)
  • In case you used Revolut, you can send a screenshot of your virtual credit card (do not forget to remove the validity date from the screenshot)
  • Explain that you are attending the Le Wagon bootcamp, do not own a credit card, and have just created a Revolut account in order to setup GCP for the bootcamp using a virtual credit card

You may receive a validation or requests for more information within 30 minutes.

Once the verification goes through, you should receive an email stating that "Your Google Cloud Platform billing account XXXXXX-XXXXXX-XXXXXX has been fully reinstated and is ready to use.".

Enabling GCP services

  • Make sure that billing is enabled for your Google Cloud project

ℹ️ You have a $300 credit to use for Google Cloud resources, which will be more than enough for the bootcamp.

Configure Cloud sdk

  • Authenticate the gcloud CLI with the google account you used for GCP
gcloud auth login --no-launch-browser
  • Login to your Google account on the new tab opened in your web browser
  • List your active account and check your email address you used for GCP is present
gcloud auth list
  • Set your current project (replace PROJECT_ID with the ID of your project, e.g. wagon-bootcamp-123456)
gcloud config set project PROJECT_ID
  • List your active account and current project and check your project is present
gcloud config list

Create a service account key 🔑

Now that you have created a GCP account and a project (identified by its PROJECT_ID), we are going to configure the actions (API calls) that you want to allow your code to perform.

🤔 Why do we need a service account key ?

You have created a GCP account linked to your credit card. Your account will be billed according to your usage of the resources of the Google Cloud Platform. The billing will occur if you consume anything once the free trial is over, or if you exceed the amount of spending allowed during the free trial.

In your GCP account, you have created a single GCP project, identified by its PROJECT_ID. The GCP projects allow you to organize and monitor more precisely how you consume the GCP resources. For the purpose of the bootcamp, we are only going to create a single project.

Now, we need a way to tell which resources within a GCP project our code will be allowed to consume. Our code consumes GCP resources through API calls.

Since API calls are not free, it is important to define with caution how our code will be allowed to use them. During the bootcamp this will not be an issue and we are going to allow our code to use all the API of GCP without any restrictions.

In the same way that there may be several projects associated with a GCP account, a project may be composed of several services (any bundle of code, whatever its form factor, that requires the usage of GCP API calls in order to fulfill its purpose).

GCP requires that the services of the projects using API calls are registered on the platform and their credentials configured through the access granted to a service account.

For the moment we will only need to use a single service and will create the corresponding service account.

Since the service account is what identifies your application (and therefore your GCP billing account and ultimately your credit card), you are going to want to be cautious with the next steps.

⚠️ Do not share you service account json file 🔑 ⚠️ Do not store it on your desktop, do not store it in your git codebase (even if your git repository is private), do not let it by the coffee machine, do not send it as a tweet.

Go to the Service Accounts page

Navigate to the GCP service accounts page at this link.

  • Select your project in the list of recent projects if asked to.
  • If not asked, make sure the right project is selected in the Project selecter list at the top of the page.

An alternate way to navigate to the Service Accounts page is from the following:

01 Go to Service Accounts

Create a service account

  • Click on CREATE SERVICE ACCOUNT.

    02 Create Service Account
  • Give your service account a name, an id and a description, and click on CREATE AND CONTINUE.

    03 Name the service account
  • Click on Select a role and choose Basic then Owner, which gives the service account full access to all resources of your GCP project.

    04 Add BigQuery Job User
  • Click on the blue DONE button at the bottom of this window. We don't need to worry about the section Grant your users access to this service account.

    04 Done

Create a json key 🔑 for this service account

  • On the service accounts page, click on the email address of the newly created service account.

    05 Select the service account
  • Click on the KEYS tab at the top of the page.

    06 Go to Keys
  • Click on ADD KEY then Create new key.

    07 Add Key
  • Select JSON and click on CREATE.

    08 Choose JSON and Create
  • The browser has now saved the service account json file 🔑 in your downloads directory (it is named according to your service account name, something like le-wagon-data-123456789abc.json).

We will now move the service account json file from your Windows disk to the Ubuntu disk. This will allow the development tools in Ubuntu to access to the resources of your GCP account.

First, let's create a directory in which we will store the file.

👉 Open an Ubuntu terminal and run the following commands

🚨 replace GITHUB_NICKNAME by your GitHub nickname

cd ~/code/GITHUB_NICKNAME
ls -la

If the command does not show the dotfiles directory, ask for a TA 🙏

Otherwise, you can proceed with the setup:

mkdir gcp

We will now move the service account json file to the gcp directory we just created.

Open a Windows File Explorer (Win + E) and locate the gcp directory in the Ubuntu file system.

You can either:

  • Use the Quick access link that we created earlier
  • manually type the location of the gcp directory in the Ubuntu file system in the address bar:
\\wsl$\Ubuntu\home\UBUNTU_USERNAME\code\GITHUB_NICKNAME

🚨 if you opt for the second option:

  • replace UBUNTU_USERNAME by the username that you choose during the Ubuntu setup
  • replace GITHUB_NICKNAME by your GitHub nickname

Once you have located the gcp directory in the Windows File Explorer, move the service account json file that you downloaded inside of it.

The file should now be visible from Ubuntu file system.

👉 Open an Ubuntu terminal and verify that the service account json file has been moved

cd gcp
ls -la

If you do not see the service account json file listed in the gcp directory, ask for a TA 🙏

We will now store the path to your service account json file in an environment variable.

🚨 in the following command, replace:

  • UBUNTU_USERNAME by the username that you choose during the Ubuntu setup
  • GITHUB_NICKNAME by your GitHub nickname
  • SERVICE_ACCOUNT_JSON_FILE_CONTAINING_YOUR_SECRET_KEY.json by the name of your service account json file
echo 'export GOOGLE_APPLICATION_CREDENTIALS=/home/UBUNTU_USERNAME/code/GITHUB_NICKNAME/gcp/SERVICE_ACCOUNT_JSON_FILE_CONTAINING_YOUR_SECRET_KEY.json' >> ~/.zshrc

Note: every time you run this command, it will add this line to your zshrc file regardless of whether you already have it. If you made a mistake and need to fix it, preferably open the file and edit the line!

You can do so by running

code ~/.zshrc

in the Terminal! 😄

ℹ️ How to find the absolute path of a file? You can drag and drop the file in your terminal.

Restart your terminal and run:

echo $GOOGLE_APPLICATION_CREDENTIALS

The ouptut should be the following:

/some/absolute/path/to/your/gcp/SERVICE_ACCOUNT_JSON_FILE_CONTAINING_YOUR_SECRET_KEY.json

Now let's verify that the path to your service account json file is correct:

cat $(echo $GOOGLE_APPLICATION_CREDENTIALS)

👉 This command should display the content of your service account json file. If it does not, ask for a TA 🙏

Your code and utilities are now able to access the resources of your GCP account.

Let's proceed with the final steps of configuration...

  • List the service accounts associated to your active account and current project
gcloud iam service-accounts list
  • Retrieve the service account email address, e.g. SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
  • List the roles of the service account from the cli (replace PROJECT_ID and SERVICE_ACCOUNT_EMAIL)
gcloud projects get-iam-policy PROJECT_ID \
--flatten="bindings[].members" \
--format='table(bindings.role)' \
--filter="bindings.members:SERVICE_ACCOUNT_EMAIL"
  • You should see that your service account has a role of roles/owner
Troubleshooting

🏁 You are done with the GCP setup!

Kitt

⚠️ If you have received an email from Le Wagon inviting you to sign up on Kitt (our learning platform), you can safely skip this step. Instead, please follow the instructions in the email you received if you haven't done so already.

If you are unsure about what to do, you can follow this link. If you are already logged in, you can safely skip this section. If you are not logged in, click on Enter Kitt as a Student. If you manage to login, you can safely skip this step. Otherwise ask a teacher whether you should have received an email or follow the instructions below.

Register as a Wagon alumni by going to kitt.lewagon.com/onboarding. Select your batch, sign in with GitHub and enter all your information.

Your teacher will then validate that you are indeed part of the batch. You can ask them to do it as soon as you completed the registration form.

Once the teacher has approved your profile, go to your email inbox. You should have 2 emails:

  • One from Slack, inviting you to the Le Wagon Alumni slack community (where you'll chat with your buddies and all the previous alumni). Click on Join and fill the information.
  • One from GitHub, inviting you to lewagon team. Accept it otherwise you won't be able to access the lecture slides.

Slack

Slack is a communication platform pretty popular in the tech industry.

Installation

Download the Slack app and install it.

⚠️ If you are already using Slack in your browser, please download and install the desktop app which is fully featured.

Settings

Launch the app and sign in to lewagon-alumni organization.

Make sure you upload a profile picture 👇

How to upload a profile picture on Slack

The idea is that you'll have Slack open all day, so that you can share useful links / ask for help / decide where to go to lunch / etc.

To ensure that everything is working fine for video calls, let's test your camera and microphone:

  • Open the Slack app
  • Click your profile picture in the top right.
  • Select Preferences from the menu.
  • Click Audio & video in the left-side column.
  • Below Troubleshooting, click Run an audio, video and screensharing test. The test will open in a new window.
  • Check that your preferred speaker, microphone and camera devices appear in the drop-down menus, then click Start test.

Check microphone and webcam with Slack

✔️ When the test is finished, you should see green "Succeed" messages at least for your microphone and camera. 👍

❌ If not, contact a teacher.

You can also install Slack app on your phone and sign in lewagon-alumni!

(Bonus) Kata

If you are done with your setup, please ask around if some classmates need some help with theirs (macOS, Linux, Windows). We will have our first lectures at 2pm and will talk about the Setup you just did + onboard you on Kitt.

If you don't have a lot of experience with git and GitHub, please (re-)watch this workshop (1.25 playback speed is fine).

If you do, then you can wait for the first lecture working on this Tic-Tac-Toe Kata