awesome-flake8-extensions
pre-commit
awesome-flake8-extensions | pre-commit | |
---|---|---|
4 | 192 | |
1,193 | 12,087 | |
- | 1.7% | |
6.4 | 8.0 | |
about 1 month ago | 6 days ago | |
Python | ||
GNU General Public License v3.0 or later | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
awesome-flake8-extensions
-
A Tale of Two Kitchens - Hypermodernizing Your Python Code Base
Ultimately we want to test our code with Flake8 and plugins to enforce a more consistent code style and to encourage best practices. When you first introduce flake8 or a new plug-in commonly you have a lot of violations that you can silence with a #noqa comment. When you first introduce a new flake8 plugin, you will likely have a lot of violations, which you silence with #noqa comments. Over time these comments will become obsolete because you fixed the. yesqa will automatically remove these unnecessary #noqa comments.
-
Python toolkits
flake8 for linting along with following plugin (list of awesome plugin can be found here, but me and my teammates have selected the below one. Have linting but don't make it too hard.) flake8-black which uses black for code formatting check. flake8-isort which uses isort for separation of import in section and formatting them alphabetically. flake8-bandit which uses bandit for security linting. flake8-bugbear for finding likely bugs and design problems in your program. flake8-bugbear - Finding likely bugs and design problems in your program. pep8-naming for checking the PEP-8 naming conventions. mccabe for Ned’s script to check McCabe complexity flake8-comprehensions for writing better list/set/dict comprehensions.
-
Write better Python - with some help!
In addition to this out of the box -linting, there are loads of flake8 extensions that can help you with for example switching from .format() to using f-strings or checking that your naming follows the PEP8 guidelines. For example, adding flake8-length adds line length checking to the linting.
-
Standards to be aware of
And if you're using flake8, make sure to check out its plugins. Here's a good list: https://github.com/DmytroLitvinov/awesome-flake8-extensions
pre-commit
-
How to setup Black and pre-commit in python for auto text-formatting on commit
Today we are going to look at how to setup Black (a python code formatter) and pre-commit (a package for handling git hooks in python) to automatically format you code on commit.
-
Implementing Quality Checks In Your Git Workflow With Hooks and pre-commit
# See https://pre-commit.com for more information # See https://pre-commit.com/hooks.html for more hooks repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v3.2.0 hooks: - id: trailing-whitespace - id: end-of-file-fixer - id: check-yaml - id: check-toml - id: check-added-large-files - repo: local hooks: - id: tox lint name: tox-validation entry: pdm run tox -e test,lint language: system files: ^src\/.+py$|pyproject.toml|^tests\/.+py$ types_or: [python, toml] pass_filenames: false - id: tox docs name: tox-docs language: system entry: pdm run tox -e docs types_or: [python, rst, toml] files: ^src\/.+py$|pyproject.toml|^docs\/ pass_filenames: false - repo: https://github.com/pdm-project/pdm rev: 2.10.4 # a PDM release exposing the hook hooks: - id: pdm-lock-check - repo: https://github.com/jumanjihouse/pre-commit-hooks rev: 3.0.0 hooks: - id: markdownlint
-
Embracing Modern Python for Web Development
Pre-commit hooks act as the first line of defense in maintaining code quality, seamlessly integrating with linters and code formatters. They automatically execute these tools each time a developer tries to commit code to the repository, ensuring the code adheres to the project's standards. If the hooks detect issues, the commit is paused until the issues are resolved, guaranteeing that only code meeting quality standards makes it into the repository.
- EmacsConf Live Now
-
A Tale of Two Kitchens - Hypermodernizing Your Python Code Base
Pre-commit Hooks: Pre-commit is a tool that can be set up to enforce coding rules and standards before you commit your changes to your code repository. This ensures that you can't even check in (commit) code that doesn't meet your standards. This allows a code reviewer to focus on the architecture of a change while not wasting time with trivial style nitpicks.
-
Things I just don't like about Git
Ah, fair enough!
On my team we use pre-commit[0] a lot. I guess I would define the history to be something like "has this commit ever been run through our pre-commit hooks?". If you rewrite history, you'll (usually) produce commits that have not been through pre-commit (and they've therefore dodged a lot of static checks that might catch code that wasn't working, at that point in time). That gives some manner of objectivity to the "history", although it does depend on each user having their pre-commit hooks activated in their local workspace.
[0]: https://pre-commit.com/
-
Django Code Formatting and Linting Made Easy: A Step-by-Step Pre-commit Hook Tutorial
Pre-commit is a framework for managing and maintaining multi-language pre-commit hooks. It supports hooks for various programming languages. Using this framework, you only have to specify a list of hooks you want to run before every commit, and pre-commit handles the installation and execution of those hooks despite your project’s primary language.
-
Git: fu** the history!
You can learn more here: pre-commit.com
-
[Tool Anouncement] github-distributed-owners - A tool for managing GitHub CODEOWNERS using OWNERS files distributed throughout your code base. Especially helpful for monorepos / multi-team repos
Note this includes support for pre-commit.
-
Packaging Python projects in 2023 from scratch
As a nice next step, you could also add mypy to check your type hints are consistent, and automate running all this via pre-commit hooks set up with… pre-commit.
What are some alternatives?
black - The uncompromising Python code formatter
husky - Git hooks made easy 🐶 woof!
Airflow - Apache Airflow - A platform to programmatically author, schedule, and monitor workflows
gitleaks - Protect and discover secrets using Gitleaks 🔑
unimport - :rocket: The ultimate linter and formatter for removing unused import statements in your code. [Moved to: https://github.com/hakancelikdev/unimport]
ruff - An extremely fast Python linter and code formatter, written in Rust.
pep8-naming - Naming Convention checker for Python
semgrep - Lightweight static analysis for many languages. Find bug variants with patterns that look like source code.
pyre-check - Performant type-checking for python.
Poetry - Python packaging and dependency management made easy
flakes - list of flake8 plugins and their codes
pre-commit-golang - Pre-commit hooks for Golang with support for monorepos, the ability to pass arguments and environment variables to all hooks, and the ability to invoke custom go tools.