Installation

This page should give you basic information on how to install this library.

Python Version

It’s recommended to use the latest version of Python. The minimal supported version is 3.8.

Dependencies

This library is dependant of the following packages:

• Flask is a simple HTTP framework.

• Flask-Cors to support cross-origin requests.

• matplotlib to render simple figures, graphs and plots.

Virtual Environments

It’s recommended to create and use a virtual environment when programming an exercise with this library. You can create a virtual environment with the following command:

python -m venv venv

The advantage of a virtual environment is, you don’t need to install your site packages in the global scope. Therefore, you can omit unwanted site effects with other applications and Python projects on your system. In order to use an existing virtual environment, you need to activate it first:

source venv/bin/activate

Requirements

This library has the following requirements:

• Python, greater or equal version 3.8.

• A plain text editor (PyCharm or Visual Studio Code is recommended)

• Bash compatible terminal (e.g. Git Bash or Cygwin on Windows)

• The use of Git as a version control system is highly recommended.

• Access to the Python Tool Manager.

Install with Pip

To install the library with Pip, activate the virtual environment and execute the following command:

pip install pytmlib

Using a requirements.txt File

Create or edit the requirements.txt file and add the following line:

pytmlib>=1.0

To install the requirements, open a new console window, activate the virtual environment and execute the following command:

pip install -r requirements.txt