diff --git a/.drone.yml b/.drone.yml deleted file mode 100644 index 6649ce2..0000000 --- a/.drone.yml +++ /dev/null @@ -1,52 +0,0 @@ -# -# This file is part of Python Client Library for the WLTS. -# Copyright (C) 2022 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. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . -# -kind: pipeline -name: wlts.py - -steps: -- name: build - image: python:3.7 - commands: - - pip install --upgrade pip - - pip install --upgrade setuptools - - pip install -e .[tests,docs] - - ./run-tests.sh - environment: - WLTS_SERVER_URL: http://brazildatacube.dpi.inpe.br/dev/wlts - -- name: coverage - image: plugins/codecov - settings: - files: - - coverage.xml - - .coverage - token: - from_secret: codecov_token - when: - event: - - push - -- name: discord-notify - image: brazildatacube/bdc-drone-discord - settings: - webhook: - from_secret: discord_webhook - when: - status: - - failure - - success \ No newline at end of file diff --git a/.readthedocs.yml b/.readthedocs.yml index 56b61ca..a19f7be 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -18,13 +18,18 @@ version: 2 +build: + os: ubuntu-22.04 + tools: + python: "3.11" + + sphinx: configuration: docs/sphinx/conf.py formats: [] python: - version: 3.7 install: - method: pip diff --git a/CLI.rst b/CLI.rst index 37be2cc..6bc5d85 100644 --- a/CLI.rst +++ b/CLI.rst @@ -1,6 +1,6 @@ .. This file is part of Python Client Library for WLTS. - Copyright (C) 2022 INPE. + 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 @@ -46,7 +46,7 @@ Retrieve the trajectory given a longitude and latitude:: --longitude -54.0 \ --start-date 2001 \ --end-date 2011 \ - --collections mapbiomas-v6 + --collections mapbiomas-v8 The above command will return a document as: @@ -54,17 +54,17 @@ The above command will return a document as: .. code-block:: shell trajectory: [ - {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2001'}, - {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2002'}, - {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2003'}, - {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2004'}, - {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2005'}, - {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2006'}, - {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2007'}, - {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2008'}, - {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2009'}, - {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2010'}, - {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2011'} + {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2001'}, + {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2002'}, + {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2003'}, + {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2004'}, + {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2005'}, + {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2006'}, + {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2007'}, + {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2008'}, + {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2009'}, + {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2010'}, + {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2011'} ] .. note:: diff --git a/INSTALL.rst b/INSTALL.rst index 540b2da..efa31db 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -1,6 +1,6 @@ .. This file is part of Python Client Library for WLTS. - Copyright (C) 2022 INPE. + 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 @@ -22,20 +22,8 @@ Installation ``wlts.py`` depends essentially on `Requests `_. Please, read the instructions below in order to install ``wlts.py``. -Production installation ------------------------ - -**Under Development!** - -.. Install from `PyPI `_: -.. -.. .. code-block:: shell -.. -.. $ pip3 install wlts.py - - -Development Installation - GitHub ---------------------------------- +Development Installation +------------------------ Clone the Software Repository:: @@ -52,6 +40,26 @@ Install in development mode:: pip3 install -e .[all] +.. note:: + + If you want to create a new *Python Virtual Environment*, please, follow this instruction: + + *1.* Create a new virtual environment linked to Python 3.11:: + + python3.11 -m venv venv + + + **2.** Activate the new environment:: + + source venv/bin/activate + + + **3.** Update pip and setuptools:: + + pip3 install --upgrade pip + + pip3 install --upgrade setuptools + Run the Tests +++++++++++++ @@ -64,7 +72,7 @@ Build the Documentation You can generate the documentation based on Sphinx with the following command:: - python setup.py build_sphinx + sphinx-build docs/sphinx docs/sphinx/_build/html The above command will generate the documentation in HTML and it will place it under:: diff --git a/README.rst b/README.rst index 1f950d6..43a3cd0 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ .. This file is part of Python Client Library for WLTS. - Copyright (C) 2022 INPE. + 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 @@ -21,17 +21,9 @@ Python Client Library for Web Land Trajectory Service ===================================================== .. image:: https://img.shields.io/badge/License-GPLv3-blue.svg - :target: https://github.com/brazil-data-cube/bdc-catalog/blob/master/LICENSE + :target: https://github.com/brazil-data-cube/wlts.py/blob/master/LICENSE :alt: Software License -.. image:: https://drone.dpi.inpe.br/api/badges/brazil-data-cube/wlts.py/status.svg - :target: https://drone.dpi.inpe.br/brazil-data-cube/wlts.py - :alt: Build Status - -.. image:: https://codecov.io/gh/brazil-data-cube/wlts.py/branch/master/graph/badge.svg?token=1R1NNI56JO - :target: https://codecov.io/gh/brazil-data-cube/wlts.py - :alt: Code Coverage Test - .. image:: https://readthedocs.org/projects/wlts/badge/?version=latest :target: https://wlts.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status @@ -95,7 +87,7 @@ License ======= .. admonition:: - Copyright (C) 2022 INPE. + 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 diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst index 48a7676..89bc2b2 100644 --- a/docs/sphinx/index.rst +++ b/docs/sphinx/index.rst @@ -27,9 +27,9 @@ Documentation :caption: Contents: installation - api cli examples + api repository history license