brazil-data-cube/lccs.py

Python Client Library for Land Cover Classification System Web Service

Python Client Library for Land Cover Classification System Web Service

About

Currently, there are several data sets on regional, national and global scales with information on land use and land cover that aim to support a large number of applications, including the management of natural resources, climate change and its impacts, and biodiversity conservation. These data products are generated using different approaches and methodologies, which present information about different classes of the earth's surface, such as forests, agricultural plantations, among others. Initiatives that generate land use and land cover maps normally develop their own classification system, with different nomenclatures and meanings of the classes used.

In this context, the LCCS-WS (Land Cover Classification System Web Service) aims to provide a simple interface to access the various classification systems in use and their respective classes. Therefore, this service proposes a representation for the classification systems and provides an API to access the classes and their symbolizations. It is also possible to stablish mappings between classes of different systems.

If you want to know more about LCCS service, please, take a look at its specification.

Installation

See INSTALL.rst.

Developer Documentation

See https://lccs.readthedocs.io/en/latest/.

License

Copyright (C) 2023 INPE.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

lccs.py's Issues

Improve documentation

Include support for CRUD operations

Update to lccs-ws specification version 0.6

JSONSchema validation of service response

add version in command line

create a dynamic enum based on supported languages

Release version 0.8.0

Tasks:

• Inform the right version in: lccs/version.py
• Run all the tests.
• Create a branch named: b-0.8.
• From the branch b-0.8, create a tag named: v-0.8.0.
• In the master branch increase version in lccs/version.py to 1.0.0
• Notify users that a new version is released.

Change sphinx template

• Based in cookiecutter-bdc.
• Move doc/sphinx to docs/sphinx

add drone integration

Document how to run the LCCS client in the command Line

Release version 0.2.0

Tasks:

• Inform the right version in: lccs/version.py
• Run all the tests.
• Create a branch named: b-0.2.
• From the branch b-0.2, create a tag named: v-0.2.0.
• In the master branch increase version in lccs/version.py to 0.4.0
• Notify users that a new version is released.

Change license to GPLv3

Improve unit-tests

Prepare the Python package support

Prepare the codebase for using readthedocs

Prepare the codebase for using coveralls.io

Release version 0.4.0

Tasks:

• Inform the right version in: lccs/version.py
• Run all the tests.
• Create a branch named: b-0.4.
• From the branch b-0.4, create a tag named: v-0.4.0.
• In the master branch increase version in lccs/version.py to 0.6.0
• Notify users that a new version is released.

Add command line interface

Release version 0.6.0

Tasks:

• Inform the right version in: lccs/version.py
• Run all the tests.
• Create a branch named: b-0.6.
• From the branch b-0.6, create a tag named: v-0.6.0.
• In the master branch increase version in lccs/version.py to 0.8.0
• Notify users that a new version is released.

fixing tests

add support for lccs-ws 0.8.0

• add internacionalization
• review links
• review jupyter template

Add _repr_html_

Remove jupyter notebooks

Move Jupyter Notebooks to Brazil Data Cube Jupyter Notebooks Gallery

Add Travis CI configuration

update lxml dependence

Add documentation system based on Sphinx

Upgrade Python version

The Python 3.7 was deprecated. Consider to upgrade this to 3.8 or even the 3.11

Improve the command line interface

Bug in client when no access token is provided

There is a bug in lccs.py when a request is made to LCCS Server without property access_token.

curl https://path/to/lccs/classification_systems?access_token=token_e

    return self.svc.lccs_ws.get_system_classification()
  File "/terra_collect/terra_collect/services/lccs_ws.py", line 51, in get_system_classification
    systems = lccs_service.classification_systems
  File "/usr/local/lib/python3.7/site-packages/lccs/lccs.py", line 90, in classification_systems
    return self._get_classification_systems()
  File "/usr/local/lib/python3.7/site-packages/lccs/lccs.py", line 61, in _get_classification_systems
    data = Utils._get(url)
  File "/usr/local/lib/python3.7/site-packages/lccs/utils.py", line 40, in _get
    response.raise_for_status()
  File "/usr/local/lib/python3.7/site-packages/requests/models.py", line 1021, in raise_for_status
    raise HTTPError(http_error_msg, response=self)
requests.exceptions.HTTPError: 404 Client Error: NOT FOUND for url: http://dev-lccs-ws:5000/classification_systems&language=pt-br

The error occurs due wrong usage of URI and parameters in request session.

For example:

lccs.py/lccs/lccs.py

Line 35 in 2f9b2bc

self._access_token = f'?access_token={access_token}' if access_token else ''

and here

lccs.py/lccs/lccs.py

Line 60 in 2f9b2bc

url = f'{self._url}/classification_systems{self._access_token}{self._language}'

You should use something like this

params = {"language": "pt-br"}
if self.access_token:
    params["access_token"] = self.access_token

session.get(SERVICE_RESOURCE_URL, params=params)

DO NOT manually concat these parameters in URL

add support for another way to send file

• the user can also send a string that presents the style and full name of the file (along with the extension)

Document how to install the package

Add example for Jupyter