Skip to content

Latest commit

 

History

History
416 lines (261 loc) · 12.1 KB

GETTING_STARTED.md

File metadata and controls

416 lines (261 loc) · 12.1 KB
Raw

Getting Started with Number to LCD kata in Python

Prerequisites

  • macOS, Linux or Windows

  • git client

  • curl command line utility

  • python

    python version

    The kata is configured to run with python version 3.6 or above.

    To use a different version, simply update the value for python_requires in setup.py.

Getting ready

1 - Clone the kata repository

git clone https://github.com/murex/Kata-NumberToLcd.git

2 - Go to the kata's python directory

cd Kata-NumberToLcd/python

3 python virtual environment

Although not mandatory, we recommend running the kata in a virtual environment in order to prevent interferences with other python projects that you may have on your machine.

To create and start the python virtual environment for the kata:

./start_python_venv.sh

Note: This command starts the python virtual environment in a sub-shell. You can end it at any time by typing exit.

Running the kata

You can run the kata from the command line or from your IDE of choice.

You may also run it using TCR if you want to add a bit of spice.

Running the kata from a terminal

Reminder: the commands below should be run from Kata-NumberToLcd/python directory

To create and start the python virtual environment:

./start_python_venv.sh

To run the tests:

pytest

Running the kata from a terminal with TCR

Note to Windows users

Use a git bash terminal for running the command below. Windows CMD and PowerShell are not supported

Reminder: the commands below should be run from Kata-NumberToLcd/python directory

To create and start the python virtual environment:

./start_python_venv.sh

Type the following to start TCR:

./tcrw

Refer to Using TCR section for additional details about TCR and available options.

Running the kata from PyCharm

Open PyCharm and select:

File > Open > Kata-NumberToLcd > python

Run all the tests in the project.

The "Run" tool window should display all the executed tests.

Running the kata from PyCharm with TCR

TCR is provided as a command line utility running in a terminal. You can run it from PyCharm directly, through leveraging on its built-in terminal.

1. Open the kata

Open PyCharm and select:

File > Open > Kata-NumberToLcd > python

2. Turn off auto-save

TCR is constantly watching the filesystem for changes. For this reason you need to turn off PyCharm's auto-save in order for it to behave as expected.

File > Settings > Appearance & Behavior > System Settings

Under Autosave section, uncheck the 2 following options:

  • Save files if the IDE is idle for ___ seconds
  • Save files when switching to a different application or a built-in terminal

3. Configure the built-in terminal to run git bash

Windows Only

Skip this step if you're on macOS or Linux

PyCharm for Windows is usually set up to run PowerShell by default in its built-in terminal. TCR does not run in PowerShell.

File > Settings > Tools > Terminal

Under Application Settings section, set the Shell path to C:\Program Files\Git\bin\bash.exe

The above path is for a default git installation location. You may need to adjust it in case you have installed git at a different location.

4. Open a built-in terminal

View > Tool Windows > Terminal

5. Start python virtual environment

Reminder: the command below should be run from Kata-NumberToLcd/python directory

From the built-in terminal:

./start_python_venv.sh

6. Launch TCR

Reminder: the command below should be run from Kata-NumberToLcd/python directory

From the built-in terminal:

./tcrw

Refer to Using TCR section for additional details about TCR and available options.

Running the kata from IntelliJ

Important: This requires to have IntelliJ IDEA Ultimate edition.

IntelliJ's Python plugin is not available with the Community edition. You can still use it as an editor for python files, but you will not be able to use the benefits brought by the Python plugin, such as syntax highlighting, code refactoring or integration with IntelliJ's test navigator.

1. Install Python plugin

  • Open IntelliJ and select:File > Settings > Plugins > Marketplace
  • Search for python and click Install
  • Restart IntelliJ to activate the plugin

2. Launch IntelliJ and open the project

File > Open > Kata-NumberToLcd > python

3. Configure the project's python SDK

File > Project Structure > Project > SDK > Python 3.xx > OK

Note If no Python SDK is proposed, select Add SDK > Python SDK... from the SDK dropdown link to tell IntelliJ where it can find python on your machine.

4. Configure the project source root directory

From the Project navigator window, right click on src directory and select Mark directory as > Sources Root.

5. Run the tests

From the Project navigator window, right click on tests directory and select Run python tests in test....

The "Run" tool window should display all the executed tests.

Running the kata from IntelliJ with TCR

