docs: improve development guide

.vscode/settings.json

@@ -14,7 +14,7 @@
         "editor.defaultFormatter": "ms-python.black-formatter",
         "editor.formatOnSave": true,
         "editor.codeActionsOnSave": {
-            "source.organizeImports": true
+            "source.organizeImports": "explicit"
         },
         "editor.rulers": [
             88

CONTRIBUTING.md

@@ -11,7 +11,7 @@ The CHANGELOG format tries to complies with [Keep a Changelog](https://keepachan
 
 ## Git hooks
 
-We use git hooks through [pre-commit](https://pre-commit.com/) to enforce and automatically check some "rules". Please install it before to push any commit.
+We use git hooks through [pre-commit](https://pre-commit.com/) to enforce and automatically check some "rules". Please install it before any commit: `pre-commit install`.
 
 See the relevant configuration file: `.pre-commit-config.yaml`.
 

docs/development/documentation.md

@@ -6,7 +6,7 @@ Project uses Sphinx to generate documentation from docstrings (documentation in-
 
 To build it:
 
-```bash
+```sh
 # install aditionnal dependencies
 python -m pip install -U -r requirements/documentation.txt
 # build it
@@ -19,7 +19,7 @@ Open `docs/_build/index.html` in a web browser.
 
 ## Write documentation using live render
 
-```bash
+```sh
 sphinx-autobuild -b html docs/ docs/_build
 ```
 

docs/development/testing.md

@@ -1,11 +1,36 @@
 # Tests
 
+The project aims to be fully tested on every targetted platform through intensive CI/CD on every Pull Request.
+
+Still, it's preferable to run tests locally before pushing to the public remote repository.
+
+## Structure
+
+- tests are located in the `tests` subfolder
+- a test file is prefixed with `test_`
+- ideally a test is written using the standard library, so as a "pure" unittest class, even if for some needs the pytest framework can be used.
+- quick tests scripts can be stored in `tests/dev` folder to illustrate or check a behavior
+
 ## Requirements
 
-To run the tests, you need to install development requirements ([Ubuntu](ubuntu) or [Windows](windows)).
+To run the tests, you need to install development requirements ([Ubuntu](./ubuntu.md#develop-on-ubuntu) or [Windows](./windows.md#develop-on-windows)).
+
+Complete it by installing tests requirements:
+
+```sh
+python -m pip install -U -r requirements/testing.txt
+```
 
 ## Run
 
-```bash
+Simply run Pytest:
+
+```sh
 pytest
 ```
+
+It's also possible to run an individual test:
+
+```sh
+python -m unittest tests.test_qplugin_object.TestQgisPluginObject.test_profile_load_from_json_basic
+```

docs/development/ubuntu.md

@@ -3,47 +3,54 @@
 Tested on:
 
 - Ubuntu 20.04
+- Ubuntu 22.04
 
 ## Install Python and Git
 
 Install system requirements:
 
-```bash
+```sh
 sudo apt install git python3-pip python3-virtualenv python3-venv virtualenv
 ```
 
 Clone the repository where you want:
 
-```bash
+```sh
 git clone https://github.com/Guts/qgis-deployment-cli.git
 # or using ssh
 git clone git@github.com:Guts/qgis-deployment-cli.git
 ```
 
 Create and enter virtual environment (change the path at your convenience):
 
-```bash
+```sh
 python3 -m venv .venv
 source .venv/bin/activate
 ```
 
 ## Install project requirements
 
-```bash
+```sh
 python -m pip install -U pip setuptools wheel
 python -m pip install -U -r requirements/development.txt
 ```
 
+## Install git hooks
+
+```sh
+pre-commit install
+```
+
 ## Install project
 
-```bash
+```sh
 python -m pip install -e .
 ```
 
 Try it with:
 
-```bash
-qgis-deployment-toolbelt
+```sh
+qgis-deployment-toolbelt --help
 ```
 
 Happy coding!

docs/development/windows.md

@@ -6,15 +6,15 @@ Tested on:
 
 ## Requirements
 
-- [Python 3.10+ installed with the Windows MSI installer](https://www.python.org/downloads/windows/) (version from the Windows store is not working)
+- [Python 3.10+ installed with the Windows MSI installer](https://www.python.org/downloads/windows/) (version from the Windows store is not working with virtual environments)
 - [Git](https://git-scm.com/download/win) and/or [GitHub Desktop](https://desktop.github.com/)
 
 ## Enable remote scripts (for virtual environment)
 
 Open a Powershell prompt as **administrator** inside the repository folder:
 
 ```powershell
-# if not already done, enable scripts  - required by virtualenv
+# if not already done, enable scripts - required by virtualenv
 Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
 ```
 
@@ -44,9 +44,24 @@ python -m pip install -U pip setuptools wheel
 
 # install dependencies
 python -m pip install -U -r requirements/development.txt
+```
+
+## Install git hooks
+
+```sh
+pre-commit install
+```
 
-# finally, install the package in editable mode
+## Install project
+
+```sh
 python -m pip install -e .
 ```
 
+Try it with:
+
+```sh
+qgis-deployment-toolbelt --help
+```
+
 Happy coding!

docs/guides/howto_qgis_get_plugin_id.md

@@ -1,18 +1,18 @@
 # How to get a plugin ID
 
-## Method 1 :
+## Method 1
 
 1. Open the repository in your browser. Example for the official set on QGIS 3.28: <https://plugins.qgis.org/plugins/plugins.xml?qgis=3.28>
 1. Open the RAW mode (or source), typing `Ctrl + U` or right-click and  select `View page source`
 1. Use your browser search `Ctrl + F` to look for the plugin you want
 1. Grab the `plugin_id` attribute:
 
-  ![Plugin ID into official repository - Example QuickOSM](/static/repository_plugins_plugin_id.webp)
+  ![Plugin ID into official repository - Example QuickOSM](../static/repository_plugins_plugin_id.webp)
 
-## Method 2 :
+## Method 2
 
 1. Search for the plugin on QGIS plugin search page. Example for the official set on QGIS 3.28: <https://plugins.qgis.org/search>
 2. Identify the plugin you want in the search results list
 3. The plugin ID is the number between brackets at the left of the plugin name
 
-  ![Plugin ID into plugin search page - Example Franch Locator Filter](/static/plugin_search.png)
+  ![Plugin ID into plugin search page - Example Franch Locator Filter](../static/plugin_search.png)

docs/guides/howto_windows_sign_executable.md

@@ -1,4 +1,4 @@
-# How to: Sign the executable
+# How to sign the executable on Windows
 
 ## Self-signed certificate
 
@@ -63,4 +63,4 @@ Requirements:
 
 Opening the properties of the executable, the related tab should look like this:
 
-![QGIS Deployment Toolbelt - Properties security](/static/executable_windows_properties_signed.png)
+![QGIS Deployment Toolbelt - Properties security](/..static/executable_windows_properties_signed.png)