check_completeness

Completeness

Verify that the recipe is not missing anything essential.

Classes

missing_build_number(_linter)	The recipe is missing a build number
missing_hash(_linter)	The recipe is missing a checksum for a source file
missing_home(_linter)	The recipe is missing a homepage URL
missing_license(_linter)	The recipe is missing the about/license key.
missing_summary(_linter)	The recipe is missing a summary
missing_tests(_linter)	The recipe is missing tests.

Documentation

class bioconda_utils.lint.check_completeness.missing_build_number(_linter)

The recipe is missing a build number

Please add:

build:
    number: 0

check_recipe(recipe)

Execute check on recipe

Override this method in subclasses, using self.message() to issue LintMessage as failures are encountered.

Parameters:

recipe – The recipe under test.

messages: List[LintMessage]

Messages collected running tests

recipe: _recipe.Recipe

Recipe currently being checked

try_fix: bool

Whether we are supposed to fix

class bioconda_utils.lint.check_completeness.missing_home(_linter)

The recipe is missing a homepage URL

Please add:

about:
   home: <URL to homepage>

check_recipe(recipe)

Execute check on recipe

Override this method in subclasses, using self.message() to issue LintMessage as failures are encountered.

Parameters:

recipe – The recipe under test.

messages: List[LintMessage]

Messages collected running tests

recipe: _recipe.Recipe

Recipe currently being checked

try_fix: bool

Whether we are supposed to fix

class bioconda_utils.lint.check_completeness.missing_summary(_linter)

The recipe is missing a summary

Please add:

about:
  summary: One line briefly describing package

check_recipe(recipe)

Execute check on recipe

Override this method in subclasses, using self.message() to issue LintMessage as failures are encountered.

Parameters:

recipe – The recipe under test.

messages: List[LintMessage]

Messages collected running tests

recipe: _recipe.Recipe

Recipe currently being checked

try_fix: bool

Whether we are supposed to fix

class bioconda_utils.lint.check_completeness.missing_license(_linter)

The recipe is missing the about/license key.

Please add:

about:
   license: <name of license>

check_recipe(recipe)

Execute check on recipe

Override this method in subclasses, using self.message() to issue LintMessage as failures are encountered.

Parameters:

recipe – The recipe under test.

messages: List[LintMessage]

Messages collected running tests

recipe: _recipe.Recipe

Recipe currently being checked

try_fix: bool

Whether we are supposed to fix

class bioconda_utils.lint.check_completeness.missing_tests(_linter)

The recipe is missing tests.

Please add:

test:
    commands:
       - some_command

and/or:

test:
    imports:
       - some_module

and/or any file named run_test.py`, ``run_test.sh or run_test.pl executing tests.

check_recipe(recipe)

Execute check on recipe

Override this method in subclasses, using self.message() to issue LintMessage as failures are encountered.

Parameters:

recipe – The recipe under test.

messages: List[LintMessage]

Messages collected running tests

recipe: _recipe.Recipe

Recipe currently being checked

try_fix: bool

Whether we are supposed to fix

class bioconda_utils.lint.check_completeness.missing_hash(_linter)

The recipe is missing a checksum for a source file

Please add:

source:
  sha256: checksum-value

check_source(source, section)

Execute check on each source

Parameters:

• source – Dictionary containing the source section

• section – Path to the section. Can be source or source/0 (1,2,3…).

messages: List[LintMessage]

Messages collected running tests

recipe: _recipe.Recipe

Recipe currently being checked

try_fix: bool

Whether we are supposed to fix