/py-prj-tmpl

Empty Python project template with GitHub Actions Pylint and Custom Pytest integrated

Primary LanguagePython

Introduction

This Git repo serves as a template for a newly started Python Project
Compatible Python version:

  • 3.8
  • 3.9
  • 3.10

Commit message
Please start the commit message with the following tags:

  • Create new file
Create <message>  
  • Add new code
Add <message>  
  • Update file / code
Update <message>
  • Remove file / code
Remove <messasge>

Pylint
Github's commitment to this project is managed with Pylint.
Pylint warnings will prevent the commit until all the warnings are resolved.
In case you cannot resolve the warning, leave the following comment at the end of the same line

# pylint: disable=<pylint-warning-1>, <pylint-warning-2>, etc.

For example:

  • Pylint warning:

    Line too long (145/100) Pylint(C0301:line-too-long)  
    
  • To disable it:

    # pylint: disable=line-too-long  
    

In case you want to disable pylint check with the whole file, put the following comment at the beginning of the *.py module:

  • Pylint < 0.25:

    # pylint: disable-all  
    
  • Pylint 0.26.1 ->:

    # pylint: skip-file  
    

You might not like it, but that's my preference to keep things in place ;)