refact: move to src layout

Because the design of the tests requires them to import `tests.common.py`,
the tests folder must be a package, necessitating an `__init__.py` module
at its root. As a result of this configuration, pytest, by default,
makes the source package importable, which masks the package installed
in the virtual environment. This behavior prevents testing wheels.

The [documentation of pytest](https://docs.pytest.org/en/6.2.x/goodpractices.html#src-layout)
therefore recommends to use the `src-layout`.

Author: PhML

Makefile

@@ -110,7 +110,7 @@ format: install format/black  ## run black formatting (depends install)
 .PHONY: format/black
 format/black: install  ## run black formatting (depends install) (source venv before)
 	@echo "+ $@"
-	@${PANDORA_VENV}/bin/black pandora tests ./*.py notebooks/snippets/*.py
+	@${PANDORA_VENV}/bin/black src/pandora tests ./*.py notebooks/snippets/*.py
 
 ### Check code quality and linting : black, mypy, pylint
 
@@ -120,17 +120,17 @@ lint: install lint/black lint/mypy lint/pylint ## check code quality and linting
 .PHONY: lint/black
 lint/black: ## check global style with black
 	@echo "+ $@"
-	@${PANDORA_VENV}/bin/black --check pandora tests ./*.py notebooks/snippets/*.py
+	@${PANDORA_VENV}/bin/black --check src/pandora tests ./*.py notebooks/snippets/*.py
 
 .PHONY: lint/mypy
 lint/mypy: ## check linting with mypy
 	@echo "+ $@"
-	@${PANDORA_VENV}/bin/mypy pandora tests
+	@${PANDORA_VENV}/bin/mypy src/pandora tests
 
 .PHONY: lint/pylint
 lint/pylint: ## check linting with pylint
 	@echo "+ $@"
-	@set -o pipefail; ${PANDORA_VENV}/bin/pylint pandora tests --rcfile=.pylintrc --output-format=parseable --msg-template="{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}" # | tee pylint-report.txt # pipefail to propagate pylint exit code in bash
+	@set -o pipefail; ${PANDORA_VENV}/bin/pylint src/pandora tests --rcfile=.pylintrc --output-format=parseable --msg-template="{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}" # | tee pylint-report.txt # pipefail to propagate pylint exit code in bash
 
 ## Documentation section
 

docs/source/conf.py

@@ -34,7 +34,7 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath("../pandora"))
+sys.path.insert(0, os.path.abspath("../src/pandora"))
 
 # Extend Recursion limit for RecursionError in big files (bug astroid)
 sys.setrecursionlimit(8 * sys.getrecursionlimit())
@@ -70,7 +70,7 @@
 imgmath_embed = True
 
 # Autoapi configuration
-autoapi_dirs = ["../../pandora"]
+autoapi_dirs = ["../../src/pandora"]
 autoapi_root = "api_reference"
 autoapi_keep_files = True
 autoapi_options = [

meson.build

@@ -19,22 +19,22 @@ doctest_dep = dependency('doctest', required: get_option('build_cpp_tests'))
 python_dep = py.dependency(embed: true, required: get_option('build_cpp_tests'))
 
 install_subdir(
-    'pandora',
+    'src/pandora',
     install_dir: py.get_install_dir() / 'pandora',
     strip_directory: true,
 )
 
-subdir('pandora/cpp')
+subdir('src/pandora/cpp')
 
-subdir('pandora/validation/cpp')
+subdir('src/pandora/validation/cpp')
 
-subdir('pandora/aggregation/cpp')
+subdir('src/pandora/aggregation/cpp')
 
-subdir('pandora/cost_volume_confidence/cpp')
+subdir('src/pandora/cost_volume_confidence/cpp')
 
-subdir('pandora/refinement/cpp')
+subdir('src/pandora/refinement/cpp')
 
-subdir('pandora/matching_cost/cpp')
+subdir('src/pandora/matching_cost/cpp')
 
 if get_option('build_cpp_tests').enabled()
     subdir('tests/test_cpp/')

sonar-project.properties

@@ -6,7 +6,7 @@ sonar.projectName=Pandora
 sonar.projectVersion=0.1
 
 # path to source directories (required)
-sonar.sources=pandora
+sonar.sources=src/pandora
 
 # path to test source directories (optional)
 sonar.tests=tests