standardised code analysis with pylint

# List of plugins (as comma separated values of python modules names) to load,

# usually to register additional checkers.

load-plugins=

load-plugins=pylint_junit

# Pickle collected data for later comparisons.

persistent=yes

# --enable=similarities". If you want to run only the classes checker, but have

# no Warning level messages displayed, use "--disable=all --enable=classes

# --disable=W".

disable=print-statement,

        parameter-unpacking,

        unpacking-in-except,

        old-raise-syntax,

        backtick,

        long-suffix,

        old-ne-operator,

        old-octal-literal,

        import-star-module-level,

        non-ascii-bytes-literal,

        raw-checker-failed,

        bad-inline-option,

        locally-disabled,

        locally-enabled,

        file-ignored,

        suppressed-message,

        useless-suppression,

        deprecated-pragma,

        use-symbolic-message-instead,

        c-extension-no-member,

        redefined-outer-name,

        apply-builtin,

        basestring-builtin,

        buffer-builtin,

        cmp-builtin,

        coerce-builtin,

        execfile-builtin,

        file-builtin,

        long-builtin,

        raw_input-builtin,

        reduce-builtin,

        standarderror-builtin,

        unicode-builtin,

        xrange-builtin,

        coerce-method,

        delslice-method,

        getslice-method,

        setslice-method,

        no-absolute-import,

        old-division,

        dict-iter-method,

        dict-view-method,

        next-method-called,

        metaclass-assignment,

        indexing-exception,

        raising-string,

        reload-builtin,

        oct-method,

        hex-method,

        nonzero-method,

        cmp-method,

        input-builtin,

        round-builtin,

        intern-builtin,

        unichr-builtin,

        map-builtin-not-iterating,

        zip-builtin-not-iterating,

        range-builtin-not-iterating,

        filter-builtin-not-iterating,

        using-cmp-argument,

        eq-without-hash,

        div-method,

        idiv-method,

        rdiv-method,

        exception-message-attribute,

        invalid-str-codec,

        sys-max-int,

        bad-python3-import,

        deprecated-string-function,

        deprecated-str-translate-call,

        deprecated-itertools-function,

        deprecated-types-field,

        next-method-defined,

        dict-items-not-iterating,

        dict-keys-not-iterating,

        dict-values-not-iterating,

        deprecated-operator-function,

        deprecated-urllib-function,

        xreadlines-attribute,

        deprecated-sys-function,

        exception-escape,

        comprehension-escape

disable=C,

        R,

        W

# Enable the message, report, category or checker with the given id(s). You can

# either give multiple identifier separated by comma (,) or put this option

# multiple time (only on the command line, not in the configuration file where

# it should appear only once). See also the "--disable" option for examples.

enable=

enable=unreachable,

       duplicate-key,

       unnecessary-semicolon,

       global-variable-not-assigned,

       unused-variable,

       binary-op-exception,

       bad-format-string,

       anomalous-backslash-in-string,

       bad-open-mode

[REPORTS]

# Set the output format. Available formats are text, parseable, colorized, json

# and msvs (visual studio). You can also give a reporter class, e.g.

# mypackage.mymodule.MyReporterClass.

output-format=text

output-format=junit

# Tells whether to display a full report or only the messages.

reports=no

reports=yes

# Activate the evaluation score.

score=yes

MarkupSafe = "*"

Pygments = "*"

pylint = "*"

pylint-junit = "*"

pytest = "*"

pytest-cov = "*"

pytest-pylint = "*"

 * Use [Pylint](https://www.pylint.org) as the code analysis framework

 * By default it uses the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/)

 * Use the provided `code-analysis.sh` script in order to run the code analysis in the `module` and `tests`

 * Code analysis should be run by calling `pylint ska_python_skeleton`. All pertaining options reside under the `.pylintrc` file.

 * Code analysis should only raise document related warnings (i.e. `#FIXME` comments) before merging the code

Writing documentation

#!/usr/bin/env bash

echo "STATIC CODE ANALYSIS"

echo "===================="

echo

echo "MODULE ANALYSIS"

echo "---------------"

pylint ska_python_skeleton

echo "TESTS ANALYSIS"

echo "--------------"

pylint tests