Improve your Django Code with pre-commit

• ruff

  95 26,504 10.0 Rust

  An extremely fast Python linter and code formatter, written in Rust.

  

A kind reddit user by the name of lanemik suggested I give ruff a go. I have heard of this tool before, but never actually gave it a go.

• basic-django

  1 5 3.3 Python
  

Before we continue, I would like to mention that you can look at all the code that we wrote in this tutorial by looking into the pre-commit PR on the basic-django repo.

• WorkOS

  workos.com sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• autoflake

  8 858 8.1 Python

  Removes unused imports and unused variables as reported by pyflakes

  

Ruff can be used to replace Flake8 (plus dozens of plugins), isort, pydocstyle, yesqa, eradicate, pyupgrade, and autoflake, all while executing tens or hundreds of times faster than any individual tool.

• pre-commit

  192 12,049 8.0 Python

  A framework for managing and maintaining multi-language pre-commit hooks.

  

I am going to go through each step with you, but I encourage you to check out the official website. The instructions they have are very useful.

• pre-commit-hooks

  22 4,874 7.2 Python

  Some out-of-the-box hooks for pre-commit

  

exclude: .*migrations\/.* repos: - repo: https://github.com/pre-commit/pre-commit-hooks ... - repo: https://github.com/psf/black rev: 22.12.0 hooks: - id: black language_version: python3.9

• black

  322 37,376 9.4 Python

  The uncompromising Python code formatter

  

Black is a Python code formatter. This means that when this hook will run, all the files that you want to commit will be checked for any inconsistencies and bad styling (based on PEP 8 standard). This hook will automatically fix those issues.

• isort

  41 6,314 7.4 Python

  A Python utility / library to sort imports.

  

repos: ... pre-commmit stuff ... black stuff - repo: https://github.com/pycqa/isort rev: 5.12.0 hooks: - id: isort name: isort (python)

• InfluxDB

  www.influxdata.com sponsored

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

• Flake8

  33 3,257 7.5 Python

  flake8 is a python tool that glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code.

  

• Pylint

  29 5,110 9.6 Python

  It's not just a linter that annoys you!

  

One last thing to do before running the hooks is to create a config file, just like we did with flake8. For this you are going to create a pylintrc file at the roor of your project and copy the contents of the pylintrc file from the pylint repo (here is the link to it).

• djLint

  4 598 8.3 Python

  ✨ HTML Template Linter and Formatter. Django - Jinja - Nunjucks - Handlebars - GoLang

  

For Django users, which you presumably are, this will be a God send! Check out the repo. This is an HTML linter... but for Django templates 🤯

• Poetry

  377 29,483 9.7 Python

  Python packaging and dependency management made easy

  

- repo: https://github.com/python-poetry/poetry rev: '1.4.1' hooks: - id: poetry-export args: [ "-f", "requirements.txt", "-o", "requirements.txt", "--without-hashes" ]

• yesqa

  2 257 6.9 Python

  Automatically remove unnecessary `# noqa` comments

Ruff can be used to replace Flake8 (plus dozens of plugins), isort, pydocstyle, yesqa, eradicate, pyupgrade, and autoflake, all while executing tens or hundreds of times faster than any individual tool.

• ruff-pre-commit

  4 687 8.5 Python

  A pre-commit hook for Ruff.

  

Suggest a related project