Important: This requires to have IntelliJ IDEA Ultimate edition.

Refer to the section Running the kata from IntelliJ for instructions related to installation of IntelliJ's Python plugin.

TCR is provided as a command line utility running in a terminal. You can run it from IntelliJ directly, through leveraging on its built-in terminal.

1. Open the kata

Open IntelliJ and select:

File > Open > Kata-NumberToLcd > python

2. Turn off auto-save

TCR is constantly watching the filesystem for changes. For this reason you need to turn off IntelliJ's auto-save in order for it to behave as expected.

File > Settings > Appearance & Behavior > System Settings

Under Autosave section, uncheck the 2 following options:

  • Save files if the IDE is idle for ___ seconds
  • Save files when switching to a different application or a built-in terminal

3. Configure the built-in terminal to run git bash

Windows Only

Skip this step if you're on macOS or Linux

IntelliJ for Windows is usually set up to run PowerShell by default in its built-in terminal. TCR does not run in PowerShell.

File > Settings > Tools > Terminal

Under Application Settings section, set the Shell path to C:\Program Files\Git\bin\bash.exe

The above path is for a default git installation location. You may need to adjust it in case you have installed git at a different location.

4. Open a built-in terminal

View > Tool Windows > Terminal

5. Start python virtual environment

Reminder: the command below should be run from Kata-NumberToLcd/python directory

From the built-in terminal:

./start_python_venv.sh

6. Launch TCR

Reminder: the command below should be run from Kata-NumberToLcd/python directory

From the built-in terminal:

./tcrw

Refer to Using TCR section for additional details about TCR and available options.

Running the kata from Visual Studio Code

1. Prerequisite: install Python extension for Visual Studio Code

  • Menu View > Extensions
  • Search for python
  • Select Python and click Install

2. Open the kata

Choose Open Folder, navigate to Kata-NumberToLcd / python then click Select Folder.

3. Start python virtual environment

From the terminal (running bash), start python virtual environment:

./start_python_venv.sh

4. Select python interpreter

Click on Select Interpreter in the bottom bar, and choose the interpreter located under ./venv (should be the one tagged as Recommended)

5. Run the tests

From the Test Explorer window (menu View > Testing):

  • Configure Python Tests > pytest > tests
  • Click on the Play button to run the tests.

Running the kata from Visual Studio Code with TCR

TCR is provided as a command line utility running in a terminal. You can run it from Visual Studio Code directly, through leveraging on its built-in terminal.

1. Prerequisite: install Python extension for Visual Studio Code

  • Menu View > Extensions
  • Search for python
  • Select Python and click Install

2. Open the kata

Open Visual Studio Code, choose Open Folder, navigate to Kata-NumberToLcd / python then click Select Folder.

3. Turn off auto-save

TCR is constantly watching the filesystem for changes. For this reason you need to make sure that Visual Studio Code's auto-save is turned off in order for TCR to behave as expected.

File > Preferences > Settings

In Text Editor > Files section, make sure that Auto Save setting is set to off

4. Configure the built-in terminal to run git bash

Windows Only

Skip this step if you're on macOS or Linux

Visual Studio Code for Windows is usually set up to run PowerShell by default in its built-in terminal. TCR does not run in PowerShell.

File > Preferences > Settings

In Features > Terminal section, set External: Windows Exec to C:\Program Files\Git\bin\bash.exe

The above path is for a default git installation location. You may need to adjust it in case you have installed git at a different location.

5. Open a built-in terminal

Terminal > New Terminal

6. Start python virtual environment

Reminder: the command below should be run from Kata-NumberToLcd/python directory

From the built-in terminal:

./start_python_venv.sh

6. Launch TCR

Reminder: the command below should be run from Kata-NumberToLcd/python directory

From the built-in terminal:

./tcrw

Refer to Using TCR section for additional details about TCR and available options.

Using TCR

Cheat Sheet

Here are the main shortcuts available once TCR utility is running:

Shortcut Description
o / O Open in browser (with web subcommand only)
d / D Enter driver role
n / N Enter navigator role
t / T Query timer status
p / P Toggle on/off git auto-push
l / L Pull from remote
s / S Push to remote
a / A Abort current command (when in driver role)
q / Q Quit current role / Quit TCR
? List available options

Additional Details

Refer to TCR - Test && Commit || Revert page for additional details and explanations about TCR utility.