geotribu_cli.content.header_check module

geotribu_cli.content.header_check.check_author_md(author, folder)

Type renvoyé:

bool

geotribu_cli.content.header_check.check_existing_tags(tags)

Type renvoyé:

tuple[bool, set[str], set[str]]

geotribu_cli.content.header_check.check_image_extension(image_url, allowed_extensions=('.png', '.jpg', '.jpeg'))

Type renvoyé:

bool

geotribu_cli.content.header_check.check_image_ratio(image_url, images, min_ratio, max_ratio)

Type renvoyé:

bool

geotribu_cli.content.header_check.check_image_size(image_url, images, max_width, max_height)

Checks if an image respects provided max dimensions using CDN index file

Paramètres:

• image_url (str) – HTTP url of the image to check

• images (dict) – Dictionary of image dimensions (see download_image_sizes())

• max_width (int) – maximum width of the image

• max_height (int) – maximum height of the image

Type renvoyé:

bool

Renvoie:

True if image max dimensions are respected False if not

geotribu_cli.content.header_check.check_license(license_id)

Vérifie que la licence choisie fait partie de celles disponibles.

Paramètres:

license – identifiant de la licence.

Type renvoyé:

bool

Renvoie:

True si la licence est l’une de celles disponibles.

geotribu_cli.content.header_check.check_missing_mandatory_keys(keys)

Liste les clés de l’en-tête qui sont manquantes par rapport à celles requises.

Paramètres:

keys (list[str]) – clés de l’en-tête à comparer

Type renvoyé:

tuple[bool, set[str]]

Renvoie:

un tuple à 2 valeurs composé d’un booléen indiquant s’il manque une clé

obligatoire et la liste des clés manquantes

geotribu_cli.content.header_check.check_tags_order(tags)

Type renvoyé:

bool

geotribu_cli.content.header_check.download_image_sizes()

Downloads image dimensions file from CDN

Type renvoyé:

dict

Renvoie:

Dict of image dimensions

geotribu_cli.content.header_check.get_existing_tags()

Type renvoyé:

list[str]

geotribu_cli.content.header_check.parser_header_check(subparser)

Set the argument parser subcommand.

Paramètres:

subparser (argparse.ArgumentParser) – parser to set up

Renvoie:

parser ready to use

Type renvoyé:

argparse.ArgumentParser

geotribu_cli.content.header_check.run(args)

Run the sub command logic.

Checks YAML header of a content

Paramètres:

args (argparse.Namespace) – arguments passed to the subcommand

Type renvoyé:

None