Skip to main content

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

Project description

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 anna.rechtackova@mail.muni.cz.

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).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

edulint-4.3.1.tar.gz (255.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

edulint-4.3.1-py3-none-any.whl (255.8 kB view details)

Uploaded Python 3

File details

Details for the file edulint-4.3.1.tar.gz.

File metadata

  • Download URL: edulint-4.3.1.tar.gz
  • Upload date:
  • Size: 255.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for edulint-4.3.1.tar.gz
Algorithm Hash digest
SHA256 0bc9ee95743a18a70f92eb426e06b1af2713fcc21aedacf60dff0ae2902484f9
MD5 47492287cbfb4d06207af65e4cd632bf
BLAKE2b-256 a16b040173a931feedf48912070e5c46583b632fa67428cf544d74acec70241e

See more details on using hashes here.

File details

Details for the file edulint-4.3.1-py3-none-any.whl.

File metadata

  • Download URL: edulint-4.3.1-py3-none-any.whl
  • Upload date:
  • Size: 255.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for edulint-4.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 66a6110418457ed314db047fe302eeed390390338d729055d636c765f8ae1b9a
MD5 8dd794dc11743b84b92f2efdfabbc88f
BLAKE2b-256 4da7b2e15c67363a896897c7a61bf5441ea91f98a5a7acc0106ce880591f6dff

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page