Metadata-Version: 2.4
Name: nxp_codecheck
Version: 0.3.12
Summary: Simple set of checking tools for accepting code quality for NXP python projects
Author: NXP
Maintainer-email: NXP <spsdk@nxp.com>
License: BSD-3-Clause
Project-URL: Homepage, https://github.com/nxp-mcuxpresso/spsdk_plugins/tree/master/codecheck
Project-URL: Issues, https://github.com/nxp-mcuxpresso/spsdk_plugins/issues
Keywords: spsdk_plugins,codecheck,nxp
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: bandit[toml]
Requires-Dist: black[jupyter]
Requires-Dist: click
Requires-Dist: colorama
Requires-Dist: defusedxml
Requires-Dist: GitPython
Requires-Dist: isort
Requires-Dist: jinja2
Requires-Dist: mypy
Requires-Dist: nbqa
Requires-Dist: prettytable
Requires-Dist: pydocstyle[toml]
Requires-Dist: PyGithub
Requires-Dist: pylint>=3.3.0
Requires-Dist: pytest
Requires-Dist: pytest-cov
Requires-Dist: pytest-xdist
Requires-Dist: pyyaml
Requires-Dist: radon
Requires-Dist: ruff
Requires-Dist: spsdk-pylint-plugins
Requires-Dist: tomli
Requires-Dist: types-pyyaml
Requires-Dist: types-requests
Requires-Dist: typing_extensions
Dynamic: license-file

NXP Python Code Checking tool
=============================


License
-------

* Free software: BSD-3-Clause


Features
--------

* Simple set of checking tools for accepting code quality for NXP python projects.
* Supported checkers:
	- Pytest - generate coverity reports
	- GitCov - Check the Pytest generated coverity reports on changed files
	- Pylint
	- MyPy
	- Radon D
	- Radon C
	- PyDocStyle
	- Dependency packages license check
	- Black (Supports fix feature)
	- iSort (Supports fix feature)
	- Copyright  (Supports fix feature)
	- Python script file header (Supports fix feature)
	- Cyclic import checker
* Supported Jupyter notebooks checkers:
	- Black (Supports fix feature)
	- iSort (Supports fix feature) 
	- Jupyter notebooks outputs check 

Installation
------------

* `pip install nxp_codecheck`
* Verify installation by running `codecheck --help`
    - you should see help for the codecheck tool

* configuration
	- Codecheck is using configuration in pyproject.toml file for custom checkers and main tool itself. The standard checker is using own settings from project
	- For custom configuration please check the pyproject.toml file of nxp_codecheck project for inspiration to Copy-Modify-Use in your enviroment


Credits
-------

This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter).
