Python API

Brazil Data Cube Configuration.

class lccs_ws.config.Config

Base configuration with default flags.

class lccs_ws.config.DevelopmentConfig

Development Mode.

class lccs_ws.config.ProductionConfig

Production Mode.

class lccs_ws.config.TestingConfig

Testing Mode (Continous Integration).

lccs_ws.config.get_settings(env)

Retrieve Config class from environment.

Data module of Land Cover Classification System Web Service.

lccs_ws.data.classification_system(system_id)

Verify if classification system exist in server.

Parameters:

system_id (integer) – identifier of classification system

lccs_ws.data.create_classification_system(name: str, authority_name: str, version: str, title: dict, description: dict) → dict

Create a full classification system.

Parameters:

• name (string) – Classification system name

• authority_name (string) – The authority name of Classification system

• version (string) – The Classification system version

• title (string) – The Classification system title

• description (string) – The Classification system description

lccs_ws.data.create_style_format(name: str) → dict

Create style format.

Parameters:

name (string) – name for a new style format

lccs_ws.data.delete_class(system_id_or_identifier: str, class_id_or_identifier: str)

Delete an class by a given name and classification system.

lccs_ws.data.delete_classes(system_id_or_identifier: str) → None

Delete all class by a given classification system.

Parameters:

system_id_or_identifier (string) – The id or identifier of Classification System.

lccs_ws.data.delete_classification_system(system_id_or_identifier: str) → None

Delete an classification system by a identifier.

Parameters:

system_id_or_identifier (string) – The id or identifier of a classification system to be deleted

lccs_ws.data.delete_file(style_format_id_or_name: str, system_id_or_identifier: str) → None

Delete a style from a classification system.

Parameters:

• style_format_id_or_name (string) – The id or name of style format

• system_id_or_identifier (string) – The id or identification of classification system

lccs_ws.data.delete_mappings(system_id_or_identifier_source: str, system_id_or_identifier_target: str)

Delete classification system mappings.

lccs_ws.data.delete_style_format(style_format_id_or_name: str)

Delete an style format a identifier.

Parameters:

style_format_id_or_name (string) – The id or identifier of a style format to be deleted

lccs_ws.data.get_classification_system(system_id_or_identifier: str) → Dict

Retrieve information for a given classification system.

Parameters:

system_id_or_identifier (string) – The id or identifier of a classification system

lccs_ws.data.get_classification_system_class(system_id_or_identifier: str, class_id_or_name: str) → Tuple[int, dict]

Retrieve information for a given class.

Parameters:

• system_id_or_identifier (string) – The id or identifier of a classification system

• class_id_or_name (string) – The id or name of a class

lccs_ws.data.get_classification_system_classes(system_id_or_identifier: str) → Tuple[int, list]

Retrieve a list of classes for a given classification system.

Parameters:

system_id_or_identifier (string) – The id or identifier of a classification system

lccs_ws.data.get_classification_system_style(system_id_or_identifier: str, style_format_id_or_name: str) → Union[str, BytesIO]

Return the style of a classification system.

Parameters:

• system_id_or_identifier (string) – The id or identifier of a specific classification system

• style_format_id_or_name (string) – The id or name of a specific of Style Format

lccs_ws.data.get_classification_systems() → List[dict]

Retrieve all classification systems available in service.

lccs_ws.data.get_identifier_style_format(style_format_name)

Return the identifier of style format.

Parameters:

style_format_name (string) – name of a style format

lccs_ws.data.get_identifier_system(system_name, system_version)

Return the identifier of classification system and classes.

Parameters:

• system_name (string) – name of a classification system

• system_version (string) – version of a classification system

lccs_ws.data.get_mapping(system_id_or_identifier_source: str, system_id_or_identifier_target: str) → Tuple[int, int, list]

Return the classes mapping between the classification system.

Parameters:

• system_id_or_identifier_source (str) – id or identifier of a source classification system

