Thanks to visit codestin.com
Credit goes to github.com

Skip to content

GiraffeReversed/edulint

Repository files navigation

EduLint

Pypi Python versions Tests ReadTheDocs Docker image

EduLint is a Python linter aimed at helping novice programmers improve their coding style. Presently, it integrates flake8 and pylint, with some tweaks to their default configuration.

This repository contains the linter itself, which is packaged and published as a Pypi package edulint. There is also a web version running at edulint.com for easy use. Its source code is in another repository.

Demo GIF

Usage

Web version

Are you just starting with programming in Python? Then the web UI (website, repo) might be the best choice for you.

Python package

For ease of use there are multiple ways how to install and run EduLint locally. You can find more examples, options and configurations details in the documentation.

Using pipx

pipx install edulint        # Installation
edulint check some_file.py  # Usage example

Using pip

python3 -m pip install --user edulint  # Installation
python3 -m edulint check some_file.py  # Usage example

Docker container

docker run -v ${PWD}:/app edulint/edulint-cli check some_file.py

Road map (long-term)

  • Additional explanations for problems detected in code
  • Thonny plugin
  • More code quality defects (from WPS; detecting duplicate code)
  • Rewrite web to React
  • Add additional functionality to web (more settings, better teacher onboarding, …)
  • Speed-up linting by switching to Ruff
  • official VS Code plugin (3rd party plugin already exists: Github, VS Code Marketplace)

Sponsorship and academic collaboration

Are you interested in sponsoring this project, want to collaborate on an academic paper, or know of any interesting grants? Feel free to reach out to [email protected].

Compatibility with other software

Python version

Supported: Python 3.8+ (tested up-to Python 3.14)

Python 3.7 is no-longer officially supported, as Python 3.7 is already EOL. Last version that supported it was Edulint v3.6.1. Be aware that some linting results may be different between 3.7 and 3.8 due to different parsing between package typed-ast (<=3.7) and Python's native ast (>=3.8).

About

EduLint is a Python linter aimed at helping novice programmers improve their coding style.

Resources

License

Stars

12 stars

Watchers

1 watching

Forks

Contributors