cheesecake_kwalitee_index.kwalitee package

Submodules

cheesecake_kwalitee_index.kwalitee.evaluator module

The main suite of tests that are run to generate the cheesecake kwalitee index of a package.

class cheesecake_kwalitee_index.kwalitee.evaluator.Evaluator(package, version='*')

Bases: object

The Evaluator is in charge of downloading a package and evaluating it against the cheesecake kwalitee index.

clean_up()

Remove the installed directory and do any other necessary clean up.

evaluate_score()

Run the entire test suite and get the package’s score.

get_version()

Get __version__. If __version__ exists then give 10 points, otherwise zero.

install_package()

Try to install the package. If it installs, you get 10 points. Otherwise you get nothing.

lint_test()

Pass the package through the linter.

cheesecake_kwalitee_index.kwalitee.evaluator.download(package, dest)

Download a package to a specified location. Making sure to get a source distribution.

cheesecake_kwalitee_index.kwalitee.evaluator.get_version_number(file_path, name)

cheesecake_kwalitee_index.kwalitee.evaluator.lint(dest, name)

Run Pylint and get the overall score of a package.

cheesecake_kwalitee_index.kwalitee.models module

All the data structures that are needed when generating a “kwalitee” score.

class cheesecake_kwalitee_index.kwalitee.models.Score(value, total)

Bases: object

A generic score.

as_float()

Module contents

Seeing as the cheescake package I was originally planning to use was designed for Python 2.x, I’m going to develop my own version of module to “Give a score to your Python package based on empirical ‘kwalitee’ factors”.