Merge pull request #17 from GispoCoding/initial-feature-creation

Initial feature creation

Author: LKajan

.gitignore

@@ -1,7 +1,162 @@
-arho-feature-template/i18n
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
 venv/
-.venv/
-start_ide.bat
-.vscode
-*/.pytest_cache
-__pycache__
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

.pre-commit-config.yaml

@@ -12,6 +12,7 @@ repos:
     rev: v1.11.2
     hooks:
       - id: mypy
+        additional_dependencies: ["types-PyYAML"]
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.6.5
     hooks:

.qgis-plugin-ci

@@ -13,28 +13,38 @@ Create a virtual environment activate it and install needed dependencies with th
 ```console
 python create_qgis_venv.py
 .venv\Scripts\activate # On Linux and macOS run `source .venv\bin\activate`
-pip install -r requirements-dev.txt
+pip install -r requirements-dev.txt -r requirements-test.txt
 ```
 
 For more detailed development instructions see [development](docs/development.md).
 
 ### Testing the plugin on QGIS
 
-A symbolic link / directory junction should be made to the directory containing the installed plugins pointing to the dev plugin package.
+A symbolic link / directory junction should be created to the directory containing the installed plugins pointing to the dev plugin package.
+
+It is recomennded also to use a specifig QGIS profile for development.
 
 On Windows Command promt
 ```console
-mklink /J %AppData%\QGIS\QGIS3\profiles\default\python\plugins\arho_feature_template .\arho_feature_template
+set QGIS_PROFILE=arho-dev
+mkdir -p %AppData%\QGIS\QGIS3\profiles\%QGIS_PROFILE%\python\plugins
+mklink /J %AppData%\QGIS\QGIS3\profiles\%QGIS_PROFILE%\python\plugins\arho_feature_template .\arho_feature_template
+C:\OSGeo4W\bin\qgis-ltr.bat --profile %QGIS_PROFILE%
 ```
 
 On Windows PowerShell
 ```console
-New-Item -ItemType SymbolicLink -Path ${env:APPDATA}\QGIS\QGIS3\profiles\default\python\plugins\arho_feature_template -Value ${pwd}\arho_feature_template
+$env:QGIS_PROFILE = "arho-dev"
+New-Item -ItemType Directory -Force ${env:APPDATA}\QGIS\QGIS3\profiles\${env:QGIS_PROFILE}\python\plugins
+New-Item -ItemType Junction -Path ${env:APPDATA}\QGIS\QGIS3\profiles\${env:QGIS_PROFILE}\python\plugins\arho_feature_template -Value ${pwd}\arho_feature_template
+C:\OSGeo4W\bin\qgis-ltr.bat --profile $env:QGIS_PROFILE
 ```
 
 On Linux
 ```console
-ln -s arho_feature_template/ ~/.local/share/QGIS/QGIS3/profiles/default/python/plugins/arho_feature_template
+export QGIS_PROFILE=arho-dev
+ln -s arho_feature_template/ ~/.local/share/QGIS/QGIS3/profiles/$QGIS_PROFILE/python/plugins/arho_feature_template
+qgis --profile $QGIS_PROFILE
 ```
 
 After that you should be able to enable the plugin in the QGIS Plugin Manager.

README.md

@@ -17,15 +17,29 @@
         "python.testing.pytestArgs": [
             "test"
         ],
-        "python.testing.unittestEnabled": false
+        "python.testing.unittestEnabled": false,
+        "json.schemas": [
+            {
+                "fileMatch": [
+                    "**/template_libraries/*.json"
+                ],
+                "url": "./arho_feature_template/resources/template_libraries/schema/template_library.schema.json"
+            }
+        ],
+        "yaml.schemas": {
+            "./arho_feature_template/resources/template_libraries/schema/template_library.schema.json": [
+                "**/template_libraries/*.yaml"
+            ]
+        }
     },
     "extensions": {
         "recommendations": [
             "ms-python.python",
             "ms-python.flake8",
             "ms-python.mypy-type-checker",
             "charliermarsh.ruff",
-            "editorconfig.editorconfig"
+            "editorconfig.editorconfig",
+            "redhat.vscode-yaml"
         ]
     },
     "launch": {