qgis-plugin-dev-tools 0.8.0__tar.gz → 0.9.1__tar.gz

{qgis_plugin_dev_tools-0.8.0 → qgis_plugin_dev_tools-0.9.1}/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.9.1] - 2025-01-08
+
+- Fix: Fix license copying
+
+## [0.9.0] - 2025-01-08
+
+- Feat: Copy license into the plugin zip while deploying
+
 ## [0.8.0] - 2024-08-23
 
 - Feat: Add locale and ui ini options to be able to further customize development environment
@@ -77,3 +85,5 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 [0.6.2]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.6.2
 [0.7.0]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.7.0
 [0.8.0]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.8.0
+[0.9.0]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.9.0
+[0.9.1]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.9.1

{qgis_plugin_dev_tools-0.8.0/src/qgis_plugin_dev_tools.egg-info → qgis_plugin_dev_tools-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qgis-plugin-dev-tools
-Version: 0.8.0
+Version: 0.9.1
 Summary: QGIS plugin development and packaging tools, which make managing runtime dependencies easy.
 Home-page: https://github.com/nlsfi/qgis-plugin-dev-tools
 Author: National Land Survey of Finland
@@ -91,6 +91,14 @@ plugin_package_name = "your_plugin_package_name"
 version_number_source = "distribution"  # or "changelog" (default if missing)
 ```
 
+QGIS plugins are required to have a LICENSE file included in the plugin package. However, usually it is more convenient to keep the license file in the root of the repository. LICENSE can be copied automatically to the plugin zip while packaging if such file is found. A relative path to the license file can also be configured with `license_file_path` option.
+
+```toml
+[tool.qgis_plugin_dev_tools]
+plugin_package_name = "your_plugin_package_name"
+license_file_path = "docs/my-license.md"
+```
+
 ## Plugin packaging
 
 Run `qgis-plugin-dev-tools build` (short `qpdt b`) to package the plugin and any runtime dependencies to a standard QGIS plugin zip file, that can be installed and published.
@@ -167,6 +175,14 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.9.1] - 2025-01-08
+
+- Fix: Fix license copying
+
+## [0.9.0] - 2025-01-08
+
+- Feat: Copy license into the plugin zip while deploying
+
 ## [0.8.0] - 2024-08-23
 
 - Feat: Add locale and ui ini options to be able to further customize development environment
@@ -240,3 +256,5 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 [0.6.2]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.6.2
 [0.7.0]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.7.0
 [0.8.0]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.8.0
+[0.9.0]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.9.0
+[0.9.1]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.9.1

{qgis_plugin_dev_tools-0.8.0 → qgis_plugin_dev_tools-0.9.1}/README.md

@@ -61,6 +61,14 @@ plugin_package_name = "your_plugin_package_name"
 version_number_source = "distribution"  # or "changelog" (default if missing)
 ```
 
+QGIS plugins are required to have a LICENSE file included in the plugin package. However, usually it is more convenient to keep the license file in the root of the repository. LICENSE can be copied automatically to the plugin zip while packaging if such file is found. A relative path to the license file can also be configured with `license_file_path` option.
+
+```toml
+[tool.qgis_plugin_dev_tools]
+plugin_package_name = "your_plugin_package_name"
+license_file_path = "docs/my-license.md"
+```
+
 ## Plugin packaging
 
 Run `qgis-plugin-dev-tools build` (short `qpdt b`) to package the plugin and any runtime dependencies to a standard QGIS plugin zip file, that can be installed and published.

{qgis_plugin_dev_tools-0.8.0 → qgis_plugin_dev_tools-0.9.1}/src/qgis_plugin_dev_tools/__init__.py

@@ -20,7 +20,7 @@
 import logging
 import sys
 
-__version__ = "0.8.0"
+__version__ = "0.9.1"
 
 LOGGER = logging.getLogger(__name__)
 _handler = logging.StreamHandler(sys.stdout)

{qgis_plugin_dev_tools-0.8.0 → qgis_plugin_dev_tools-0.9.1}/src/qgis_plugin_dev_tools/build/__init__.py

@@ -35,6 +35,7 @@ from qgis_plugin_dev_tools.build.metadata import update_metadata_file
 from qgis_plugin_dev_tools.build.packaging import (
     copy_plugin_code,
     copy_runtime_requirements,
+    copy_license,
 )
 from qgis_plugin_dev_tools.config import DevToolsConfig, VersionNumberSource
 
@@ -84,6 +85,7 @@ def make_plugin_zip(
             changelog_contents,
         )
         copy_runtime_requirements(dev_tools_config, build_directory_path)
+        copy_license(dev_tools_config, build_directory_path)
 
         LOGGER.debug("creating built plugin zip file from build directory")
 

{qgis_plugin_dev_tools-0.8.0 → qgis_plugin_dev_tools-0.9.1}/src/qgis_plugin_dev_tools/build/packaging.py

@@ -20,6 +20,8 @@
 import logging
 import shutil
 import sys
+from typing import Generator, Optional
+
 from importlib_metadata import Distribution
 from pathlib import Path
 
@@ -133,6 +135,45 @@ def copy_runtime_requirements(
                 )
 
 
+def copy_license(dev_tools_config: DevToolsConfig, build_directory_path: Path) -> None:
+    plugin_build_path = build_directory_path / dev_tools_config.plugin_package_name
+    target_license_file = plugin_build_path / "LICENSE"
+    license_file = dev_tools_config.license_file_path
+    if license_file is not None:
+        if not license_file.exists():
+            LOGGER.error(
+                f"Configured license file "
+                f"{license_file} "
+                f"does not exist. Check the configuration."
+            )
+            return
+
+        if target_license_file.exists():
+            LOGGER.warning(
+                f"Overwriting existing license {target_license_file} "
+                f"with configured license {license_file}"
+            )
+        LOGGER.debug(f"Copying license file {license_file} to {build_directory_path}")
+        shutil.copy(license_file, target_license_file)
+        return
+
+    if target_license_file.exists():
+        LOGGER.debug(f"Existing license file {target_license_file} found.")
+        return
+
+    # Try finding the license
+    license_file = _find_existing_license_file(dev_tools_config.pyproject_path)
+    if not license_file:
+        LOGGER.warning(
+            "Cannot copy LICENSE file since it does not exist. "
+            "Configure valid LICENSE file with license_file_path in pyproject.toml"
+        )
+        return
+
+    LOGGER.debug(f"Copying license file {license_file} to {build_directory_path}")
+    shutil.copy(license_file, target_license_file)
+
+
 def _copy_distribution_files(
     distribution: Distribution,
     top_level_names: set[str],
@@ -190,3 +231,15 @@ def _copy_distribution_files(
             src=original_path,
             dst=new_path,
         )
+
+
+def _find_existing_license_file(search_path: Path) -> Optional[Path]:
+    def generate_license_candidates() -> Generator[Path, None, None]:
+        for base_name in ("LICENSE", "license"):
+            for extension in ("", ".md", ".MD"):
+                yield search_path / f"{base_name}{extension}"
+
+    for potential_path in generate_license_candidates():
+        if potential_path.exists():
+            return potential_path
+    return None

{qgis_plugin_dev_tools-0.8.0 → qgis_plugin_dev_tools-0.9.1}/src/qgis_plugin_dev_tools/config/__init__.py

@@ -21,6 +21,7 @@ from collections import ChainMap
 from enum import Enum, auto
 from importlib.util import find_spec
 from pathlib import Path
+from typing import Optional
 
 from importlib_metadata import Distribution, distribution
 from packaging.requirements import Requirement
@@ -42,6 +43,7 @@ class VersionNumberSource(Enum):
 
 
 class DevToolsConfig:
+    pyproject_path: Path
     plugin_package_name: str
     plugin_package_path: Path
     runtime_distributions: list[Distribution]
@@ -49,9 +51,11 @@ class DevToolsConfig:
     append_distributions_to_path: bool
     version_number_source: VersionNumberSource
     disabled_extra_plugins: list[str]
+    license_file_path: Optional[Path]
 
     def __init__(  # noqa: PLR0913
         self,
+        pyproject_path: Path,
         plugin_package_name: str,
         runtime_requires: list[str],
         changelog_file_path: Path,
@@ -59,6 +63,7 @@ class DevToolsConfig:
         auto_add_recursive_runtime_dependencies: bool,
         version_number_source: VersionNumberSource,
         disabled_extra_plugins: list[str],
+        license_file_path: Optional[Path],
     ) -> None:
         plugin_package_spec = find_spec(plugin_package_name)
         if plugin_package_spec is None or plugin_package_spec.origin is None:
@@ -66,6 +71,7 @@ class DevToolsConfig:
                 f"could not find {plugin_package_name=} in the current environment"
             )
 
+        self.pyproject_path = pyproject_path
         self.plugin_package_path = Path(plugin_package_spec.origin).parent
         self.plugin_package_name = plugin_package_name
         # TODO: check versions are satisfied?
@@ -77,6 +83,7 @@ class DevToolsConfig:
         self.version_number_source = version_number_source
         self.extra_runtime_distributions = []
         self.disabled_extra_plugins = disabled_extra_plugins
+        self.license_file_path = license_file_path
 
         if auto_add_recursive_runtime_dependencies:
             # Add the requirements of the distributions as well
@@ -98,6 +105,7 @@ class DevToolsConfig:
     def from_pyproject_config(pyproject_file_path: Path) -> "DevToolsConfig":
         pyproject_config = read_pyproject_config(pyproject_file_path)
         return DevToolsConfig(
+            pyproject_path=pyproject_file_path.parent,
             plugin_package_name=pyproject_config.plugin_package_name,
             runtime_requires=pyproject_config.runtime_requires,
             # TODO: allow setting path in pyproject file?
@@ -112,4 +120,8 @@ class DevToolsConfig:
                 pyproject_config.version_number_source
             ),
             disabled_extra_plugins=pyproject_config.disabled_extra_plugins,
+            license_file_path=pyproject_file_path.parent
+            / pyproject_config.license_file_path
+            if pyproject_config.license_file_path
+            else None,
         )

