⚠️ This repo has outdated tokens in its travisci config To make new releases for this project it needs to be moved to circleci

shellwhat

shellwhat enables you to write Submission Correctness Tests (SCTs) for interactive Shell exercises on DataCamp.

If you are new to teaching on DataCamp, check out https://instructor-support.datacamp.com.
If you want to learn what SCTs are and how they work, visit this article specifically.
For a complete overview of all functionality inside shellwhat and articles about what to use when, consult https://shellwhat.readthedocs.io.

Installing

pip install shellwhat

Install everything needed for developing:

pip install -r requirements.txt
pip install -e .

By default, the DummyParser is used, that does not parse the shell code. Hence, you can not run tests that need this parser:

pytest -m "not osh"

If you also want to run these 'parser tests', there is a Dockerfile to parse shell commands with the Oil parser:

# Look in Makefile for details
SHELLWHAT_PARSER='docker' make test