• system_id_or_identifier_target (str) – id or identifier of a target classification system

lccs_ws.data.get_mappings(system_id_or_identifier: str) → Tuple[LucClassificationSystem, List]

Return available mapping for a classification system.

Parameters:

system_id_or_identifier (int) – identification of a source classification system

lccs_ws.data.get_style_format(style_format_id_or_name) → dict

Retrieve information for a style format.

Parameters:

style_format_id_or_name (string) – The id or name of a style format

lccs_ws.data.get_style_formats() → List[dict]

Retrieve all styles formats available in service.

lccs_ws.data.get_system_mapping(system_id_source: int, system_id_target: int) → ClassMapping

Return a Mapping.

Parameters:

• system_id_source (int) – identification of a source classification system

• system_id_target (int) – identification of a target classification system

lccs_ws.data.get_system_style_format(system_id_or_identifier) → Tuple[int, List[int]]

Return the styles formats available for a classification system.

Parameters:

system_id_or_identifier (string) – The id or identifier of a classification system

lccs_ws.data.insert_class(system_id: int, name: str, code: str, title: dict, description: dict, class_parent_id: str = None) → int

Create a new class.

Parameters:

• system_id (int) – identifier of classification system.

• name (string) – name of a class.

• code (string) – class code.

• title (string) – class title.

• description (string) – class description.

• class_parent_id (integer) – class class_parent_id.

lccs_ws.data.insert_classes(system_id_or_identifier: str, classes_files_json: dict) → List

Create classes for a given classification system.

Parameters:

• classes_files_json (dict) – classes file

• system_id_or_identifier (string) – The id or identifier of classification system

lccs_ws.data.insert_file(system_id_or_identifier: str, style_format_id_or_name: str, file: FileStorage) → int

Insert File method.

Parameters:

• style_format_id_or_name (string) – The ir or name of style format.

• system_id_or_identifier (string) – The id or name of classification system

• file (binary) – Style File.

lccs_ws.data.insert_mapping(system_id_source: int, system_id_target: int, target_class: str, source_class: str, description, degree_of_similarity) → None

Insert mapping.

lccs_ws.data.insert_mappings(system_id_or_identifier_source: str, system_id_or_identifier_target: str, mapping_file: dict) → List

Create classes for a given classification system.

Parameters:

• system_id_or_identifier_source (integer) – identifier of a source classification system

• system_id_or_identifier_target (string) – identifier of a target classification system

• mapping_file (json) – json file with mappings

lccs_ws.data.update_class(system_id_or_identifier: int, class_id_or_identifier: int, obj: dict) → dict

Update an classification system by a given name.

lccs_ws.data.update_classification_system(system_id_or_identifier: str, obj: dict) → dict

Update an classification system by a given name.

Parameters:

• system_id_or_identifier (string) – The id or identifier of Classification System.

• obj (dict) – Object with classification system information to update

lccs_ws.data.update_file(style_format_id_or_name: str, system_id_or_identifier: str, file: FileStorage) → int

Update File style.

Parameters:

• style_format_id_or_name (string) – The id or name of style format

• system_id_or_identifier (string) – The id or identification of classification system

• file (binary) – Style File

lccs_ws.data.update_mapping(system_id_or_identifier_source: str, system_id_or_identifier_target: str, degree_of_similarity: float, description: str, source_class: str, target_class: str) → dict

Update mappings.

Parameters:

• system_id_or_identifier_source (string) – The id or identifier of Source Classification System

• system_id_or_identifier_target (string) – The id or identifier of Target Classification System

• degree_of_similarity (float) – The degree of similarity in mapping

• description (string) – The description of mapping

• source_class (string) – The id or identifier of source class

• target_class (string) – The id or identifier of target class

lccs_ws.data.update_style_format(style_format_id_or_name: str, name: str) → dict

Update an style format.

Parameters:

