Developement

Installing Development Version

• On Windows

git clone https://github.com/afe-oliveira/raster-forge
cd raster-forge
python -m venv env
. env\Scripts\activate
pip install -e .[dev]

• Other OS

git clone https://github.com/afe-oliveira/raster-forge
cd raster-forge
python -m venv env
source env/bin/activate
pip install -e .[dev]

Run Tests

The project utilizes the PyTest testing architecture. To run the tests, execute the following command:

pytest

If you want to generate a code coverage report, execute the command:

pytest --cov=parshift --cov-report=html

After, navigate to htmlcov/index.html and open the generated HTML report in your preferred web browser. This will provide you with a detailed overview of the coverage analysis in a user-friendly format.

Building Documentation

In the raster-forge project folder, execute the command:

sphinx-build docs docs/_build

The generated documentation will be placed in docs/_build.

Code Styling

Raster Forge source code follows the Black style.