| Name | nxp-codecheck JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | Simple set of checking tools for accepting code quality for NXP python projects |
| upload_time | 2024-12-19 12:11:46 |
| maintainer | None |
| docs_url | None |
| author | NXP |
| requires_python | >=3.9 |
| license | BSD-3-Clause |
| keywords |
spsdk_plugins
codecheck
nxp
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
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).
Raw data
{
"_id": null,
"home_page": null,
"name": "nxp-codecheck",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "NXP <michal.starecek@nxp.com>",
"keywords": "spsdk_plugins, codecheck, nxp",
"author": "NXP",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/54/06/27949bb291d7d78ac8c11f1ae9f18bed762d5b85ee91acc38bb65d735274/nxp_codecheck-0.3.1.tar.gz",
"platform": null,
"description": "NXP Python Code Checking tool\r\n=============================\r\n\r\n\r\nLicense\r\n-------\r\n\r\n* Free software: BSD-3-Clause\r\n\r\n\r\nFeatures\r\n--------\r\n\r\n* Simple set of checking tools for accepting code quality for NXP python projects.\r\n* Supported checkers:\r\n\t- Pytest - generate coverity reports\r\n\t- GitCov - Check the Pytest generated coverity reports on changed files\r\n\t- Pylint\r\n\t- MyPy\r\n\t- Radon D\r\n\t- Radon C\r\n\t- PyDocStyle\r\n\t- Dependency packages license check\r\n\t- Black (Supports fix feature)\r\n\t- iSort (Supports fix feature)\r\n\t- Copyright (Supports fix feature)\r\n\t- Python script file header (Supports fix feature)\r\n\t- Cyclic import checker\r\n* Supported Jupyter notebooks checkers:\r\n\t- Black (Supports fix feature)\r\n\t- iSort (Supports fix feature) \r\n\t- Jupyter notebooks outputs check \r\n\r\nInstallation\r\n------------\r\n\r\n* `pip install nxp_codecheck`\r\n* Verify installation by running `codecheck --help`\r\n - you should see help for the codecheck tool\r\n\r\n* configuration\r\n\t- Codecheck is using configuration in pyproject.toml file for custom checkers and main tool itself. The standard checker is using own settings from project\r\n\t- For custom configuration please check the pyproject.toml file of nxp_codecheck project for inspiration to Copy-Modify-Use in your enviroment\r\n\r\n\r\nCredits\r\n-------\r\n\r\nThis package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter).\r\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Simple set of checking tools for accepting code quality for NXP python projects",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/nxp-mcuxpresso/spsdk_plugins/tree/master/codecheck",
"Issues": "https://github.com/nxp-mcuxpresso/spsdk_plugins/issues"
},
"split_keywords": [
"spsdk_plugins",
" codecheck",
" nxp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5ae663f4cde6adb41ceff933a3181f3f8736ffaa7d28fc89ec4f5ef79411aaf5",
"md5": "70c35c83b01fa29b72165caa04f428e0",
"sha256": "fc9f7d1260847220ca21675acfc3437dfabccda7318745f132d971f6be5db676"
},
"downloads": -1,
"filename": "nxp_codecheck-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70c35c83b01fa29b72165caa04f428e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 41634,
"upload_time": "2024-12-19T12:11:43",
"upload_time_iso_8601": "2024-12-19T12:11:43.777132Z",
"url": "https://files.pythonhosted.org/packages/5a/e6/63f4cde6adb41ceff933a3181f3f8736ffaa7d28fc89ec4f5ef79411aaf5/nxp_codecheck-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "540627949bb291d7d78ac8c11f1ae9f18bed762d5b85ee91acc38bb65d735274",
"md5": "b8281392d4ae6dd92c0f2bc47ee04f89",
"sha256": "3dcfaa11bb4de11e11a11520655d494dc0928d8128efdd6973c780afe6b4fae5"
},
"downloads": -1,
"filename": "nxp_codecheck-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "b8281392d4ae6dd92c0f2bc47ee04f89",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 37958,
"upload_time": "2024-12-19T12:11:46",
"upload_time_iso_8601": "2024-12-19T12:11:46.436606Z",
"url": "https://files.pythonhosted.org/packages/54/06/27949bb291d7d78ac8c11f1ae9f18bed762d5b85ee91acc38bb65d735274/nxp_codecheck-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 12:11:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nxp-mcuxpresso",
"github_project": "spsdk_plugins",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nxp-codecheck"
}
