flake8_quickstart_cli_and_python_api_usage.py

1# Flake8 is primarily a command-line tool. 
2# To use it, you first install it via pip:
3# pip install flake8
4
5# To run it on a specific file:
6# flake8 path/to/code.py
7
8# To run it on an entire directory:
9# flake8 path/to/code/
10
11# If you want to use it within your Python code (though less common), 
12# you can use the following snippet to check a file programmatically:
13
14import flake8.api.legacy as flake8
15
16# Initialize a style guide
17style_guide = flake8.get_style_guide(ignore=['E24', 'W504'])
18
19# Check a list of files
20report = style_guide.check_files(['path/to/your_script.py'])
21
22# Get the number of errors found
23statistics = report.get_statistics('E')
24print(f"Number of errors found: {len(statistics)}")