Rustlings is a program with interactive exercises for Rust that teaches by example. Each exercise contains code that has some sort of error, either with syntax or a test that doesn't work, and it is up to the user to fix the error before moving on to the next exercise. This is an attempt to make a similar program for Python, but runs inside a Docker container instead of the bare host machine.
Python often requires installations that can vary from system to system, so by using a Docker container to execute code, we can have the user just focus on fixing the code rather than having the user attempt to diagnose what could be wrong with their environment.
Within a docker container, the program loops and watches the exercises/ folder
for changes. When you make the necessary changes for the exercise to pass, you'll
see that the exercise has passed. At this point, remove the I AM NOT DONE comment
from the exercise, and the program will move on to the next exercise.
First, run make docker to make the docker image. Then run make egglings to run the image with the exercises folder mounted inside the container.
In the exercises/ folder, there is a series of python scripts that the container
will attempt to run, and when it fails on one it will stop and show you the traceback
of what happened. Modify the file to make the script run.
Every time you save modify a file in the exercises, the container will detect it and attempt to run the latest failing test.
Install Docker and make sure the daemon is running, by running docker --version
Then, run make docker to make the docker image, and make egglings to run the exercises.
To run this on your machine, create a virtual environment for python, using python3. I suggest using Virtualenvwrapper, but use whatever is best for you.
Then install the dependencies in the requirements file with pip:
pip install -r requirements.txt
Then run the main.py program with python:
python3 main.py
Using Docker is just a bit more convenient, since you don't have to make a virtual environment to get this running and users new to Python may not have virtual environment wrappers set up on their machine. Docker is a relatively straightforward install.