nxp-codecheck

Name	nxp-codecheck JSON
Version	0.3.7 JSON
	download
home_page	None
Summary	Simple set of checking tools for accepting code quality for NXP python projects
upload_time	2025-02-11 18:42:06
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/08/48/f412eb547a8ac704c6b52f5307dd460e5d965795819c5d1fd61db01edde9/nxp_codecheck-0.3.7.tar.gz",
    "platform": null,
    "description": "NXP Python Code Checking tool\n=============================\n\n\nLicense\n-------\n\n* Free software: BSD-3-Clause\n\n\nFeatures\n--------\n\n* Simple set of checking tools for accepting code quality for NXP python projects.\n* Supported checkers:\n\t- Pytest - generate coverity reports\n\t- GitCov - Check the Pytest generated coverity reports on changed files\n\t- Pylint\n\t- MyPy\n\t- Radon D\n\t- Radon C\n\t- PyDocStyle\n\t- Dependency packages license check\n\t- Black (Supports fix feature)\n\t- iSort (Supports fix feature)\n\t- Copyright  (Supports fix feature)\n\t- Python script file header (Supports fix feature)\n\t- Cyclic import checker\n* Supported Jupyter notebooks checkers:\n\t- Black (Supports fix feature)\n\t- iSort (Supports fix feature) \n\t- Jupyter notebooks outputs check \n\nInstallation\n------------\n\n* `pip install nxp_codecheck`\n* Verify installation by running `codecheck --help`\n    - you should see help for the codecheck tool\n\n* configuration\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\n\t- For custom configuration please check the pyproject.toml file of nxp_codecheck project for inspiration to Copy-Modify-Use in your enviroment\n\n\nCredits\n-------\n\nThis package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter).\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.7",
    "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": "0848f412eb547a8ac704c6b52f5307dd460e5d965795819c5d1fd61db01edde9",
                "md5": "79c774376877986a9c4e8536ba72c199",
                "sha256": "9f2e4357f065e82fd52787afb615329c793d15aa388952facfcf8606b615695c"
            },
            "downloads": -1,
            "filename": "nxp_codecheck-0.3.7.tar.gz",
            "has_sig": false,
            "md5_digest": "79c774376877986a9c4e8536ba72c199",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 41286,
            "upload_time": "2025-02-11T18:42:06",
            "upload_time_iso_8601": "2025-02-11T18:42:06.656869Z",
            "url": "https://files.pythonhosted.org/packages/08/48/f412eb547a8ac704c6b52f5307dd460e5d965795819c5d1fd61db01edde9/nxp_codecheck-0.3.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-11 18:42:06",
    "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"
}