FAQ

How do I run EduLint?

If you do not want to install anything, you can try EduLint here. Otherwise, see install instructions here.

What does EduLint do?

EduLint is an educational linter for Python code. It provides feedback on code quality, style, and common mistakes to help students improve their programming skills. EduLint can be customized with different configurations to suit various educational needs. For the complete list of defects it detects, see here.

How can I use EduLint?

You can run it locally through the command line or using the package API, or you can host a web API server. For more information, read the user guides.

What configuration should I use?

If you are unsure, start with the default configuration. If you want more control, you can pick one of the packaged configurations or create your own. For more information on choosing and distributing configurations, see here.

There is no easy answer. Try running some configuration on some sample codes and see what you like best.

How do I stop students from disabling reports via Pylint’s disable, Flake8’s noqa comments or EduLint’s own configuration comments?

Set the ignore-infile-config-for option to all when running EduLint. The disabled defects will stay disabled (Pylint has no option to force ignore disable comments), but EduLint will emit an additional defect which you can check for.