search

NLeSC / python-template

Netherlands eScience Center Python Template
https://research-software-directory.org/software/nlesc-python-template
Apache License 2.0
180 stars 76 forks source link

fix prospector issues #227

Closed fdiblen closed 3 years ago

fdiblen commented 3 years ago 
prospector
Messages
========

build/lib/my_python_package/__init__.py
  Line: 3
    pyflakes: F401 / '.__version__.__version__' imported but unused (col 1)

build/lib/my_python_package/my_module.py
  Line: 3
    pylint: fixme / FIXME: put actual code here (col 2)
  Line: 5
    pep8: E302 / expected 2 blank lines, found 1 (col 1)
    pylint: missing-function-docstring / Missing function or method docstring

my_python_package/__init__.py
  Line: 3
    pyflakes: F401 / '.__version__.__version__' imported but unused (col 1)

my_python_package/my_module.py
  Line: 3
    pylint: fixme / FIXME: put actual code here (col 2)
  Line: 5
    pep8: E302 / expected 2 blank lines, found 1 (col 1)
    pylint: missing-function-docstring / Missing function or method docstring

setup.py
  Line: None
    pyroma: PYR05 / The package had no description!

tests/test_my_module.py
  Line: 9
    pylint: missing-function-docstring / Missing function or method docstring
  Line: 13
    pylint: missing-function-docstring / Missing function or method docstring
  Line: 17
    pylint: missing-function-docstring / Missing function or method docstring
  Line: 20
    pylint: superfluous-parens / Unnecessary parens after 'raise' keyword
  Line: 25
    pylint: missing-function-docstring / Missing function or method docstring
  Line: 29
    pylint: missing-function-docstring / Missing function or method docstring
    pylint: redefined-outer-name / Redefining name 'an_object' from outer scope (line 25) (col 19)

Check Information
=================
         Started: 2021-05-03 16:52:17.781886
        Finished: 2021-05-03 16:52:19.464513
      Time Taken: 1.68 seconds
       Formatter: grouped
        Profiles: .prospector.yml, full_pep8, no_doc_warnings, strictness_medium, strictness_high, strictness_veryhigh, no_member_warnings
      Strictness: from profile
  Libraries Used:
       Tools Run: dodgy, mccabe, pep8, profile-validator, pyflakes, pylint, pyroma
  Messages Found: 16
 External Config: pylint: /tmp/cookiecutter-generated.evC0j9/my-python-project/.pylintrc
fdiblen commented 3 years ago

Related to #228

sverhoeven commented 3 years ago

To solve version imported but unused error can we move content of __version__.py to __init__.py and update path in .bumpversion.cfg`.

sverhoeven commented 3 years ago

Related to #275

fdiblen commented 3 years ago

done in #287