QGIS Minimum Version: 3.22
This plugins is a project that integrates different platforms to access from QGIS and one can collaborate, either on Bugs or Pull Requests.
As a first point, it is important to be able to configure the development environment, which we will describe below:
`sudo apt install qtcreator pyqt5-dev-tools`
`sudo apt install python3-pyqt5`
`sudo apt install qttools5-dev-tools`
`sudo apt install qttools5-dev`
To collaborate on this QGIS plugin project, please follow these steps:
Clone the project repository:
git clone https://github.com/Kan-T-IT/QGIS-KICa.git
Navigate to the project directory:
cd qgis-imagery-catalogue
Create a Python virtual environment:
python3 -m venv env
Activate the virtual environment:
source env/bin/activate
Install the project dependencies from the requirements.txt
file:
pip install -r requirements.txt
Update the path to the QGIS plugin directory (the destination for the compiled plugin):
Settings/User Profiles/Open Active Profile Folder
.python/plugins
folder.Update this path in two specific locations:
deploy.sh
file, modify the PLUGIN_DIR variable.src/pb_tool.cfg
file, update the plugin_path key.The deploy.sh
script automates the necessary tasks to generate the plugin files, including:
Important: Ensure that the deploy.sh
script has execution permissions. If not, assign them using the following command:
chmod +x deploy.sh
To update the project's code documentation, perform the following steps from the project's root directory:
Generate the documentation:
make docs
If you wish to force a recompilation of the documentation, use the following command:
make -B docs
Important: When updating the documentation, it is recommended to also run the deploy.sh
script to ensure that the PDF file in the project's root is updated.
To access the documentation in HTML format, follow these steps:
Start an HTTP server from the project's root directory:
python3 -m http.server 8000 -d docs/build/html/
Open your web browser and navigate to the following address:
http://127.0.0.1:8000