Development Environment - C0D3D3V/Moodle-DL GitHub Wiki

Here you will learn how to set up your development environment so that you are best equipped to participate in the project and search for bugs yourself.

The complete development of the project takes place in Visual Studio code. I decided to do this because it is one of the most comprehensive open source editors. Furthermore, Visual Studio Code has one of the largest communities. So you will find online support for every problem.

  1. Install Git and clone the master branch

  2. Then we download and install Visual Studio Code.

  3. Open Visual Studio Code (vs-code), now we want to install some extensions that will help us to develop. Press Ctrl+Shift+X inside vs-code, then search and install the following extensions:

  • Python
  • Visual Studio IntelliCode

It will take a short while but then we are almost ready to start.

  1. Now open a terminal by pressing Ctrl+`. Alternatively, you can also open a terminal outside of vs-code (e.g. a powershell). Then execute the following commands:
     pip install --user black
     pip install --user flake8
     pip install --user flake8-black

You have done it now you can officially work on the project.

How do I debug the code.

  1. First you have to open the project folder, Click on File > Open folder, select the Moodle Downloader 2 project folder.

  2. In the Moodle Downloader 2 project folder create a new folder called debugging-moodle. In this folder you will need to copy your config.json and possibly your moodle_state.db if you want to work with the database you have already created to avoid re-downloading all files.

  3. Then start debugging by pressing [F5], you can then report me any errors.