Checking the Django project for quality
Project description
Garpix QA
Checking the Django project for quality. It can be convenient if you include it in CI.
Used packages:
django unittest - unit testing in Django.
flake8 - linter of source code.
radon - tool that computes various metrics from the source code.
bandit - a security linter from PyCQA.
Quickstart
Install with pip:
pip install garpix_qa
Add the garpix_qa to your INSTALLED_APPS:
# settings.py
INSTALLED_APPS = [
# ...
'garpix_qa',
]
Check your project:
python manage.py qa
Check your project with all logs:
python manage.py qa --verbose
Example output with OK
Input
Directory: /Users/aleksejkuznecov/projects/garpix_packages/garpix-qa/backend
Start at: 2021-02-27 12:09:30.999142
Checking
Checking style guide with flake8 (see ".flake8") OK
Django unit tests OK
Cyclomatic complexity with radon (see "radon.cfg") OK
Security lint with bandit (only high-severity issues, see ".bandit") OK
Result
Problems found: 0
End at: 2021-02-27 12:09:33.789880
Duration: 0:00:02.790738
Example output with problems
Input
Directory: /Users/aleksejkuznecov/projects/garpix_packages/garpix-qa/backend
Start at: 2021-02-27 12:23:41.066752
Checking
Checking style guide with flake8 (see ".flake8") ERROR
/Users/aleksejkuznecov/projects/garpix_packages/garpix-qa/backend/garpix_qa/constants.py:18:4: W292 no newline at end of file
/Users/aleksejkuznecov/projects/garpix_packages/garpix-qa/backend/garpix_qa/helpers.py:38:1: E302 expected 2 blank lines, found 1
/Users/aleksejkuznecov/projects/garpix_packages/garpix-qa/backend/garpix_qa/colors.py:9:1: W391 blank line at end of file
Django unit tests OK
Cyclomatic complexity with radon (see "radon.cfg") OK
Security lint with bandit (only high-severity issues, see ".bandit") ERROR
[main] INFO Found project level .bandit file: /Users/aleksejkuznecov/projects/garpix_packages/garpix-qa/backend/.bandit
[main] INFO profile include tests: None
[main] INFO cli include tests: None
[main] INFO cli exclude tests: None
[main] INFO running on Python 3.8.2
Run started:2021-02-27 12:23:45.044503
Test results:
>> Issue: [B602:subprocess_popen_with_shell_equals_true] subprocess call with shell=True identified, security issue.
Severity: High Confidence: High
Location: /Users/aleksejkuznecov/projects/garpix_packages/garpix-qa/backend/garpix_qa/helpers.py:39
More Info: https://bandit.readthedocs.io/en/latest/plugins/b602_subprocess_popen_with_shell_equals_true.html
38 def shell_run(cmd):
39 ps = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
40 lines = ps.communicate()[0]
--------------------------------------------------
Code scanned:
Total lines of code: 285
Total lines skipped (#nosec): 0
Run metrics:
Total issues (by severity):
Undefined: 0.0
Low: 1.0
Medium: 0.0
High: 1.0
Total issues (by confidence):
Undefined: 0.0
Low: 0.0
Medium: 0.0
High: 2.0
Files skipped (0):
Result
Problems found: 2
End at: 2021-02-27 12:23:45.098015
Duration: 0:00:04.031263
Changelog
See CHANGELOG.md.
Contributing
See CONTRIBUTING.md.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
garpix_qa-1.2.0.tar.gz
(9.4 kB
view hashes)
Built Distribution
garpix_qa-1.2.0-py3-none-any.whl
(14.3 kB
view hashes)
Close
Hashes for garpix_qa-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 208c6172864db239989d10c9aab2001708df35fcb4239ddb79a0149312076047 |
|
MD5 | d220e7dc5d8ed84c81cbd6404c319675 |
|
BLAKE2b-256 | 27d4511cfcc70db961d26c4b8834abc4256974114ce59e3a0b764ef7a2937698 |