Skip to main content

Simple set of checking tools for accepting code quality for NXP python projects

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nxp_codecheck-0.1.6.tar.gz (33.2 kB view hashes)

Uploaded Source

Built Distribution

nxp_codecheck-0.1.6-py3-none-any.whl (37.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page