{qgis_plugin_dev_tools-0.8.0 → qgis_plugin_dev_tools-0.9.1}/src/qgis_plugin_dev_tools/config/pyproject.py

@@ -20,7 +20,7 @@
 import logging
 from dataclasses import dataclass, field
 from pathlib import Path
-from typing import Literal, Union
+from typing import Literal, Optional, Union
 
 import tomli
 
@@ -43,6 +43,7 @@ class PyprojectConfig:
         Literal["changelog"], Literal["distribution"]
     ] = "changelog"
     disabled_extra_plugins: list[str] = field(default_factory=list)
+    license_file_path: Optional[str] = None
 
     def __post_init__(self) -> None:
         if self.version_number_source not in ["changelog", "distribution"]:

{qgis_plugin_dev_tools-0.8.0 → qgis_plugin_dev_tools-0.9.1/src/qgis_plugin_dev_tools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qgis-plugin-dev-tools
-Version: 0.8.0
+Version: 0.9.1
 Summary: QGIS plugin development and packaging tools, which make managing runtime dependencies easy.
 Home-page: https://github.com/nlsfi/qgis-plugin-dev-tools
 Author: National Land Survey of Finland
@@ -91,6 +91,14 @@ plugin_package_name = "your_plugin_package_name"
 version_number_source = "distribution"  # or "changelog" (default if missing)
 ```
 
+QGIS plugins are required to have a LICENSE file included in the plugin package. However, usually it is more convenient to keep the license file in the root of the repository. LICENSE can be copied automatically to the plugin zip while packaging if such file is found. A relative path to the license file can also be configured with `license_file_path` option.
+
+```toml
+[tool.qgis_plugin_dev_tools]
+plugin_package_name = "your_plugin_package_name"
+license_file_path = "docs/my-license.md"
+```
+
 ## Plugin packaging
 
 Run `qgis-plugin-dev-tools build` (short `qpdt b`) to package the plugin and any runtime dependencies to a standard QGIS plugin zip file, that can be installed and published.
@@ -167,6 +175,14 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.9.1] - 2025-01-08
+
+- Fix: Fix license copying
+
+## [0.9.0] - 2025-01-08
+
+- Feat: Copy license into the plugin zip while deploying
+
 ## [0.8.0] - 2024-08-23
 
 - Feat: Add locale and ui ini options to be able to further customize development environment
@@ -240,3 +256,5 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 [0.6.2]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.6.2
 [0.7.0]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.7.0
 [0.8.0]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.8.0
+[0.9.0]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.9.0
+[0.9.1]: https://github.com/nlsfi/qgis-plugin-dev-tools/releases/tag/v0.9.1

{qgis_plugin_dev_tools-0.8.0 → qgis_plugin_dev_tools-0.9.1}/test/test_build.py

@@ -5,7 +5,7 @@ import zipfile
 from pathlib import Path
 
 import pytest
-from qgis_plugin_dev_tools.build import make_plugin_zip
+from qgis_plugin_dev_tools.build import copy_license, make_plugin_zip
 from qgis_plugin_dev_tools.config import DevToolsConfig, VersionNumberSource
 
 
@@ -49,6 +49,9 @@ def plugin_dir(tmp_path: Path) -> Path:
     main_file = plugin_dir / "__init__.py"
     main_file.touch()
 
+    license_file = tmp_path / "LICENSE"
+    license_file.touch()
+
     os.chdir(tmp_path.resolve())
     sys.path.append(tmp_path.resolve().as_posix())
 
@@ -56,10 +59,11 @@ def plugin_dir(tmp_path: Path) -> Path:
 
 
 @pytest.fixture()
-def dev_tools_config(plugin_dir: Path) -> DevToolsConfig:
+def dev_tools_config(tmp_path: Path, plugin_dir: Path) -> DevToolsConfig:
     from qgis_plugin_dev_tools.config import DevToolsConfig
 
     return DevToolsConfig(
+        pyproject_path=tmp_path,
         plugin_package_name="Plugin",
         runtime_requires=["pytest"],
         changelog_file_path=plugin_dir / "CHANGELOG.md",
@@ -67,14 +71,18 @@ def dev_tools_config(plugin_dir: Path) -> DevToolsConfig:
         auto_add_recursive_runtime_dependencies=True,
         version_number_source=VersionNumberSource.CHANGELOG,
         disabled_extra_plugins=[],
+        license_file_path=None,
     )
 
 
 @pytest.fixture()
-def dev_tools_config_with_duplicate_dependencies(plugin_dir: Path) -> DevToolsConfig:
+def dev_tools_config_with_duplicate_dependencies(
+    tmp_path: Path, plugin_dir: Path
+) -> DevToolsConfig:
     from qgis_plugin_dev_tools.config import DevToolsConfig
 
     return DevToolsConfig(
+        pyproject_path=tmp_path,
         plugin_package_name="Plugin",
         runtime_requires=["pytest-cov"],
         changelog_file_path=plugin_dir / "CHANGELOG.md",
@@ -82,15 +90,17 @@ def dev_tools_config_with_duplicate_dependencies(plugin_dir: Path) -> DevToolsCo
         auto_add_recursive_runtime_dependencies=True,
         version_number_source=VersionNumberSource.CHANGELOG,
         disabled_extra_plugins=[],
+        license_file_path=None,
     )
 
 
 @pytest.fixture()
-def dev_tools_config_minimal(plugin_dir: Path) -> DevToolsConfig:
+def dev_tools_config_minimal(tmp_path: Path, plugin_dir: Path) -> DevToolsConfig:
     # No python path append and not recursive deps
     from qgis_plugin_dev_tools.config import DevToolsConfig
 
     return DevToolsConfig(
+        pyproject_path=tmp_path,
         plugin_package_name="Plugin",
         runtime_requires=["pytest"],
         changelog_file_path=plugin_dir / "CHANGELOG.md",
@@ -98,6 +108,7 @@ def dev_tools_config_minimal(plugin_dir: Path) -> DevToolsConfig:
         auto_add_recursive_runtime_dependencies=False,
         version_number_source=VersionNumberSource.CHANGELOG,
         disabled_extra_plugins=[],
+        license_file_path=None,
     )
 
 
@@ -115,6 +126,8 @@ def test_make_zip(dev_tools_config: "DevToolsConfig", tmp_path: Path):
         expected_zip, "Plugin/_vendor/__init__.py"
     )
     vendor_files = _get_file_names(expected_zip, "Plugin/_vendor/")
+    plugin_files = _get_file_names(expected_zip, "Plugin/")
+    assert "LICENSE" in plugin_files
 
     assert "import Plugin._vendor" in plugin_init_file_contents
     assert "sys.path.append" in vendor_init_file_contents
@@ -225,6 +238,90 @@ def test_make_zip_with_minimal_config(
     }
 
 
+@pytest.mark.parametrize("licence_file_name", ["LICENSE", "license.md"])
+def test_make_zip_copies_license_from_custom_path(
+    dev_tools_config_minimal: "DevToolsConfig", tmp_path: Path, licence_file_name: str
+):
+    # Remove original
+    original_license = tmp_path / "LICENSE"
+    os.remove(original_license)
+
+    license_dir = tmp_path / "license"
+    license_dir.mkdir()
+    license_file = license_dir / licence_file_name
+    license_file.touch()
+    dev_tools_config_minimal.license_file_path = license_file
+    target_path = tmp_path / "dist"
+    expected_zip = target_path / "Plugin-test-version.zip"
+
+    make_plugin_zip(
+        dev_tools_config_minimal, target_path, override_plugin_version="test-version"
+    )
+
+    assert target_path.exists()
+    assert expected_zip.exists()
+    plugin_files = _get_file_names(expected_zip, "Plugin/")
+    assert "LICENSE" in plugin_files
+
+
+def test_make_zip_copies_license_with_different_name(
+    dev_tools_config_minimal: "DevToolsConfig",
+    tmp_path: Path,
+    plugin_dir: Path,
+):
+    # Remove original
+    original_license = tmp_path / "LICENSE"
+    os.remove(original_license)
+
+    license_file = tmp_path / "license.md"
+    license_file.touch()
+
+    copy_license(dev_tools_config_minimal, plugin_dir.parent)
+
+    assert (plugin_dir / "LICENSE").exists()
+
+
+def test_make_zip_does_not_create_license_if_it_does_not_exist(
+    dev_tools_config_minimal: "DevToolsConfig", tmp_path: Path
+):
+    # Remove original
+    original_license = tmp_path / "LICENSE"
+    os.remove(original_license)
+
+    target_path = tmp_path / "dist"
+    expected_zip = target_path / "Plugin-test-version.zip"
+
+    make_plugin_zip(
+        dev_tools_config_minimal, target_path, override_plugin_version="test-version"
+    )
+
+    assert target_path.exists()
+    assert expected_zip.exists()
+    plugin_files = _get_file_names(expected_zip, "Plugin/")
+    assert "LICENSE" not in plugin_files
+
+
+def test_make_zip_does_not_create_license_if_configured_one_does_not_exist(
+    dev_tools_config_minimal: "DevToolsConfig", tmp_path: Path
+):
+    dev_tools_config_minimal.license_file_path = tmp_path / "non-existing-license"
+
+    original_license = tmp_path / "LICENSE"
+    os.remove(original_license)
+
+    target_path = tmp_path / "dist"
+    expected_zip = target_path / "Plugin-test-version.zip"
+
+    make_plugin_zip(
+        dev_tools_config_minimal, target_path, override_plugin_version="test-version"
+    )
+
+    assert target_path.exists()
+    assert expected_zip.exists()
+    plugin_files = _get_file_names(expected_zip, "Plugin/")
+    assert "LICENSE" not in plugin_files
+
+
 def _get_file_names(zip_file: Path, prefix: str) -> set[str]:
     with zipfile.ZipFile(zip_file) as z:
         namelist = z.namelist()