Setting Up Python Development Environment for Use in a Small Classroom

摘要

In this paper we describe a way to set up a classroom environment using the common tools used in software development with the focus on Python. We cover version control system Git, testing framework pytest, source formatter black, and linter flake8. Proper use of these tools helps students preserve history of code changes, provides feedback before a student submits their assignment, and eliminates subjective style preferences from the code review process. The proposed setup works on Linux, macOS, and Windows without major modifications. We recommend publishing a standard requirements.txt for students to install the required packages and using Python's built-in module venv to isolate a class from the rest of the system. This approach helps eliminate (or at least greatly reduce) the common "works on my machine" problem by locking both Python version and installed packages.