Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# IB-Tool (Partitioning) — QGIS Plugin

[![CI](https://github.com/IB-Tool/ibtoolpartion/actions/workflows/ci.yml/badge.svg)](https://github.com/IB-Tool/ibtoolpartion/actions/workflows/ci.yml)
[![QGIS Plugin CI](https://github.com/IB-Tool/ibtoolpartion/actions/workflows/qgis-plugin-ci.yml/badge.svg)](https://github.com/IB-Tool/ibtoolpartion/actions/workflows/qgis-plugin-ci.yml)
[![CI](https://github.com/IB-Tool/Partitioning/actions/workflows/ci.yml/badge.svg)](https://github.com/IB-Tool/Partitioning/actions/workflows/ci.yml)
[![QGIS Plugin CI](https://github.com/IB-Tool/Partitioning/actions/workflows/qgis-plugin-ci.yml/badge.svg)](https://github.com/IB-Tool/Partitioning/actions/workflows/qgis-plugin-ci.yml)
[![License: GPL-2.0-or-later](https://img.shields.io/badge/License-GPL--2.0--or--later-blue.svg)](LICENSE)

A QGIS plugin that delineates settlement boundaries by partitioning spatial datasets based on building footprints.

This is a companion plugin to **[IBTool](https://github.com/IB-Tool/IB-Tool-3)**:
its output (a `PART_<id>` polygon layer) is the **Partitions** input IBTool
expects — see IBTool's
This is a companion plugin to **[IB-Tool 3](https://github.com/IB-Tool/IB-Tool-3)**:
its output (a `PART_<id>` polygon layer) is the **Partitions** input IB-Tool 3
expects — see IB-Tool 3's
[`docs/input-data.md` → Part](https://github.com/IB-Tool/IB-Tool-3/blob/master/docs/input-data.md#part--partitioning)
and
[`docs/quickstart.md`](https://github.com/IB-Tool/IB-Tool-3/blob/master/docs/quickstart.md)
for how it fits into IBTool's own workflow.
for how it fits into IB-Tool 3's own workflow.

---

Expand Down
2 changes: 1 addition & 1 deletion ai/core/architecture-guidelines.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Architecture Guidelines

Guidelines for architectural decisions in the IBTool project.
Guidelines for architectural decisions in the IB-Tool 3 project.

## Parameter Management

Expand Down
2 changes: 1 addition & 1 deletion ai/core/constraints.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Constraints

Binding rules for all code changes in the IBTool project.
Binding rules for all code changes in the IB-Tool 3 project.

For release-specific constraints (metadata.txt, LICENSE, ZIP packaging, CI),
see [release-conventions.md](release-conventions.md).
Expand Down
4 changes: 2 additions & 2 deletions ai/core/release-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
These rules are binding for all code changes. They are referenced from
`CLAUDE.md` and `ai/core/constraints.md`.

Mirrors IBTool's own `ai/core/release-conventions.md` (the canonical version,
see [IB-Tool-3](https://github.com/IB-Tool/IB-Tool-3/blob/master/ai/core/release-conventions.md)),
Mirrors IB-Tool 3's own `ai/core/release-conventions.md` (the canonical version,
see [IB-Tool 3](https://github.com/IB-Tool/IB-Tool-3/blob/master/ai/core/release-conventions.md)),
adapted for this plugin's folder name and repository.

---
Expand Down
2 changes: 1 addition & 1 deletion ai/tasks/bugfix-task.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Purpose

Template for bug fixes in the IBTool project. Goal: minimal, targeted changes to resolve the reported issue.
Template for bug fixes in the IB-Tool 3 project. Goal: minimal, targeted changes to resolve the reported issue.

## Scope

Expand Down
2 changes: 1 addition & 1 deletion ai/tasks/new-feature-task.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Purpose

Template for implementing new functionality in the IBTool project. Goal: clean integration without affecting existing functionality.
Template for implementing new functionality in the IB-Tool 3 project. Goal: clean integration without affecting existing functionality.

## Scope

Expand Down
2 changes: 1 addition & 1 deletion ai/tasks/refactor-task.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Purpose

Template for structural improvements in the IBTool project. Goal: better code structure without changing business logic.
Template for structural improvements in the IB-Tool 3 project. Goal: better code structure without changing business logic.

## Scope

Expand Down
6 changes: 3 additions & 3 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added
- `Dockerfile` for Docker-based test execution (previously referenced by `ci.yml`/`docs/contributing.md` but missing).
- `scripts/create_release_zip.py` — release ZIP builder, mirroring IBTool's own script.
- Cross-links to IBTool's documentation (README, `docs/contributing.md`) describing this plugin's role as IBTool's Partitions input provider.
- `scripts/create_release_zip.py` — release ZIP builder, mirroring IB-Tool 3's own script.
- Cross-links to IB-Tool 3's documentation (README, `docs/contributing.md`) describing this plugin's role as IB-Tool 3's Partitions input provider.

### Fixed
- `metadata.txt`: replaced placeholder `tracker`/`repository`/`homepage` URLs (`http://bugs`, `http://repo`, `http://homepage`) with the actual repository URLs; removed a stray unescaped line that was silently parsed as a bogus `category of the plugin` key; added a `changelog` entry (previously commented out).
- `README.md`: removed incorrect reference to a non-existent `Test_data/LICENSE.txt`; removed stale `Test_data/.*` exclude pattern from `detect-secrets` examples (no such directory exists in this repo).
- `.github/workflows/ci.yml`: removed the "Dockerfile missing, see IB-Tool-3" comment now that a `Dockerfile` exists here.
- `.github/workflows/ci.yml`: removed the "Dockerfile missing, see IB-Tool 3" comment now that a `Dockerfile` exists here.

---

Expand Down
10 changes: 5 additions & 5 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

This document covers the development setup, CI/CD pipeline, test structure, and code quality tooling for IB-Tool (Partitioning).

This plugin is a companion to **[IBTool](https://github.com/IB-Tool/IB-Tool-3)**
This plugin is a companion to **[IB-Tool 3](https://github.com/IB-Tool/IB-Tool-3)**
(the main plugin) and follows the same development conventions. For the
canonical description of the CI/test/release approach shared by all three
IB-Tool plugins, see
[IBTool's own `docs/contributing.md`](https://github.com/IB-Tool/IB-Tool-3/blob/master/docs/contributing.md).
[IB-Tool 3's own `docs/contributing.md`](https://github.com/IB-Tool/IB-Tool-3/blob/master/docs/contributing.md).
This document only covers what differs here.

---
Expand Down Expand Up @@ -34,7 +34,7 @@ Steps:
5. Uploads the coverage report to Codecov

See `.github/workflows/ci.yml` and `Dockerfile` for the full definitions. The
image is a slimmed-down variant of IBTool's own `Dockerfile` — this plugin
image is a slimmed-down variant of IB-Tool 3's own `Dockerfile` — this plugin
has no runtime dependencies beyond QGIS's own processing algorithms, so
`numpy`/`scipy`/`networkx` are not installed.

Expand Down Expand Up @@ -79,9 +79,9 @@ detect-secrets scan --force-use-all-plugins

## Release Process

Releases are built with `scripts/create_release_zip.py`, mirroring IBTool's
Releases are built with `scripts/create_release_zip.py`, mirroring IB-Tool 3's
own release process (see
[IBTool's `docs/contributing.md` → Release Process](https://github.com/IB-Tool/IB-Tool-3/blob/master/docs/contributing.md)
[IB-Tool 3's `docs/contributing.md` → Release Process](https://github.com/IB-Tool/IB-Tool-3/blob/master/docs/contributing.md)
for the full rationale). There is no automated GitHub release workflow —
the ZIP is built and uploaded to GitHub Releases manually:

Expand Down
6 changes: 3 additions & 3 deletions metadata.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ email=ottmar.hittzfeld@web.de

about=This tool generates a partition of the dataset based on building footprints.

tracker=https://github.com/IB-Tool/ibtoolpartion/issues
repository=https://github.com/IB-Tool/ibtoolpartion
tracker=https://github.com/IB-Tool/Partitioning/issues
repository=https://github.com/IB-Tool/Partitioning
license=GPL-2.0-or-later
# End of mandatory metadata

Expand All @@ -25,7 +25,7 @@ changelog=0.1.0 - Initial release: KDE/Voronoi-based settlement partitioning.
# Tags are comma separated with spaces allowed
tags=python, settlement, partitioning, voronoi, kde, geodata, vector

homepage=https://github.com/IB-Tool/ibtoolpartion
homepage=https://github.com/IB-Tool/Partitioning
category=Vector
icon=icon.png
# experimental flag
Expand Down
Loading