• style_format_id_or_name (string) – The name or identifier of style format.

• name (string) – name of style format for update.

Views of Land Cover Classification System Web Service.

lccs_ws.views.before_request()

Handle for before request processing.

lccs_ws.views.classification_system_search(system_name, system_version)

Return identifier of a classification system.

Parameters:

• system_name – name of a classification system

• system_version – version of a classification system

lccs_ws.views.classification_systems_class(system_id_or_identifier, class_id_or_name, **kwargs)

Retrieve class information from a classification system.

Parameters:

• system_id_or_identifier – The id or identifier of a classification system

• class_id_or_name – identifier of a class

lccs_ws.views.classification_systems_classes(system_id_or_identifier, **kwargs)

Retrieve the classes of a classification system.

Parameters:

system_id_or_identifier – The id or identifier of a classification system

lccs_ws.views.create_delete_classes(system_id_or_identifier, **kwargs)

Create classes for a classification system.

Parameters:

system_id_or_identifier – The id or identifier of a classification system

lccs_ws.views.edit_class(system_id_or_identifier, class_id_or_name, **kwargs)

Delete class of a specific classification system.

Parameters:

• system_id_or_identifier – The id or identifier of a classification system

• class_id_or_name – The id or identifier of a class

lccs_ws.views.edit_classification_system(system_id_or_identifier, **kwargs)

Create or edit a specific classification system.

Parameters:

system_id_or_identifier – The id or identifier of a classification system

lccs_ws.views.edit_mapping(system_id_or_identifier_source, system_id_or_identifier_target, **kwargs)

Create or edit mappings in service.

Parameters:

• system_id_or_identifier_source – The id or identifier of a source classification system

• system_id_or_identifier_target – The id or identifier of a target classification system

lccs_ws.views.edit_style_formats(style_format_id_or_name, **kwargs)

Create or edit styles formats.

Parameters:

style_format_id_or_name – The id or name of a specific style format

lccs_ws.views.edit_styles(system_id_or_identifier, style_format_id_or_name, **kwargs)

Create or edit styles.

Parameters:

• system_id_or_identifier – The id or identifier of a specific classification system

• style_format_id_or_name – The id or identifier of a specific style format.

lccs_ws.views.get_classification_system(system_id_or_identifier, **kwargs)

Retrieve information about the classification system.

Parameters:

system_id_or_identifier – The id or identifier of a classification system

lccs_ws.views.get_classification_systems(**kwargs)

Retrieve the list of available classification systems in the service.

lccs_ws.views.get_mapping(system_id_or_identifier_source, system_id_or_identifier_target, **kwargs)

Retrieve mapping.

Parameters:

• system_id_or_identifier_source – The id or identifier of source classification system

• system_id_or_identifier_target – The id or identifier of target classification system

lccs_ws.views.get_mappings(system_id_or_identifier, **kwargs)

Retrieve available mappings for a classification system.

Parameters:

system_id_or_identifier – The id or identifier of a classification system

lccs_ws.views.get_style_format(style_format_id_or_name, **kwargs)

Retrieve information of a style formats.

Parameters:

style_format_id_or_name – The id or name of a style format

lccs_ws.views.get_style_formats_classification_system(system_id_or_identifier, **kwargs)

Retrieve available style formats for a classification system.

Parameters:

system_id_or_identifier – The id or identifier of a source classification system

lccs_ws.views.get_styles_formats(**kwargs)

Retrieve available style formats in service.

lccs_ws.views.root(**kwargs)

URL Handler for Land User Cover Classification System through REST API.

lccs_ws.views.style_file(system_id_or_identifier, style_format_id_or_name, **kwargs)

Retrieve available styles.

Parameters:

• system_id_or_identifier – The id or identifier of a classification system

• style_format_id_or_name – The id or name of a style format

lccs_ws.views.style_format_search(style_format_name)

Return identifier of a style format.

Parameters:

style_format_name – name of a style format