mirror of
https://github.com/ARUP-CAS/aiscr-qgis-amcr-viewer.git
synced 2026-10-11 13:27:33 +02:00
Compare commits
18
Commits
v2.1.1
...
222fe03bb8
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
222fe03bb8 | ||
|
|
236907b9df | ||
|
|
49fbd91cea | ||
|
|
62d9ebd6f0 | ||
|
|
2b783cd13b | ||
|
|
06036f2af0 | ||
|
|
8fa81394f2 | ||
|
|
1d5220ee61 | ||
|
|
70aba60d12 | ||
|
|
3591ac4c53 | ||
|
|
f4b1c39e6c | ||
|
|
bcb0bc2c86 | ||
|
|
39dac12bad | ||
|
|
b708930ca2 | ||
|
|
3f7839c818 | ||
|
|
9aba28317a | ||
|
|
048ffe4e2a | ||
|
|
d398d2cd1b |
No files matched your search
@@ -0,0 +1,171 @@
|
||||
name: Code Quality
|
||||
|
||||
# Pouští při každém PR tytéž kontroly, které se dosud dělaly ručně:
|
||||
#
|
||||
# * co spouští plugins.qgis.org při uploadu (bandit, detect-secrets,
|
||||
# flake8, analýza souborů) – https://plugins.qgis.org/docs/security-scanning
|
||||
# * oficiální kontrolu kompatibility s Qt6 (pyqgis4-checker)
|
||||
# * skutečné načtení pluginu v QGIS 3.44 (Qt5) i v QGIS 4 (Qt6)
|
||||
# * sestavení ZIPu, který si recenzent stáhne a nainstaluje přímo z PR
|
||||
#
|
||||
# CodeQL a GitGuardian běží zvlášť, nastavené na úrovni organizace –
|
||||
# tady se schválně neduplikují.
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
env:
|
||||
# Verze se drží napevno, aby se výsledek nezměnil sám od sebe. Výchozí
|
||||
# sada pravidel ruffu se mezi verzemi mění; povýšení je vědomý krok.
|
||||
BANDIT: bandit==1.9.4
|
||||
DETECT_SECRETS: detect-secrets==1.5.0
|
||||
FLAKE8: flake8==7.3.0
|
||||
RUFF: ruff==0.16.5
|
||||
|
||||
jobs:
|
||||
# --------------------------------------------------------------------
|
||||
# 1. Statické kontroly – běží první, protože trvají desítky sekund
|
||||
# --------------------------------------------------------------------
|
||||
lint:
|
||||
name: Lint a bezpečnost
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: '3.12'
|
||||
|
||||
- name: Install tools
|
||||
run: pip install "$BANDIT" "$DETECT_SECRETS" "$FLAKE8" "$RUFF"
|
||||
|
||||
# Hygiena repozitáře: BOM, přímé importy z PyQt5/PyQt6, spustitelná
|
||||
# práva a podezřelé typy souborů. Padá jako první, protože BOM
|
||||
# zneviditelní soubor pro kontrolu níž.
|
||||
- name: Source hygiene
|
||||
run: python3 tests/check_sources.py
|
||||
|
||||
# Blokující kontrola na plugins.qgis.org
|
||||
- name: Bandit
|
||||
run: bandit -r amcr_viewer/
|
||||
|
||||
# Blokující kontrola na plugins.qgis.org.
|
||||
# --all-files je podstatné: bez něj detect-secrets prohledá jen
|
||||
# soubory sledované gitem a nesledovaný soubor tiše přeskočí.
|
||||
- name: detect-secrets
|
||||
run: |
|
||||
detect-secrets scan --all-files amcr_viewer/ > vysledek.json
|
||||
python3 -c "
|
||||
import json, sys
|
||||
nalezy = json.load(open('vysledek.json'))['results']
|
||||
if nalezy:
|
||||
print(json.dumps(nalezy, indent=2))
|
||||
sys.exit(1)
|
||||
print('detect-secrets: bez nálezů')
|
||||
"
|
||||
|
||||
# Na plugins.qgis.org je informativní, tady blokuje – konfigurace
|
||||
# v amcr_viewer/.flake8 je stejná pro obě místa.
|
||||
- name: Flake8
|
||||
run: flake8 --config amcr_viewer/.flake8 amcr_viewer/
|
||||
|
||||
# Nad rámec plugins.qgis.org; konfigurace v pyproject.toml
|
||||
- name: Ruff
|
||||
run: ruff check .
|
||||
|
||||
# --------------------------------------------------------------------
|
||||
# 2. Kompatibilita s Qt6 – oficiální skript z QGISu
|
||||
# --------------------------------------------------------------------
|
||||
qt6:
|
||||
name: Kompatibilita s Qt6
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
# Pozor: skript končí kódem 0 i když něco najde, výsledek je jen
|
||||
# v logu. Prázdný log (samotná hlavička) znamená čisto.
|
||||
- name: pyqgis4-checker
|
||||
run: |
|
||||
docker run --rm --user "$(id -u):$(id -g)" \
|
||||
--workdir /workspace/ -v "$PWD:/workspace/" \
|
||||
ghcr.io/qgis/pyqgis4-checker:main-ubuntu \
|
||||
pyqt5_to_pyqt6.py --dry_run --logfile /workspace/pyqt6_checker.log .
|
||||
echo "--- pyqt6_checker.log ---"
|
||||
cat pyqt6_checker.log
|
||||
nalezu=$(grep -v '=== dry_run mode | Start Logs ===' pyqt6_checker.log | wc -l)
|
||||
if [ "$nalezu" -ne 0 ]; then
|
||||
echo "::error::pyqgis4-checker nahlásil nálezy, viz log výše"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# --------------------------------------------------------------------
|
||||
# 3. Načtení pluginu ve skutečném QGIS, v obou podporovaných verzích
|
||||
# --------------------------------------------------------------------
|
||||
qgis:
|
||||
name: Smoke test (QGIS ${{ matrix.qgis }})
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
# ltr = 3.44 na Qt5, stable = 4.x na Qt6. Tagy se posouvají
|
||||
# schválně: chceme vědět, že plugin drží krok s aktuálním QGISem.
|
||||
qgis: [ltr, stable]
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- name: Smoke test
|
||||
run: |
|
||||
docker run --rm -v "$PWD:/work:ro" -w /work \
|
||||
--user "$(id -u):$(id -g)" -e HOME=/tmp \
|
||||
"qgis/qgis:${{ matrix.qgis }}" python3 tests/smoke_test.py
|
||||
|
||||
# --------------------------------------------------------------------
|
||||
# 4. ZIP k instalaci – stejný postup jako v release_plugin.yml
|
||||
# --------------------------------------------------------------------
|
||||
package:
|
||||
name: Balíček pluginu
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- name: Zip plugin
|
||||
run: zip -r amcr_viewer.zip amcr_viewer -x "*.git*"
|
||||
|
||||
# Kontrola obsahu ZIPu. Config soubory pro scanner musí být uvnitř
|
||||
# vedle metadata.txt, jinak je plugins.qgis.org nenajde – a některé
|
||||
# nástroje skryté soubory tiše vynechávají.
|
||||
- name: Verify archive contents
|
||||
run: |
|
||||
unzip -l amcr_viewer.zip
|
||||
for soubor in amcr_viewer/metadata.txt amcr_viewer/__init__.py \
|
||||
amcr_viewer/.flake8; do
|
||||
unzip -l amcr_viewer.zip | grep -qF " $soubor" \
|
||||
|| { echo "::error::v ZIPu chybí $soubor"; exit 1; }
|
||||
done
|
||||
if unzip -l amcr_viewer.zip | grep -qE '\.git'; then
|
||||
echo "::error::v ZIPu jsou git soubory"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
with:
|
||||
name: amcr_viewer-plugin
|
||||
path: amcr_viewer.zip
|
||||
if-no-files-found: error
|
||||
@@ -0,0 +1,41 @@
|
||||
name: Release PR Checks
|
||||
|
||||
# Hlídá bump verze a changelog v okamžiku, kdy se release větev
|
||||
# version/vX.Y.Z slévá do main – tady poprvé jde skutečně o to, co se
|
||||
# vydá, a zapomenutý bump by se jinak dostal rovnou k tagu a releasu.
|
||||
#
|
||||
# Kontroly viz tests/check_version_bump.py: verze v metadata.txt musí jít
|
||||
# nahoru, první položka changelogu musí patřit nové verzi, CITATION.cff
|
||||
# musí mít stejnou verzi (a posunuté date-released) a název větve musí
|
||||
# odpovídat verzi, kterou nese.
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
version-bump:
|
||||
name: Kontrola verze a changelogu
|
||||
runs-on: ubuntu-latest
|
||||
if: startsWith(github.head_ref, 'version/')
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: '3.12'
|
||||
|
||||
- name: Verze a changelog
|
||||
run: |
|
||||
python3 tests/check_version_bump.py \
|
||||
"${{ github.event.pull_request.base.sha }}" \
|
||||
"${{ github.head_ref }}"
|
||||
@@ -83,6 +83,58 @@ Další pravidla:
|
||||
definice pole (`QgsField`), naplnění hodnoty z dokumentu, překlad hlavičky
|
||||
sloupce a export atributů.
|
||||
|
||||
### Kompatibilita s Qt6 / QGIS 4
|
||||
|
||||
Plugin cílí na QGIS 3.44 i na QGIS 4 (`qgisMaximumVersion=4.99.0`), tedy na
|
||||
Qt5 i Qt6 zároveň. **Tohle se drží rigorózně** – ne až před releasem, ale při
|
||||
každé změně kódu. Chování obou větví se liší tiše: pod Qt5 projde i to, co
|
||||
QGIS 4 odmítne, takže lokální „funguje mi to“ nic nedokazuje.
|
||||
|
||||
Závazná pravidla:
|
||||
|
||||
- **Nikdy neimportuj přímo z `PyQt5` ani z `PyQt6`.** Vždy přes shim
|
||||
`qgis.PyQt.*`. Ten mimo jiné pod Qt6 přetahuje `QAction`, `QActionGroup`
|
||||
a `QShortcut` z `QtGui`, takže import z `qgis.PyQt.QtWidgets` je správně.
|
||||
- **Enumy vždy plně kvalifikované (scoped).** `Qgis.MessageLevel.Info`, ne
|
||||
`Qgis.Info`; `QgsTask.Flag.CanCancel`, ne `QgsTask.CanCancel`;
|
||||
`QgsWkbTypes.GeometryType.PointGeometry`, ne `QgsWkbTypes.PointGeometry`.
|
||||
Totéž pro Qt: `Qt.CheckState.Checked`, `QDialogButtonBox.StandardButton.Ok`.
|
||||
Zkrácené tvary sice v QGIS 4.2 zatím fungují, ale oficiální kontrola je
|
||||
hlásí a do budoucna mizí.
|
||||
- **Zdrojové `.py` soubory ukládej bez BOM.** Kontrolní skript čte soubor
|
||||
jako UTF-8 bez `utf-8-sig` a na BOM spadne s
|
||||
`SyntaxError: invalid non-printable character U+FEFF`, takže se takový
|
||||
soubor **vůbec nezkontroluje**. (`codelists/heslar.csv` BOM mít smí, tam je
|
||||
kvůli Excelu.)
|
||||
- Nepoužívej API zrušená v Qt6: `exec_()`, `QRegExp`, `QDesktopWidget`,
|
||||
`QApplication.desktop()`, `Qt.MidButton`, `QFontMetrics.width()`,
|
||||
`setResizeMode`, atributy `AA_EnableHighDpiScaling` / `AA_UseHighDpiPixmaps`.
|
||||
- `supportsQt6=True` v `metadata.txt` **nepatří** – bylo zrušeno; o zařazení
|
||||
mezi „QGIS 4 Ready“ rozhoduje rozsah `qgisMinimumVersion` až
|
||||
`qgisMaximumVersion`.
|
||||
|
||||
Ověření před PR, který mění Python kód:
|
||||
|
||||
```sh
|
||||
# oficiální kontrola, kterou pouští i plugins.qgis.org (pyqgis4-checker)
|
||||
docker run --rm --pull always --user $(id -u):$(id -g) \
|
||||
--workdir /workspace/ -v "$(pwd):/workspace/" \
|
||||
ghcr.io/qgis/pyqgis4-checker:main-ubuntu \
|
||||
pyqt5_to_pyqt6.py --dry_run --logfile /workspace/pyqt6_checker.log .
|
||||
```
|
||||
|
||||
Prázdný log = čisté. Kontrola je na plugins.qgis.org informativní
|
||||
(neblokuje schválení), ale nález znamená, že plugin v QGIS 4 dříve nebo
|
||||
později přestane fungovat.
|
||||
|
||||
Když je po ruce QGIS 4 (např. flatpak `org.qgis.qgis`), ověř navíc, že se
|
||||
plugin pod Qt6 opravdu načte:
|
||||
|
||||
```sh
|
||||
flatpak run --command=sh org.qgis.qgis -c \
|
||||
'PYTHONPATH=/app/share/qgis/python python3 -c "import qgis.core"'
|
||||
```
|
||||
|
||||
## Verzování a release
|
||||
|
||||
- Verze pluginu žije v **`amcr_viewer/metadata.txt`** (`version=`).
|
||||
@@ -124,5 +176,57 @@ Další pravidla:
|
||||
|
||||
Plugin se testuje načtením do QGIS (Plugins → Manage and Install Plugins →
|
||||
Install from ZIP, nebo nasazením složky `amcr_viewer/` do adresáře pluginů
|
||||
QGIS). Automatizované testy zatím repozitář neobsahuje – změny ověřuj ručně
|
||||
v QGIS na podporované verzi.
|
||||
QGIS). **Ruční test v QGIS nic nenahrazuje** – automatické kontroly ověřují,
|
||||
že se plugin načte a že projde kontrolami kvality, ne že dělá správnou věc.
|
||||
|
||||
### Automatické kontroly
|
||||
|
||||
Workflow `.github/workflows/code_quality.yml` pouští při každém PR do `main`
|
||||
tohle:
|
||||
|
||||
| job | co dělá |
|
||||
|---|---|
|
||||
| **Lint a bezpečnost** | `check_sources.py`, bandit, detect-secrets, flake8, ruff |
|
||||
| **Kompatibilita s Qt6** | `pyqgis4-checker` v dockeru |
|
||||
| **Smoke test** | `smoke_test.py` v `qgis/qgis:ltr` i `qgis/qgis:stable` |
|
||||
| **Balíček pluginu** | sestaví ZIP, ověří obsah, přiloží jako artefakt |
|
||||
|
||||
Smoke test běží v obou podporovaných řadách: `ltr` je QGIS 3.44 na Qt5,
|
||||
`stable` je QGIS 4.x na Qt6.
|
||||
|
||||
Artefakt z posledního jobu se dá stáhnout ze stránky běhu a rovnou
|
||||
nainstalovat přes *Install from ZIP* – recenzent nemusí nic balit ručně.
|
||||
|
||||
Totéž lokálně:
|
||||
|
||||
```sh
|
||||
pip install bandit detect-secrets flake8 ruff
|
||||
|
||||
python3 tests/check_sources.py
|
||||
bandit -r amcr_viewer/
|
||||
detect-secrets scan --all-files amcr_viewer/
|
||||
flake8 --config amcr_viewer/.flake8 amcr_viewer/
|
||||
ruff check .
|
||||
|
||||
# smoke test v obou verzích QGIS (docker, bez instalace čehokoli)
|
||||
for tag in ltr stable; do
|
||||
docker run --rm -v "$PWD:/work:ro" -w /work \
|
||||
--user "$(id -u):$(id -g)" -e HOME=/tmp \
|
||||
"qgis/qgis:$tag" python3 tests/smoke_test.py
|
||||
done
|
||||
```
|
||||
|
||||
Na co si dát pozor:
|
||||
|
||||
- **`pyqgis4-checker` končí kódem 0, i když něco najde** – výsledek je jen
|
||||
v logu. Workflow proto kontroluje, že log obsahuje jen hlavičku.
|
||||
- **`detect-secrets` bez `--all-files` prohledá jen soubory sledované
|
||||
gitem** a o nesledovaném souboru mlčí. Vypadá to jako čistý výsledek.
|
||||
- **Konfigurace lintů je rozdělená schválně.** `amcr_viewer/.flake8` leží
|
||||
vedle `metadata.txt`, protože scanner na plugins.qgis.org hledá config
|
||||
soubory jen v kořeni balíčku uvnitř ZIPu; díky tomu platí stejná pravidla
|
||||
v CI, lokálně i při uploadu. Konfigurace ruffu je naopak v kořenovém
|
||||
`pyproject.toml` – ruff se do balíčku pluginu nedistribuuje.
|
||||
Viz https://plugins.qgis.org/docs/security-scanning/config-files
|
||||
- **Verze nástrojů jsou v workflow napevno.** Výchozí sada pravidel ruffu se
|
||||
mezi verzemi mění, takže bez pinu by CI začalo padat samo od sebe.
|
||||
+2
-2
@@ -25,5 +25,5 @@ abstract: >-
|
||||
the Digital archive of the Archaeological Map of the
|
||||
Czech Republic (https://digiarchiv.aiscr.cz/).
|
||||
license: GPL-3.0
|
||||
version: '2.0.0'
|
||||
date-released: '2026-06-05'
|
||||
version: '2.1.2'
|
||||
date-released: '2026-09-01'
|
||||
@@ -1,6 +1 @@
|
||||
# CLAUDE.md
|
||||
|
||||
Pokyny pro tento repozitář jsou v [`AGENTS.md`](./AGENTS.md).
|
||||
|
||||
Tento soubor je záměrně jen odkaz, aby existoval jeden zdroj pravdy a obsah se
|
||||
nerozjel. Cokoli platí pro AI agenty v tomto projektu, najdeš v `AGENTS.md`.
|
||||
@AGENTS.md
|
||||
@@ -1,182 +1,433 @@
|
||||
# AMCR Viewer: QGIS Plugin Documentation
|
||||
# AMČR Viewer — QGIS plugin
|
||||
|
||||
[](https://www.gnu.org/licenses/gpl-3.0)
|
||||
[](https://qgis.org/)
|
||||
[](https://github.com/ARUP-CAS/aiscr-qgis-amcr-viewer/actions/workflows/code_quality.yml)
|
||||
[](https://doi.org/10.5281/zenodo.18609813)
|
||||
|
||||
**Platform:** QGIS 3.44.0–4.99.0
|
||||
**AMČR Viewer** queries the Digital Archive of the Archaeological Map of the
|
||||
Czech Republic (AMČR) and turns the result into ordinary QGIS vector layers.
|
||||
It removes the manual export/import round trip: you filter the archive from
|
||||
inside QGIS and the matching records arrive as point, line and polygon layers
|
||||
with a full attribute table.
|
||||
|
||||
**Module Type:** Data Acquisition & Visualization
|
||||
|
||||
**Source Data:** Archaeological Map of the Czech Republic (AIS CR)
|
||||
| | |
|
||||
| --- | --- |
|
||||
| **Source data** | [Digital Archive AMČR](https://digiarchiv.aiscr.cz/) (AIS CR) |
|
||||
| **Supported QGIS** | 3.44.0 – 4.99.0 (Qt 5 and Qt 6) |
|
||||
| **Output** | temporary `memory` layers, S-JTSK / **EPSG:5514** |
|
||||
| **Access** | anonymous by default; optional login for non-public records |
|
||||
| **UI language** | Czech |
|
||||
| **Licence** | GPL-3.0 |
|
||||
|
||||
---
|
||||
|
||||
## 1. Overview
|
||||
## 1. What it can download
|
||||
|
||||
**AMCR Viewer** is a QGIS plugin designed to facilitate direct access to the Digital Archive of the Archaeological Map of the Czech Republic (AMČR). It allows researchers to **query, retrieve, and visualize *Fieldwork events* and *Sites* data (metadata and geometry) directly within the GIS environment**, eliminating the need to manually export data from the web interface. Both *Fieldwork events* and *Sites* layers may optionally include component-level data (period and activity area) embedded directly in the attribute table. The plugin supports both **anonymous (public) access** and **authenticated access** for users with an AMČR account.
|
||||
The plugin covers three AMČR record types. Each has its own menu entry, its
|
||||
own set of filters and its own attribute table.
|
||||
|
||||
### Key Features
|
||||
| Entity | Menu entry | What it is |
|
||||
| --- | --- | --- |
|
||||
| **Fieldwork events** (`akce`) | *Stáhnout data akcí* | Records of archaeological finds and observations tied to a place, a responsible body and a time of execution. |
|
||||
| **Sites** (`lokalita`) | *Stáhnout data lokalit* | Records tied to a site, its characteristic archaeological manifestation and presumed function. |
|
||||
| **Individual finds** (`samostatny_nalez`) | *Stáhnout data samostatných nálezů* | Records of individual movable finds reported through **AMČR-PAS**, the portal for amateur collaborators. |
|
||||
|
||||
* **Spatial Querying:** Option to filter records based on the current map canvas extent (Bounding Box).
|
||||
* **Advanced Attribute Filtering:** Supports multi-criteria filtering using controlled vocabularies.
|
||||
* **Dynamic Geometry Retrieval:** Automatically downloads and categorizes spatial data into Point, Line, and Polygon layers.
|
||||
* **Semantic Interoperability:** Automatically translates internal system codes into human-readable labels using the AIS CR API.
|
||||
* **Authenticated Access:** Users with an AMČR account can log in to access non-public records.
|
||||
Fieldwork events and Sites can additionally carry **component** data (period
|
||||
and activity area) directly in the attribute table. Individual finds have no
|
||||
components — period and dating are attributes of the find itself.
|
||||
|
||||
## 2. Installation Guide
|
||||
### Key features
|
||||
|
||||
**Install the latest version of the plugin from the QGIS plugin repository.**
|
||||
* **Spatial querying** — restrict the query to the current map canvas extent.
|
||||
* **Multi-criteria attribute filtering** driven by AMČR controlled
|
||||
vocabularies (*hesláře*), with a searchable multi-select picker per filter.
|
||||
* **Date range filtering** for fieldwork start/end and for the date of finding.
|
||||
* **Automatic geometry retrieval**, split into Point, Line and Polygon layers
|
||||
and reprojected to S-JTSK.
|
||||
* **Human-readable labels** — internal codes (`HES-xxxxxx`) are translated via
|
||||
the AIS CR translation dictionary.
|
||||
* **Authenticated access** — an AMČR account unlocks non-public records;
|
||||
credentials are stored encrypted in the QGIS Authentication Manager.
|
||||
|
||||
**OR** (*in case you need older version*)
|
||||
---
|
||||
|
||||
1. *Obtain the [plugin distribution package](https://github.com/ARUP-CAS/aiscr-qgis-amcr-viewer/releases) (ZIP archive containing the `amcr_viewer` directory).*
|
||||
2. *Launch QGIS.*
|
||||
3. *Navigate to Plugins → Manage and Install Plugins...*
|
||||
4. *Select the Install from ZIP tab.*
|
||||
5. *Locate the source ZIP file and click Install Plugin.*
|
||||
6. *Upon successful installation, the AMCR Viewer button will appear in the toolbar.*
|
||||
## 2. Installation
|
||||
|
||||
## 3. User Manual
|
||||
### From the QGIS plugin repository (recommended)
|
||||
|
||||
### 3.1 Authentication (Optional)
|
||||
*Plugins → Manage and Install Plugins… → search for* **AMČR Viewer** *→
|
||||
Install*.
|
||||
|
||||
By default, the plugin accesses only publicly available records (accessibility = anonymous). To access non-public data, log in using your AMČR account:
|
||||
### From a ZIP archive (older versions, or a build from source)
|
||||
|
||||
* Click the dropdown arrow on the AMCR Viewer toolbar button and select **Přihlásit se**.
|
||||
* Enter your e-mail and password. Credentials are encrypted and stored securely in the **QGIS Authentication Manager** (DPAPI on Windows, Keychain on macOS, encrypted SQLite on Linux).
|
||||
* Stored credentials are reused automatically across sessions. To update or remove them, open the login dialog again.
|
||||
1. Download a [release package](https://github.com/ARUP-CAS/aiscr-qgis-amcr-viewer/releases)
|
||||
(a ZIP containing the `amcr_viewer` directory).
|
||||
2. In QGIS go to *Plugins → Manage and Install Plugins… → Install from ZIP*.
|
||||
3. Select the archive and click *Install Plugin*.
|
||||
|
||||
### 3.2 Data Retrieval
|
||||
Every successful CI run also publishes a ready-to-install `amcr_viewer.zip`
|
||||
as a build artifact, which is handy for testing a branch before release.
|
||||
|
||||
To initiate a search query, click either the **Stáhnout data akcí** or the **Stáhnout data lokalit** option from the dropdown menu. The filter dialog provides the following options. Shown options vary based on the chosen tool.
|
||||
After installation the **AMČR Viewer** button appears in the toolbar as a
|
||||
dropdown.
|
||||
|
||||
* **Spatial Filter:** *Checkbox "Omezit vyhledávání rozsahem okna":* If checked, the query is restricted to the geographical area currently visible in the QGIS canvas. If unchecked, the query searches the entire database (use with caution regarding data volume).
|
||||
* **Positive findings only:** If checked, only *PIANs* belonging to Documentation units marked as "Type of evidence" = "positive" are included. *(Fieldwork events only.)*
|
||||
### Requirements
|
||||
|
||||
* **Attribute Filters:**
|
||||
* The dialog uses "Picker" widgets for controlled vocabularies (common: Region, District, Cadastral area, Period, Activity Area, *PIAN* accuracy, Accessibility; *events* related: Organisation, Researcher, Event type; *sites* related: Site type and class, Level of confidence, State of preservation).
|
||||
* Click **Vybrat...** to open a searchable selection window. Multiple values can be selected simultaneously (Logic: OR).
|
||||
The plugin needs the **`requests`** library. It ships with the QGIS installers
|
||||
for Windows and macOS. On Linux distribution packages it may have to be
|
||||
installed separately (e.g. `python3-requests`).
|
||||
|
||||
* **Codelists (Hesláře):**
|
||||
* Controlled vocabularies are downloaded from the AMČR OAI-PMH API and cached locally in `codelists/heslar.csv`.
|
||||
* To refresh all codelists, click the **Aktualizovat hesláře 🔄** button in the filter dialog. This runs as a background task and may take a few minutes.
|
||||
---
|
||||
|
||||
* **Components:** Check **Načíst komponenty** to include period and activity area data directly in the output layers.
|
||||
> ⚠ When components are loaded, spatial features are duplicated — each feature corresponds to one component. Spatial analyses (areas, counts) may be inaccurate.
|
||||
## 3. User manual
|
||||
|
||||
* If no filter is used, all accessible Fieldwork events/PIANs are returned (the number of records is capped at 20 000; it is advisable to set at least one filter).
|
||||
### 3.1 Toolbar and menu
|
||||
|
||||
For a more in-depth tutorial refer to the [AMČR Documentation](https://amcr-help.aiscr.cz/digiarchiv/qgis-viewer.html) (only in Czech).
|
||||
The toolbar button is a dropdown; the default action is *Stáhnout data akcí*.
|
||||
|
||||
### 3.3 Layer Structure & Attributes
|
||||
|
||||
Upon successful retrieval, the plugin generates up to three temporary memory layers:
|
||||
|
||||
1. **AMCR\_[Akce|Lokalita]\_Polygony**
|
||||
2. **AMCR\_[Akce|Lokalita]\_Linie**
|
||||
3. **AMCR\_[Akce|Lokalita]\_Body**
|
||||
|
||||
Layers are only created if the query returns features of the corresponding geometry type. All layers share the same attribute schema.
|
||||
|
||||
#### 3.3.1 Common fields
|
||||
|
||||
| Field | Description |
|
||||
| Menu entry | Action |
|
||||
| --- | --- |
|
||||
| pian | PIAN (spatial identifier) ID |
|
||||
| presnost | Spatial deviation \[units/tens/hundreds of meters/defined by cadastre\] |
|
||||
| pian\_typ | \[point/line/polygon\] |
|
||||
| dj | Documentation unit ID |
|
||||
| typ\_dj | \[trench/event part/whole event/cadastral territory\] |
|
||||
| definicni\_body | Feature centroid in WGS-84 coordinate system |
|
||||
| akce / lokalita | Fieldwork event / Site ID |
|
||||
| odkaz\_do\_digiarchivu | Link to the record in the Digital Archive |
|
||||
| okres | District |
|
||||
| katastr | Main cadastral area |
|
||||
| dalsi\_katastry | Other cadastral areas, if the event extends beyond the main cadastre |
|
||||
| Přístupnost | Record accessibility \[A/B/C/D\] |
|
||||
| *Stáhnout data akcí* | Opens the filter dialog for Fieldwork events. |
|
||||
| *Stáhnout data samostatných nálezů* | Opens the filter dialog for Individual finds. |
|
||||
| *Stáhnout data lokalit* | Opens the filter dialog for Sites. |
|
||||
| *Přihlásit se* | Opens the login dialog (see 3.2). |
|
||||
| *Nápověda AMČR Help* | Opens the online documentation in a browser. |
|
||||
|
||||
#### 3.3.2 Fields related to *Fieldwork events*
|
||||
### 3.2 Authentication (optional)
|
||||
|
||||
| Field | Description |
|
||||
By default the plugin sees only publicly accessible records. Logging in with
|
||||
an AMČR account extends the result set to everything the account is allowed
|
||||
to see.
|
||||
|
||||
* The credentials are **verified against the API before they are stored** —
|
||||
a wrong password never reaches the Authentication Manager. If the server is
|
||||
unreachable, the plugin offers to store them unverified.
|
||||
* They are then saved encrypted in the **QGIS Authentication Manager** (DPAPI
|
||||
on Windows, Keychain on macOS, encrypted SQLite on Linux). QGIS will ask for
|
||||
its master password.
|
||||
* Stored credentials are reused across QGIS sessions. If the session cookie
|
||||
expires mid-download, the plugin re-authenticates automatically and repeats
|
||||
the request.
|
||||
* Reopening the login dialog lets you change the e-mail (leave the password
|
||||
blank to keep the stored one) or remove the credentials entirely
|
||||
(*Odebrat uložené přihlašovací údaje*).
|
||||
|
||||
### 3.3 The filter dialog
|
||||
|
||||
Filters of different categories are combined with **AND**; multiple values
|
||||
inside one filter are combined with **OR**. A filter left empty means "no
|
||||
restriction". Click *Vybrat…* to open a searchable, checkable list.
|
||||
|
||||
#### Availability per entity
|
||||
|
||||
| Filter (Czech UI label) | Events | Sites | Ind. finds | API parameter |
|
||||
| --- | :---: | :---: | :---: | --- |
|
||||
| Omezit vyhledávání rozsahem okna | ✓ | ✓ | ✓ | `loc_rpt` |
|
||||
| Pouze pozitivní zjištění | ✓ | — | — | `posevidence` |
|
||||
| Pouze projektové akce | ✓ | — | — | `proj_akce` |
|
||||
| Kraj | ✓ | ✓ | ✓ | `f_kraj` |
|
||||
| Okres | ✓ | ✓ | ✓ | `f_okres` |
|
||||
| Katastr | ✓ | ✓ | ✓ | `f_katastr` |
|
||||
| Přístupnost | ✓ | ✓ | ✓ | `pristupnost` |
|
||||
| PIAN – přesnost | ✓ | ✓ | — | `f_pian_presnost` |
|
||||
| Organizace | ✓ | — | ✓ | `f_organizace` |
|
||||
| Vedoucí výzkumu | ✓ | — | — | `f_vedouci` |
|
||||
| Typ výzkumu | ✓ | — | — | `f_typ_vyzkumu` |
|
||||
| Datum — *Zahájení* / *Ukončení* | ✓ | — | — | `akce_datum_zahajeni`, `akce_datum_ukonceni` |
|
||||
| Lokalita – typ | — | ✓ | — | `f_typ_lokality` |
|
||||
| Lokalita – druh | — | ✓ | — | `f_druh_lokality` |
|
||||
| Lokalita – jistota určení | — | ✓ | — | `f_jistota` |
|
||||
| Lokalita – stav dochování | — | ✓ | — | `f_lokalita_zachovalost` |
|
||||
| Období | ✓ | ✓ | ✓ | `f_obdobi` |
|
||||
| Kategorie nálezu | — | — | ✓ | `f_kategorie` |
|
||||
| Druh nálezu | — | — | ✓ | `f_druh_nalezu` |
|
||||
| Materiál | — | — | ✓ | `f_specifikace` |
|
||||
| Okolnosti nálezu | — | — | ✓ | `f_nalezove_okolnosti` |
|
||||
| Nálezce | — | — | ✓ | `f_nalezce` |
|
||||
| Datum nálezu | — | — | ✓ | `samostatny_nalez_datum_nalezu` |
|
||||
| Areál | ✓ | ✓ | — | `f_areal` |
|
||||
| Načíst komponenty | ✓ | ✓ | — | — |
|
||||
|
||||
#### Spatial restriction
|
||||
|
||||
*Omezit vyhledávání rozsahem okna* is **checked by default**. The canvas
|
||||
extent is transformed from the project CRS to WGS-84 and sent as a bounding
|
||||
box. Unchecking it queries the whole database — do so with an attribute
|
||||
filter in place, otherwise you will hit the record cap (see 4.5).
|
||||
|
||||
#### PIAN accuracy has a non-empty default
|
||||
|
||||
> ⚠ *PIAN – přesnost* is the one filter that is **pre-selected**. For
|
||||
> Fieldwork events and Sites the dialog starts with *odchylka jednotky metrů*,
|
||||
> *odchylka desítky metrů* and *odchylka stovky metrů* checked, so an
|
||||
> otherwise untouched dialog already sends `f_pian_presnost`. Records
|
||||
> localised only to a cadastral territory are excluded until you open the
|
||||
> picker and add that level yourself.
|
||||
|
||||
#### Date ranges
|
||||
|
||||
Each date block has a *from* and a *to* picker; an empty picker shows
|
||||
*neomezeno* and means an open bound. The API rejects a one-sided range, so the
|
||||
plugin substitutes a sentinel (`0001-01-01` / `9999-12-31`) for the empty
|
||||
side. A block with **both** pickers empty adds no filter at all.
|
||||
|
||||
A reversed range (start later than end) is refused when you confirm the
|
||||
dialog — such a query would come back empty and would be indistinguishable
|
||||
from a genuinely empty result.
|
||||
|
||||
#### Codelists (hesláře)
|
||||
|
||||
The controlled vocabularies behind the pickers are cached in
|
||||
`amcr_viewer/codelists/heslar.csv` and ship with the plugin. Click
|
||||
**Aktualizovat hesláře 🔄** to rebuild the file from the live APIs; it runs as
|
||||
a background QGIS task with a progress bar and takes a few minutes.
|
||||
|
||||
Most codelists come from the AMČR **OAI-PMH** endpoint. Two are built from
|
||||
Digiarchiv **search facets** instead, because they are lists of people rather
|
||||
than a published vocabulary: *Vedoucí výzkumu* (`f_vedouci`, faceted over
|
||||
fieldwork events) and *Nálezce* (`f_nalezce`, faceted over individual finds).
|
||||
|
||||
#### Components
|
||||
|
||||
Check **Načíst komponenty** (Events and Sites only) to bring the period and
|
||||
activity area of each component into the output layer.
|
||||
|
||||
> ⚠ With components loaded, spatial features are **duplicated** — one feature
|
||||
> per component. Areas and feature counts computed on such a layer are
|
||||
> misleading.
|
||||
|
||||
Note that *Období* and *Areál* also act as component filters even when the
|
||||
box is unchecked: a documentation unit whose components match nothing is
|
||||
dropped from the result.
|
||||
|
||||
### 3.4 Output layers
|
||||
|
||||
Up to three temporary `memory` layers are created per download, in **S-JTSK
|
||||
(EPSG:5514)**:
|
||||
|
||||
* `AMCR_Akce_Body` / `_Linie` / `_Polygony`
|
||||
* `AMCR_Lokalita_Body` / `_Linie` / `_Polygony`
|
||||
* `AMCR_Samostatný_nález_Body` / `_Linie` / `_Polygony`
|
||||
|
||||
A layer is only created if the query actually returned that geometry type.
|
||||
All layers of one download share the same attribute schema. Field names are
|
||||
ASCII; the human-readable names visible in the attribute table are QGIS field
|
||||
aliases.
|
||||
|
||||
> Memory layers are **not persistent** — export them (GeoPackage, Shapefile,
|
||||
> …) before closing the project.
|
||||
|
||||
Geometry is taken from the record's S-JTSK WKT when present; otherwise the
|
||||
WGS-84 fallback is reprojected. Invalid geometries are repaired rather than
|
||||
dropped.
|
||||
|
||||
The tables below group the fields by meaning. In the layer they appear in the
|
||||
order *common → entity-specific → `pristupnost` → component fields*.
|
||||
|
||||
#### Common fields
|
||||
|
||||
| Field | Alias | Description |
|
||||
| --- | --- | --- |
|
||||
| `pian` | PIAN | Spatial unit (PIAN) identifier. *Events and Sites only.* |
|
||||
| `presnost` | Přesnost | Spatial accuracy \[units / tens / hundreds of metres / defined by cadastre\]. *Events and Sites only.* |
|
||||
| `pian_typ` | PIAN – typ | \[point / line / polygon\]. *Events and Sites only.* |
|
||||
| `dj` | Dokumentační jednotka | Documentation unit identifier. *Events and Sites only.* |
|
||||
| `typ_dj` | Typ dokumentační jednotky | \[trench / event part / whole event / cadastral territory\]. *Events and Sites only.* |
|
||||
| `akce` / `lokalita` / `samostatny_nalez` | Akce / Lokalita / Samostatný nález | Record identifier. |
|
||||
| `definicni_body` | Definiční bod(y) (WGS-84) | Feature centroid(s) in WGS-84. |
|
||||
| `odkaz_do_digiarchivu` | Odkaz do Digitálního archivu AMČR | Permalink to the record. |
|
||||
| `okres` | Okres | District. |
|
||||
| `katastr` | Katastr | Main cadastral area. |
|
||||
| `dalsi_katastry` | Další katastry | Other cadastral areas. *Always empty for individual finds.* |
|
||||
| `pristupnost` | Přístupnost | Record accessibility \[A/B/C/D\]. |
|
||||
|
||||
#### Fieldwork event fields
|
||||
|
||||
| Field | Alias | Description |
|
||||
| --- | --- | --- |
|
||||
| `akce_lokalizace` | Akce – lokalizace | Verbal description of the location. |
|
||||
| `vedouci` | Vedoucí akce | Main fieldwork manager. |
|
||||
| `organizace` | Organizace | Organisation conducting the research. |
|
||||
| `specifikace_data` | Specifikace data | \[exact date / exact years / sometime in years\]. |
|
||||
| `zahajeni` | Datum zahájeni | Start date. |
|
||||
| `ukonceni` | Datum ukončení | End date. |
|
||||
| `hlavni_typ` | Hlavní typ | Primary research method. |
|
||||
| `vedlejsi_typ` | Vedlejší typ | Secondary research methods. |
|
||||
| `zjisteni` | Zjištění | Whether the **documentation unit** is positive or negative evidence \[Pozitivní / Negativní\]. |
|
||||
| `nahrazuje_NZ` | Akce – nahrazuje NZ | Replaces a fieldwork report \[Ano / Ne\]. |
|
||||
| `projekt` | Projekt | Identifier of the related project, if any. |
|
||||
|
||||
#### Site fields
|
||||
|
||||
| Field | Alias | Description |
|
||||
| --- | --- | --- |
|
||||
| `nazev_lokality` | Název lokality | Site name. |
|
||||
| `popis_lokality` | Popis lokality | Site description. |
|
||||
| `typ_lokality` | Typ lokality | Site classification by definition method. |
|
||||
| `druh_lokality` | Druh lokality | Site classification by the nature of the field relics. |
|
||||
| `zachovalost` | Zachovalost | State of preservation. |
|
||||
|
||||
#### Individual find fields
|
||||
|
||||
| Field | Alias | Description |
|
||||
| --- | --- | --- |
|
||||
| `projekt` | Projekt | Identifier of the related project. |
|
||||
| `nalezce` | Nálezce | Finder. |
|
||||
| `datum` | Datum nálezu | Date of finding. |
|
||||
| `okolnosti` | Nálezové okolnosti | Finding context. |
|
||||
| `hloubka_cm` | Hloubka (cm) | Depth below surface. |
|
||||
| `lokalizace` | Lokalizace | Verbal description of the find spot. |
|
||||
| `obdobi` | Období | Period. |
|
||||
| `presna_datace` | Přesná datace | Precise dating, if known. |
|
||||
| `nalez` | Nález | Find class. |
|
||||
| `material` | Materiál | Find specification / material. |
|
||||
| `pocet` | Počet předmětů | Number of objects. |
|
||||
| `poznamka` | Poznámka/bližší popis | Note or closer description. |
|
||||
| `pred_org` | Předáno organizaci | Organisation the find was handed over to. |
|
||||
| `evidencni` | Evidenční číslo | Reference number. |
|
||||
|
||||
#### Component fields (only with *Načíst komponenty*)
|
||||
|
||||
| Field | Alias | Description |
|
||||
| --- | --- | --- |
|
||||
| `komponenta` | Komponenta | Component identifier. |
|
||||
| `komponenta_areal` | Areál | Activity area \[settlement / burial area / field / …\]. |
|
||||
| `komponenta_obdobi` | Období | Period \[Neolithic / High Middle Ages–Modern Period / …\]. |
|
||||
|
||||
### 3.5 When a query returns nothing
|
||||
|
||||
Progress and errors are written to the QGIS *Messages* panel, tab **AMČR**
|
||||
(login goes to **AMČR login**). The log contains the **exact request URL**,
|
||||
so a suspicious query can be replayed in a browser instead of being
|
||||
reconstructed from the code. Distinct messages tell apart an empty result, an
|
||||
API error, a network failure and a result without any geometry.
|
||||
|
||||
Only one download can run at a time; starting a second one while the first is
|
||||
still running is refused with a message.
|
||||
|
||||
For a step-by-step tutorial see the
|
||||
[AMČR documentation](https://amcr-help.aiscr.cz/digiarchiv/qgis-viewer.html)
|
||||
(Czech only).
|
||||
|
||||
---
|
||||
|
||||
## 4. Technical notes
|
||||
|
||||
The plugin is plain **Python 3** with **`requests`** for HTTP. The GUI is
|
||||
built through the **`qgis.PyQt`** compatibility layer rather than importing
|
||||
`PyQt5`/`PyQt6` directly, which is what lets a single source tree run on both
|
||||
QGIS 3.44 (Qt 5) and QGIS 4 (Qt 6). Every enum is referenced in its scoped
|
||||
form (`Qt.CheckState.Checked`, …), as required by Qt 6.
|
||||
|
||||
### 4.1 Repository layout
|
||||
|
||||
```
|
||||
amcr_viewer/ the plugin package (this is what gets zipped)
|
||||
__init__.py classFactory() entry point for QGIS
|
||||
amcr_viewer.py toolbar/menu integration, login flow, dispatch
|
||||
amcr_dialog.py AmcrFilterDialog, FilterableSelectionDialog,
|
||||
LoginDialog, UpdateCodelistsTask
|
||||
amcr_tools.py API access, pagination, parsing, layer building
|
||||
amcr_codelists.py codelist download and CSV cache
|
||||
codelists/heslar.csv cached controlled vocabularies
|
||||
i18n/ Qt translation files
|
||||
*.png toolbar and menu icons
|
||||
resources.py generated by pyrcc, currently unused
|
||||
metadata.txt plugin metadata and changelog
|
||||
.flake8 lint config, read by the plugins.qgis.org scanner
|
||||
tests/
|
||||
check_sources.py source hygiene checks (no QGIS needed)
|
||||
smoke_test.py loads the plugin in a real, headless QGIS
|
||||
.github/workflows/ CI (code quality, release packaging)
|
||||
pyproject.toml ruff configuration
|
||||
AGENTS.md contributor and AI-agent guidelines
|
||||
```
|
||||
|
||||
### 4.2 API endpoints
|
||||
|
||||
| Purpose | Endpoint | Notes |
|
||||
| --- | --- | --- |
|
||||
| Login | `POST https://digiarchiv.aiscr.cz/api/user/login` | Returns a session cookie. Errors arrive with HTTP 200 and an `error` key. |
|
||||
| Search | `GET https://digiarchiv.aiscr.cz/api/search/query` | `entity=akce\|lokalita\|samostatny_nalez\|pian`, `mapa=true`, paginated. |
|
||||
| Translations | `GET https://digiarchiv.aiscr.cz/api/assets/i18n/cs.json` | Code → Czech label; cached in memory for the session. |
|
||||
| Codelists | `GET https://api.aiscr.cz/2.2/oai` | OAI-PMH `ListRecords`, with resumption tokens. |
|
||||
|
||||
### 4.3 Processing pipeline
|
||||
|
||||
1. **Metadata** are paged in batches of **500** records, deduplicated by
|
||||
`ident_cely`, until the reported `numFound` is reached or the cap is hit.
|
||||
2. Records **without geometry are skipped**; the rest are expanded into
|
||||
documentation units and — if requested — into components.
|
||||
3. **Geometries** (PIAN) are fetched separately in batches of **200**
|
||||
identifiers, to stay under URL length limits.
|
||||
4. Features are built, reprojected to EPSG:5514, sorted by geometry type and
|
||||
added to the project in a single batch per layer.
|
||||
|
||||
### 4.4 Data persistence
|
||||
|
||||
* **Codelists** — `amcr_viewer/codelists/heslar.csv`, rewritten only when the
|
||||
user asks for an update.
|
||||
* **Credentials** — QGIS Authentication Manager; the config ID is kept in
|
||||
`QSettings` under `amcr_viewer/auth_config_id`.
|
||||
* **Layers** — `memory` only, lost when QGIS closes.
|
||||
|
||||
### 4.5 Limits
|
||||
|
||||
* **20 000 records** per query (safety cap; QGIS would otherwise freeze).
|
||||
* **500** records per metadata request, **200** identifiers per geometry
|
||||
request.
|
||||
* With components loaded, one output feature equals one component, so a
|
||||
single PIAN can appear several times in the layer.
|
||||
|
||||
---
|
||||
|
||||
## 5. Development
|
||||
|
||||
Contributor rules, branch naming and the manual QGIS test checklist live in
|
||||
[`AGENTS.md`](./AGENTS.md).
|
||||
|
||||
Every pull request runs
|
||||
[`.github/workflows/code_quality.yml`](.github/workflows/code_quality.yml),
|
||||
which mirrors what plugins.qgis.org checks on upload and adds what it does
|
||||
not:
|
||||
|
||||
| Job | What it does |
|
||||
| --- | --- |
|
||||
| akce\_lokalizace | Verbal description of the event location |
|
||||
| vedouci | Main fieldwork manager |
|
||||
| organizace | Organisation conducting the research |
|
||||
| specifikace\_data | \[exact date/exact years/sometime in years\] |
|
||||
| zahajeni | Event start date |
|
||||
| ukonceni | Event end date |
|
||||
| hlavni\_typ | Primary research method |
|
||||
| vedlejsi\_typ | Secondary research method |
|
||||
| zjisteni | Did the research reveal archaeological contexts? \[positive/negative\] |
|
||||
| nahrazuje\_NZ | Replaces a fieldwork report? \[yes/no\] |
|
||||
| **Lint a bezpečnost** | `tests/check_sources.py`, bandit, detect-secrets, flake8, ruff |
|
||||
| **Kompatibilita s Qt6** | `pyqgis4-checker` in dry-run mode |
|
||||
| **Smoke test** | loads the plugin in headless QGIS — both `ltr` (Qt 5) and `stable` (Qt 6) |
|
||||
| **Balíček pluginu** | builds `amcr_viewer.zip`, asserts its contents, uploads it as an artifact |
|
||||
|
||||
#### 3.3.3 Fields related to *Sites*
|
||||
Reproducing them locally:
|
||||
|
||||
| Field | Description |
|
||||
| --- | --- |
|
||||
| nazev\_lokality | Site name |
|
||||
| popis\_lokality | Site description |
|
||||
| typ\_lokality | Site classification by definition method |
|
||||
| druh\_lokality | Site classification by the nature of identified field relics |
|
||||
| zachovalost | Site preservation state |
|
||||
```bash
|
||||
python3 tests/check_sources.py
|
||||
ruff check .
|
||||
flake8 --config amcr_viewer/.flake8 amcr_viewer/
|
||||
bandit -r amcr_viewer/
|
||||
docker run --rm -v "$PWD:/work:ro" -w /work --user "$(id -u):$(id -g)" \
|
||||
-e HOME=/tmp qgis/qgis:stable python3 tests/smoke_test.py
|
||||
```
|
||||
|
||||
#### 3.3.4 Component fields (only when *Načíst komponenty* is checked)
|
||||
---
|
||||
|
||||
| Field | Description |
|
||||
| --- | --- |
|
||||
| komponenta | Component ID |
|
||||
| komponenta\_areal | Activity area \[settlement/burial area/field/…\] |
|
||||
| komponenta\_obdobi | Period \[Neolithic/High Middle Ages–Modern Period/…\] |
|
||||
## 6. Links and resources
|
||||
|
||||
## 4. Technical Architecture
|
||||
* [AMČR / Digiarchiv documentation](https://amcr-help.aiscr.cz/) (Czech only)
|
||||
* [AMČR Viewer tutorial](https://amcr-help.aiscr.cz/digiarchiv/qgis-viewer.html)
|
||||
(Czech only)
|
||||
* [AMČR-PAS](https://amcr-info.aiscr.cz/amcr-pas/) — the amateur collaborator
|
||||
portal behind the Individual finds records
|
||||
* [Import/Export. Pluginy propojující QGIS s AMČR \[poster\]](https://zenodo.org/records/20504909)
|
||||
(Czech only; describes v1.3.2)
|
||||
|
||||
The plugin is developed in **Python 3** using the **PyQt6** framework for the GUI and the **Requests** library for HTTP communication.
|
||||
## Citing
|
||||
|
||||
> **Note:** The `requests` library is bundled with the QGIS installers for Windows and macOS. On Linux (distribution packages), it may need to be installed separately (e.g. `python3-requests`).
|
||||
Cite the plugin using [`CITATION.cff`](./CITATION.cff) or the concept DOI
|
||||
[10.5281/zenodo.18609813](https://doi.org/10.5281/zenodo.18609813), which
|
||||
always resolves to the latest release.
|
||||
|
||||
### 4.1 File Structure
|
||||
## Licence
|
||||
|
||||
* `amcr_viewer.py`: Entry point; handles GUI integration, toolbar/menu setup, and login flow.
|
||||
* `amcr_dialog.py`: Manages the UI logic, including `AmcrFilterDialog`, `FilterableSelectionDialog`, and `LoginDialog`.
|
||||
* `amcr_tools.py`: Core logic module. Handles authentication, API requests, pagination, data parsing, and vector layer generation.
|
||||
* `amcr_codelists.py`: Manages local caching of controlled vocabularies (`codelists/heslar.csv`) downloaded via OAI-PMH.
|
||||
|
||||
### 4.2 Data Flow & API Integration
|
||||
|
||||
The plugin interacts with the following endpoints:
|
||||
|
||||
1. **Login API:**
|
||||
* Endpoint: `https://digiarchiv.aiscr.cz/api/user/login`
|
||||
* Method: `POST`
|
||||
* Returns a session cookie used for subsequent authenticated requests.
|
||||
* Credentials are stored in the QGIS Authentication Manager; the session is restored automatically if it expires mid-download.
|
||||
|
||||
2. **Search API (Solr):**
|
||||
* Endpoint: `https://digiarchiv.aiscr.cz/api/search/query`
|
||||
* Method: `GET`
|
||||
* Parameters: `entity=akce|lokalita|pian`, `rows/page` (pagination), `mapa=true`.
|
||||
* Logic: Paginated in batches of 500 records (metadata) and 200 records (geometries). A safety cap of 20 000 records is enforced.
|
||||
|
||||
3. **Translation API:**
|
||||
* Endpoint: `https://digiarchiv.aiscr.cz/api/assets/i18n/cs.json`
|
||||
* Function: Retrieves the mapping between system codes (e.g. `HES-xxxx`) and Czech labels. Cached in memory for the session.
|
||||
|
||||
4. **Codelists API (OAI-PMH):**
|
||||
* Endpoint: `https://api.aiscr.cz/2.2/oai`
|
||||
* Used for downloading controlled vocabularies (periods, regions, organisations, etc.) on demand.
|
||||
|
||||
### 4.3 Data Persistence
|
||||
|
||||
* **Vocabularies:** Stored in `codelists/heslar.csv`; updated on user request via the background task.
|
||||
* **Layers:** Output layers are created as `memory` layers. They are non-persistent and will be lost if QGIS is closed without saving.
|
||||
|
||||
### 4.4 Constraints
|
||||
|
||||
* **Record Limit:** A safety cap of 20 000 records is enforced.
|
||||
* **Batch Processing:** Geometry fetching is batched (200 IDs per request) to comply with URL length limitations and server load balancing.
|
||||
* **Component duplication:** When components are loaded, each output feature corresponds to one component rather than one documentation unit. A single PIAN may therefore appear multiple times in the layer.
|
||||
|
||||
## 5. Links and resources
|
||||
|
||||
* [AMCR/Digiarchive Documentation](https://amcr-help.aiscr.cz/) (only in Czech).
|
||||
* [AMCR Viewer tutorial](https://amcr-help.aiscr.cz/digiarchiv/qgis-viewer.html) (only in Czech).
|
||||
* [Import/Export. Pluginy propojující QGIS s AMČR \[poster\]](https://zenodo.org/records/20504909) (only in Czech; valid for v1.3.2).
|
||||
GPL-3.0 — see [`LICENSE`](./LICENSE).
|
||||
@@ -0,0 +1,12 @@
|
||||
# Konfigurace flake8 pro plugin AMČR Viewer.
|
||||
#
|
||||
# Soubor leží vedle metadata.txt schválně: scanner na plugins.qgis.org
|
||||
# hledá .flake8 pouze v kořeni balíčku uvnitř ZIPu, takže stejná pravidla
|
||||
# platí v CI, lokálně i při uploadu.
|
||||
# https://plugins.qgis.org/docs/security-scanning/config-files
|
||||
[flake8]
|
||||
# resources.py je vygenerovaný výstup pyrcc ("All changes made in this
|
||||
# file will be lost"), není nikde importovaný a zdrojový .qrc v repu není.
|
||||
# Ručně se neformátuje.
|
||||
per-file-ignores =
|
||||
*resources.py: E302,E305,E501
|
||||
@@ -31,6 +31,5 @@ def classFactory(iface): # pylint: disable=invalid-name
|
||||
:param iface: A QGIS interface instance.
|
||||
:type iface: QgsInterface
|
||||
"""
|
||||
#
|
||||
from .amcr_viewer import AmcrViewer
|
||||
return AmcrViewer(iface)
|
||||
@@ -1,10 +1,11 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
import os
|
||||
# -*- coding: utf-8 -*-
|
||||
import csv
|
||||
import requests
|
||||
import xml.etree.ElementTree as ET # nosec
|
||||
import os
|
||||
import time
|
||||
from qgis.core import QgsMessageLog, Qgis
|
||||
import xml.etree.ElementTree as ET # nosec
|
||||
|
||||
import requests
|
||||
from qgis.core import Qgis, QgsMessageLog
|
||||
|
||||
# Define paths for the plugin and its codelists directory
|
||||
PLUGIN_DIR = os.path.dirname(__file__)
|
||||
@@ -64,7 +65,7 @@ def parse_codelist_file(filename, target_dict=None):
|
||||
|
||||
try:
|
||||
# Open the file using standard UTF-8 encoding
|
||||
with open(path, 'r', encoding='utf-8') as f:
|
||||
with open(path, encoding='utf-8') as f:
|
||||
reader = csv.reader(f, delimiter=';')
|
||||
|
||||
# Skip the CSV header row
|
||||
@@ -90,7 +91,7 @@ def parse_codelist_file(filename, target_dict=None):
|
||||
except Exception as e:
|
||||
QgsMessageLog.logMessage(
|
||||
f"AMČR Codelist Read Error for {filename}: {e}",
|
||||
"AMČR", Qgis.Critical)
|
||||
"AMČR", Qgis.MessageLevel.Critical)
|
||||
|
||||
return target_dict
|
||||
|
||||
@@ -98,7 +99,7 @@ def parse_codelist_file(filename, target_dict=None):
|
||||
def load_all_data():
|
||||
"""Loads the codelist during plugin startup."""
|
||||
ensure_codelists_dir()
|
||||
categorized_data = {k: {} for k in slovnicek.keys()}
|
||||
categorized_data = {k: {} for k in slovnicek}
|
||||
parse_codelist_file('heslar.csv', categorized_data)
|
||||
return categorized_data
|
||||
|
||||
@@ -124,7 +125,9 @@ def fetch_set(base_url, internal_name, api_set, task=None):
|
||||
|
||||
try:
|
||||
if "digiarchiv" not in base_url:
|
||||
response = requests.get(base_url, params=params_amcr, timeout=30)
|
||||
response = requests.get(
|
||||
base_url, params=params_amcr, timeout=30
|
||||
)
|
||||
response.raise_for_status()
|
||||
root = ET.fromstring(response.content) # nosec
|
||||
|
||||
@@ -193,7 +196,7 @@ def fetch_set(base_url, internal_name, api_set, task=None):
|
||||
time.sleep(0.5)
|
||||
else:
|
||||
break
|
||||
|
||||
|
||||
else:
|
||||
response = requests.get(base_url, params=params_da, timeout=30)
|
||||
response.raise_for_status()
|
||||
@@ -210,13 +213,13 @@ def fetch_set(base_url, internal_name, api_set, task=None):
|
||||
'Kód': nazev,
|
||||
'Kategorie': internal_name
|
||||
})
|
||||
|
||||
break
|
||||
|
||||
break
|
||||
|
||||
except Exception as e:
|
||||
QgsMessageLog.logMessage(
|
||||
f"Chyba u setu {api_set}: {e}",
|
||||
"AMČR", Qgis.Warning)
|
||||
"AMČR", Qgis.MessageLevel.Warning)
|
||||
break
|
||||
|
||||
return dataset
|
||||
@@ -240,7 +243,7 @@ def download_heslare(task=None):
|
||||
|
||||
QgsMessageLog.logMessage(
|
||||
f"Zpracovávám kategorii: {interni}...",
|
||||
"AMČR", Qgis.Info)
|
||||
"AMČR", Qgis.MessageLevel.Info)
|
||||
|
||||
# Pass the task correctly to the updated fetch function
|
||||
data = fetch_set(base_url, interni, api_nazev, task=task)
|
||||
|
||||
+74
-33
@@ -1,23 +1,57 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
from qgis.PyQt.QtWidgets import (QDialog, QVBoxLayout,
|
||||
QLineEdit, QDialogButtonBox,
|
||||
QCheckBox, QGroupBox, QPushButton,
|
||||
QListWidget, QListWidgetItem, QHBoxLayout,
|
||||
QMessageBox, QLabel, QFormLayout,
|
||||
QGridLayout, QScrollArea, QFrame, QWidget)
|
||||
from qgis.PyQt.QtCore import Qt, QSettings
|
||||
from qgis.core import (QgsTask, QgsApplication,
|
||||
QgsMessageLog, Qgis, QgsAuthMethodConfig)
|
||||
# -*- coding: utf-8 -*-
|
||||
from qgis.core import (
|
||||
Qgis,
|
||||
QgsApplication,
|
||||
QgsAuthMethodConfig,
|
||||
QgsMessageLog,
|
||||
QgsTask,
|
||||
)
|
||||
from qgis.gui import QgsDateEdit
|
||||
from qgis.PyQt.QtCore import QSettings, Qt
|
||||
from qgis.PyQt.QtWidgets import (
|
||||
QCheckBox,
|
||||
QDialog,
|
||||
QDialogButtonBox,
|
||||
QFormLayout,
|
||||
QFrame,
|
||||
QGridLayout,
|
||||
QGroupBox,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QLineEdit,
|
||||
QListWidget,
|
||||
QListWidgetItem,
|
||||
QMessageBox,
|
||||
QPushButton,
|
||||
QScrollArea,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
from qgis.utils import iface
|
||||
from .amcr_codelists import (OBDOBI, TYP_AKCE, KRAJE, AREAL, ORGANIZACE,
|
||||
OKRESY, KATASTRY, VEDOUCI, PIAN_PRESNOST,
|
||||
TYP_LOKALITY, DRUH_LOKALITY, JISTOTA,
|
||||
LOKALITA_ZACHOVALOST, PRISTUPNOST,
|
||||
NALEZ_KATEGORIE, DRUH_NALEZU, SPECIFIKACE,
|
||||
NALEZOVE_OKOLNOSTI, NALEZCE,
|
||||
download_heslare, refresh_globals)
|
||||
|
||||
from .amcr_codelists import (
|
||||
AREAL,
|
||||
DRUH_LOKALITY,
|
||||
DRUH_NALEZU,
|
||||
JISTOTA,
|
||||
KATASTRY,
|
||||
KRAJE,
|
||||
LOKALITA_ZACHOVALOST,
|
||||
NALEZ_KATEGORIE,
|
||||
NALEZCE,
|
||||
NALEZOVE_OKOLNOSTI,
|
||||
OBDOBI,
|
||||
OKRESY,
|
||||
ORGANIZACE,
|
||||
PIAN_PRESNOST,
|
||||
PRISTUPNOST,
|
||||
SPECIFIKACE,
|
||||
TYP_AKCE,
|
||||
TYP_LOKALITY,
|
||||
VEDOUCI,
|
||||
download_heslare,
|
||||
refresh_globals,
|
||||
)
|
||||
|
||||
# The date filter of the API requires both bounds; a one-sided range makes
|
||||
# the server fail with an ArrayIndexOutOfBoundsException and '*' is not
|
||||
@@ -38,7 +72,7 @@ _ACTIVE_TASKS = []
|
||||
|
||||
class UpdateCodelistsTask(QgsTask):
|
||||
def __init__(self, description):
|
||||
super().__init__(description, QgsTask.CanCancel)
|
||||
super().__init__(description, QgsTask.Flag.CanCancel)
|
||||
self.success = False
|
||||
self.exception = None
|
||||
|
||||
@@ -59,18 +93,18 @@ class UpdateCodelistsTask(QgsTask):
|
||||
refresh_globals()
|
||||
QgsMessageLog.logMessage(
|
||||
"Hesláře AMČR byly úspěšně aktualizovány.",
|
||||
"AMČR", Qgis.Info
|
||||
"AMČR", Qgis.MessageLevel.Info
|
||||
)
|
||||
else:
|
||||
if self.isCanceled():
|
||||
QgsMessageLog.logMessage(
|
||||
"Aktualizace heslářů byla zrušena.",
|
||||
"AMČR", Qgis.Warning
|
||||
"AMČR", Qgis.MessageLevel.Warning
|
||||
)
|
||||
else:
|
||||
QgsMessageLog.logMessage(
|
||||
f"Chyba aktualizace: {self.exception}",
|
||||
"AMČR", Qgis.Critical
|
||||
"AMČR", Qgis.MessageLevel.Critical
|
||||
)
|
||||
|
||||
|
||||
@@ -299,7 +333,7 @@ class AmcrFilterDialog(QDialog):
|
||||
layout.addWidget(self.picker_jistota)
|
||||
|
||||
self.picker_lokalita_zachovalost = self.setup_picker(
|
||||
"Lokalita - stav dochování",
|
||||
"Lokalita – stav dochování",
|
||||
'lokalita_zachovalost',
|
||||
LOKALITA_ZACHOVALOST
|
||||
)
|
||||
@@ -326,7 +360,7 @@ class AmcrFilterDialog(QDialog):
|
||||
layout.addWidget(self.picker_druh_nalezu)
|
||||
|
||||
self.picker_specifikace = self.setup_picker(
|
||||
"Specifikace nálezu",
|
||||
"Materiál",
|
||||
'specifikace',
|
||||
SPECIFIKACE
|
||||
)
|
||||
@@ -608,7 +642,7 @@ class AmcrFilterDialog(QDialog):
|
||||
# This will show exactly what went wrong (e.g. PermissionError)
|
||||
msg = (
|
||||
"Aktualizace selhala z důvodu chyby:\n"
|
||||
f"{str(task.exception)}"
|
||||
f"{task.exception!s}"
|
||||
)
|
||||
else:
|
||||
msg = "Aktualizace byla zrušena uživatelem."
|
||||
@@ -625,8 +659,7 @@ class AmcrFilterDialog(QDialog):
|
||||
def get_komponenty(self):
|
||||
if self.typ_dat in ["akce", "lokalita"]:
|
||||
return "true" if self.chk_komponenty.isChecked() else "false"
|
||||
else:
|
||||
return "false"
|
||||
return "false"
|
||||
|
||||
def get_filters(self):
|
||||
"""Compiles the user selections from the cache into
|
||||
@@ -660,7 +693,7 @@ class AmcrFilterDialog(QDialog):
|
||||
filters['f_vedouci'] = self.selection_cache['vedouci']
|
||||
|
||||
if self.selection_cache['organizace']:
|
||||
filters['f_organizace'] = self.selection_cache['organizace']
|
||||
filters['f_organizace'] = self.selection_cache['organizace']
|
||||
|
||||
if self.selection_cache['typ_lokality']:
|
||||
filters['f_typ_lokality'] = self.selection_cache['typ_lokality']
|
||||
@@ -669,7 +702,9 @@ class AmcrFilterDialog(QDialog):
|
||||
if self.selection_cache['jistota']:
|
||||
filters['f_jistota'] = self.selection_cache['jistota']
|
||||
if self.selection_cache['lokalita_zachovalost']:
|
||||
filters['f_lokalita_zachovalost'] = self.selection_cache['lokalita_zachovalost']
|
||||
filters['f_lokalita_zachovalost'] = (
|
||||
self.selection_cache['lokalita_zachovalost']
|
||||
)
|
||||
|
||||
# Samostatné nálezy
|
||||
if self.selection_cache['nalez_kategorie']:
|
||||
@@ -679,7 +714,9 @@ class AmcrFilterDialog(QDialog):
|
||||
if self.selection_cache['specifikace']:
|
||||
filters['f_specifikace'] = self.selection_cache['specifikace']
|
||||
if self.selection_cache['nalezove_okolnosti']:
|
||||
filters['f_nalezove_okolnosti'] = self.selection_cache['nalezove_okolnosti']
|
||||
filters['f_nalezove_okolnosti'] = (
|
||||
self.selection_cache['nalezove_okolnosti']
|
||||
)
|
||||
if self.selection_cache['nalezce']:
|
||||
filters['f_nalezce'] = self.selection_cache['nalezce']
|
||||
|
||||
@@ -718,7 +755,8 @@ class LoginDialog(QDialog):
|
||||
- storeAuthenticationConfig() and loadAuthenticationConfig() both have
|
||||
SIP_INOUT on their config parameter, so Python bindings return a tuple
|
||||
(bool, QgsAuthMethodConfig) rather than just bool. Always unpack both.
|
||||
- loadAuthenticationConfig() with full=False loads only metadata (name, method,
|
||||
- loadAuthenticationConfig() with full=False loads only metadata
|
||||
(name, method,
|
||||
id) but NOT the config() values like username/password. Use full=True to
|
||||
access those.
|
||||
"""
|
||||
@@ -949,7 +987,7 @@ class LoginDialog(QDialog):
|
||||
# We skip hasConfigId() as it may return False
|
||||
# despite the config existing
|
||||
# (in-memory cache may not be populated yet in QGIS 4).
|
||||
ok_load, existing_cfg = (
|
||||
ok_load, _ = (
|
||||
self._load_config(existing_id, full=False)
|
||||
if existing_id
|
||||
else (False, None)
|
||||
@@ -978,7 +1016,9 @@ class LoginDialog(QDialog):
|
||||
settings = QSettings()
|
||||
existing_id = settings.value(self.SETTINGS_KEY, "")
|
||||
if existing_id:
|
||||
QgsApplication.authManager().removeAuthenticationConfig(existing_id)
|
||||
QgsApplication.authManager().removeAuthenticationConfig(
|
||||
existing_id
|
||||
)
|
||||
settings.remove(self.SETTINGS_KEY)
|
||||
QMessageBox.information(
|
||||
self,
|
||||
@@ -1013,4 +1053,5 @@ class LoginDialog(QDialog):
|
||||
if not ok:
|
||||
return "", ""
|
||||
|
||||
return cfg.config("username", ""), cfg.config("password", "") # nosec B106
|
||||
return (cfg.config("username", ""),
|
||||
cfg.config("password", "")) # nosec B106
|
||||
+42
-26
@@ -1,15 +1,24 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
from qgis.core import (QgsProject, QgsVectorLayer, QgsFeature, QgsGeometry,
|
||||
QgsField, QgsCoordinateReferenceSystem,
|
||||
QgsCoordinateTransform, QgsWkbTypes, Qgis,
|
||||
QgsMessageLog)
|
||||
from qgis.utils import iface
|
||||
from qgis.PyQt.QtCore import Qt, QMetaType
|
||||
from qgis.PyQt.QtWidgets import QApplication
|
||||
from qgis.PyQt.QtGui import QCursor
|
||||
import requests
|
||||
import json
|
||||
|
||||
import requests
|
||||
from qgis.core import (
|
||||
Qgis,
|
||||
QgsCoordinateReferenceSystem,
|
||||
QgsCoordinateTransform,
|
||||
QgsFeature,
|
||||
QgsField,
|
||||
QgsGeometry,
|
||||
QgsMessageLog,
|
||||
QgsProject,
|
||||
QgsVectorLayer,
|
||||
QgsWkbTypes,
|
||||
)
|
||||
from qgis.PyQt.QtCore import QMetaType, Qt
|
||||
from qgis.PyQt.QtGui import QCursor
|
||||
from qgis.PyQt.QtWidgets import QApplication
|
||||
from qgis.utils import iface
|
||||
|
||||
# Global cache to store translated terms from the Digital Archive
|
||||
TRANSLATIONS = {}
|
||||
|
||||
@@ -109,8 +118,9 @@ def login_to_api(username: str, password: str):
|
||||
|
||||
except requests.exceptions.HTTPError as e:
|
||||
status = e.response.status_code if e.response is not None else None
|
||||
_log(f"CHYBA HTTP {status if status else '?'}: "
|
||||
f"{e.response.text[:300] if e.response is not None else 'žádná odpověď'}",
|
||||
telo = (e.response.text[:300] if e.response is not None
|
||||
else "žádná odpověď")
|
||||
_log(f"CHYBA HTTP {status if status else '?'}: {telo}",
|
||||
Qgis.MessageLevel.Critical)
|
||||
LAST_LOGIN_ERROR = 'auth' if status in (401, 403) else 'network'
|
||||
return None
|
||||
@@ -623,7 +633,8 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
|
||||
for dj in djs:
|
||||
# Skip negative evidence units if requested
|
||||
if skip_negativni and dj.get('dj_negativni_jednotka') is True:
|
||||
if (skip_negativni
|
||||
and dj.get('dj_negativni_jednotka') is True):
|
||||
continue
|
||||
|
||||
komps = dj.get('dj_komponenta', [])
|
||||
@@ -643,7 +654,8 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
dj_id = dj.get('ident_cely')
|
||||
dj_typ = dj.get('dj_typ')
|
||||
|
||||
# Merge shared metadata with documentation unit-specific fields
|
||||
# Merge shared metadata with documentation
|
||||
# unit-specific fields
|
||||
dj_meta = {
|
||||
**meta,
|
||||
'dj_id': dj_id,
|
||||
@@ -668,6 +680,8 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
# One feature per component –
|
||||
# all data on a single row, no relations needed
|
||||
if komps:
|
||||
komps_count = len(komps)
|
||||
|
||||
for komp in komps:
|
||||
if not komp_projde_filtrem(
|
||||
komp, filter_areal,
|
||||
@@ -689,8 +703,10 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
komp.get('komponenta_obdobi')
|
||||
or {}
|
||||
).get('value', ""),
|
||||
'vaha': 1/komps_count,
|
||||
}
|
||||
pian_lookup[dj_pian_value].append(komp_meta)
|
||||
pian_lookup[dj_pian_value].append(
|
||||
komp_meta)
|
||||
target_pian_ids_count += 1
|
||||
else:
|
||||
# DJ without components — still include
|
||||
@@ -704,7 +720,8 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
'komponenta_areal': "",
|
||||
'komponenta_obdobi': "",
|
||||
}
|
||||
pian_lookup[dj_pian_value].append(empty_meta)
|
||||
pian_lookup[dj_pian_value].append(
|
||||
empty_meta)
|
||||
target_pian_ids_count += 1
|
||||
else:
|
||||
target_pian_ids_count += 1
|
||||
@@ -907,9 +924,6 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
)
|
||||
return
|
||||
|
||||
|
||||
|
||||
|
||||
# ==========================================
|
||||
# D) LAYER CREATION (QGIS Memory Layers)
|
||||
# ==========================================
|
||||
@@ -947,7 +961,6 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
QgsField("typ_dj", QMetaType.Type.QString),
|
||||
]
|
||||
|
||||
|
||||
cols += [
|
||||
QgsField(typ_dat, QMetaType.Type.QString),
|
||||
QgsField("definicni_body", QMetaType.Type.QString),
|
||||
@@ -1046,6 +1059,7 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
"poznamka": "Poznámka/bližší popis",
|
||||
"pred_org": "Předáno organizaci",
|
||||
"evidencni": "Evidenční číslo",
|
||||
"prvek_vaha": "Váha prvku",
|
||||
}
|
||||
|
||||
if komponenty == "true":
|
||||
@@ -1053,6 +1067,7 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
QgsField("komponenta", QMetaType.Type.QString),
|
||||
QgsField("komponenta_areal", QMetaType.Type.QString),
|
||||
QgsField("komponenta_obdobi", QMetaType.Type.QString),
|
||||
QgsField("prvek_vaha", QMetaType.Type.Double),
|
||||
]
|
||||
|
||||
for vl in layers:
|
||||
@@ -1138,11 +1153,11 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
if geom.isGeosValid():
|
||||
t = geom.type()
|
||||
target_list = None
|
||||
if t == QgsWkbTypes.PolygonGeometry:
|
||||
if t == QgsWkbTypes.GeometryType.PolygonGeometry:
|
||||
target_list = feats_p
|
||||
elif t == QgsWkbTypes.LineGeometry:
|
||||
elif t == QgsWkbTypes.GeometryType.LineGeometry:
|
||||
target_list = feats_l
|
||||
elif t == QgsWkbTypes.PointGeometry:
|
||||
elif t == QgsWkbTypes.GeometryType.PointGeometry:
|
||||
target_list = feats_pt
|
||||
|
||||
if target_list is None:
|
||||
@@ -1199,6 +1214,7 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
meta.get('komponenta_id', ""),
|
||||
meta.get('komponenta_areal', ""),
|
||||
meta.get('komponenta_obdobi', ""),
|
||||
meta.get('vaha', 1),
|
||||
])
|
||||
|
||||
feat.setAttributes(atributy)
|
||||
@@ -1227,11 +1243,11 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
if geom.isGeosValid():
|
||||
t = geom.type()
|
||||
target_list = None
|
||||
if t == QgsWkbTypes.PolygonGeometry:
|
||||
if t == QgsWkbTypes.GeometryType.PolygonGeometry:
|
||||
target_list = feats_p
|
||||
elif t == QgsWkbTypes.LineGeometry:
|
||||
elif t == QgsWkbTypes.GeometryType.LineGeometry:
|
||||
target_list = feats_l
|
||||
elif t == QgsWkbTypes.PointGeometry:
|
||||
elif t == QgsWkbTypes.GeometryType.PointGeometry:
|
||||
target_list = feats_pt
|
||||
|
||||
if target_list is None:
|
||||
@@ -1265,7 +1281,7 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
]
|
||||
feat.setAttributes(atributy)
|
||||
target_list.append(feat)
|
||||
|
||||
|
||||
except Exception as ex:
|
||||
QgsMessageLog.logMessage(
|
||||
f"Chyba při tvorbě feature: {ex}",
|
||||
|
||||
+17
-15
@@ -1,13 +1,14 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
from qgis.PyQt.QtCore import QSettings, QTranslator, QCoreApplication, QUrl
|
||||
from qgis.PyQt.QtGui import QIcon, QDesktopServices
|
||||
from qgis.PyQt.QtWidgets import QMenu, QAction, QToolButton, QDialog
|
||||
from qgis.core import Qgis
|
||||
|
||||
from .amcr_tools import load_amcr_data, login_to_api
|
||||
from .amcr_dialog import AmcrFilterDialog, LoginDialog
|
||||
import os.path
|
||||
|
||||
from qgis.core import Qgis
|
||||
from qgis.PyQt.QtCore import QCoreApplication, QSettings, QTranslator, QUrl
|
||||
from qgis.PyQt.QtGui import QDesktopServices, QIcon
|
||||
from qgis.PyQt.QtWidgets import QAction, QDialog, QMenu, QToolButton
|
||||
|
||||
from .amcr_dialog import AmcrFilterDialog, LoginDialog
|
||||
from .amcr_tools import load_amcr_data, login_to_api
|
||||
|
||||
|
||||
class AmcrViewer:
|
||||
"""
|
||||
@@ -29,7 +30,7 @@ class AmcrViewer:
|
||||
locale_path = os.path.join(
|
||||
self.plugin_dir,
|
||||
'i18n',
|
||||
'AmcrViewer_{}.qm'.format(locale)
|
||||
f'AmcrViewer_{locale}.qm'
|
||||
)
|
||||
|
||||
# Install the translator if a translation file
|
||||
@@ -41,7 +42,7 @@ class AmcrViewer:
|
||||
|
||||
# Initialize internal state
|
||||
self.actions = []
|
||||
self.menu = self.tr(u'&AMČR Viewer')
|
||||
self.menu = self.tr('&AMČR Viewer')
|
||||
self.first_start = None
|
||||
|
||||
def tr(self, message):
|
||||
@@ -102,7 +103,7 @@ class AmcrViewer:
|
||||
# custom dropdown menu
|
||||
self.action_download_akce = self.add_action(
|
||||
icon_path=icon_akce_path,
|
||||
text=self.tr(u'Stáhnout data akcí | AMČR Viewer'),
|
||||
text=self.tr('Stáhnout data akcí | AMČR Viewer'),
|
||||
callback=lambda checked=False: self.run_download('akce'),
|
||||
parent=self.iface.mainWindow(),
|
||||
add_to_menu=False,
|
||||
@@ -112,8 +113,9 @@ class AmcrViewer:
|
||||
|
||||
self.action_download_pas = self.add_action(
|
||||
icon_path=icon_pas_path,
|
||||
text=self.tr(u'Stáhnout data samostatných nálezů | AMČR Viewer'),
|
||||
callback=lambda checked=False: self.run_download('samostatny_nalez'),
|
||||
text=self.tr('Stáhnout data samostatných nálezů | AMČR Viewer'),
|
||||
callback=lambda checked=False: self.run_download(
|
||||
'samostatny_nalez'),
|
||||
parent=self.iface.mainWindow(),
|
||||
add_to_menu=False,
|
||||
add_to_toolbar=False
|
||||
@@ -122,7 +124,7 @@ class AmcrViewer:
|
||||
|
||||
self.action_download_lokality = self.add_action(
|
||||
icon_path=icon_lokality_path,
|
||||
text=self.tr(u'Stáhnout data lokalit | AMČR Viewer'),
|
||||
text=self.tr('Stáhnout data lokalit | AMČR Viewer'),
|
||||
callback=lambda checked=False: self.run_download('lokalita'),
|
||||
parent=self.iface.mainWindow(),
|
||||
add_to_menu=False,
|
||||
@@ -132,7 +134,7 @@ class AmcrViewer:
|
||||
|
||||
self.action_login_dialog = self.add_action(
|
||||
icon_path=icon_pas_path,
|
||||
text=self.tr(u'Přihlásit se | AMČR Viewer'),
|
||||
text=self.tr('Přihlásit se | AMČR Viewer'),
|
||||
callback=lambda checked=False: self.login(),
|
||||
parent=self.iface.mainWindow(),
|
||||
add_to_menu=False,
|
||||
@@ -142,7 +144,7 @@ class AmcrViewer:
|
||||
|
||||
self.action_amcr_help = self.add_action(
|
||||
icon_path=icon_amcr_help_path,
|
||||
text=self.tr(u'Nápověda AMČR Help | AMČR Viewer'),
|
||||
text=self.tr('Nápověda AMČR Help | AMČR Viewer'),
|
||||
callback=lambda checked=False: self.open_help(),
|
||||
parent=self.iface.mainWindow(),
|
||||
add_to_menu=False,
|
||||
|
||||
@@ -8,7 +8,7 @@ name=AMČR Viewer
|
||||
qgisMinimumVersion=3.44.0
|
||||
qgisMaximumVersion=4.99.0
|
||||
description=Viewing and downloading the AMČR data.
|
||||
version=2.1.1
|
||||
version=2.2.0
|
||||
author=David Spáčil
|
||||
email=spacil@arub.cz
|
||||
|
||||
@@ -23,7 +23,14 @@ repository=https://github.com/ARUP-CAS/aiscr-qgis-amcr-viewer
|
||||
hasProcessingProvider=no
|
||||
# Uncomment the following line and add your changelog:
|
||||
changelog=
|
||||
Plný seznam změn v češtině je dostupný zde: https://github.com/ARUP-CAS/aiscr-qgis-amcr-viewer/releases/tag/v2.1.1
|
||||
Plný seznam změn v češtině je dostupný zde: https://github.com/ARUP-CAS/aiscr-qgis-amcr-viewer/releases/tag/v2.2.0
|
||||
v2.2.0 (2026-09-02)
|
||||
* Filter labels unified: "Specifikace nálezu" renamed to "Materiál" to match the attribute alias
|
||||
* README rewritten to match the current state of the code
|
||||
* Tables for Akce and Lokality contain a field with feature weight, when Komponenty rendering is enabled
|
||||
v2.1.2 (2026-09-01)
|
||||
* Qt6 compatibility
|
||||
* Code clean-up
|
||||
v2.1.1 (2026-09-01)
|
||||
* Added download of Individual finds (PAS), including a dedicated menu entry
|
||||
* Added filtering by date
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
# Konfigurace lintů pro tento repozitář.
|
||||
#
|
||||
# Plugin se nedistribuuje jako Python balíček (do QGISu jde ZIP složky
|
||||
# amcr_viewer/), takže tenhle soubor nic nebalí ani neinstaluje – slouží
|
||||
# jen k tomu, aby ruff choval stejně v CI, lokálně i za rok. Bez explicitní
|
||||
# konfigurace se výchozí sada pravidel mezi verzemi ruffu mění.
|
||||
#
|
||||
# Konfigurace flake8 je záměrně jinde: v amcr_viewer/.flake8, protože ji
|
||||
# musí najít i scanner na plugins.qgis.org.
|
||||
|
||||
[tool.ruff]
|
||||
line-length = 79
|
||||
# QGIS 3.44 běží na Pythonu 3.9 a novějším
|
||||
target-version = "py39"
|
||||
# Generovaný výstup pyrcc, "All changes made in this file will be lost"
|
||||
extend-exclude = ["amcr_viewer/resources.py"]
|
||||
|
||||
[tool.ruff.lint]
|
||||
select = [
|
||||
"E", # pycodestyle – chyby
|
||||
"W", # pycodestyle – varování
|
||||
"F", # pyflakes
|
||||
"I", # pořadí importů
|
||||
"UP", # zastaralé konstrukce
|
||||
"B", # bugbear
|
||||
"C4", # comprehensions
|
||||
"SIM", # zjednodušení
|
||||
"RET", # návratové hodnoty
|
||||
"BLE", # holé except
|
||||
]
|
||||
ignore = [
|
||||
# Hlavička "# -*- coding: utf-8 -*-" je konvence šablony Plugin
|
||||
# Builderu a drží se v celém projektu jednotně.
|
||||
"UP009",
|
||||
# "except Exception" je v pluginu záměr: výjimka nesmí propadnout do
|
||||
# QGISu, chyba se uživateli ukáže v liště zpráv.
|
||||
"BLE001",
|
||||
# Obě dotčená místa mají ke každé větvi vysvětlující komentář,
|
||||
# sloučením do jednoho výrazu by se čitelnost zhoršila.
|
||||
"SIM103",
|
||||
# contextlib.suppress() by kvůli jednomu místu přidal import a odsunul
|
||||
# komentář, který vysvětluje, proč tam ta výjimka je.
|
||||
"SIM105",
|
||||
]
|
||||
@@ -0,0 +1,85 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
Repository hygiene rules that need no QGIS and therefore run first.
|
||||
|
||||
Each rule guards a mistake that has already happened here at least once,
|
||||
or one the plugins.qgis.org file analysis reports:
|
||||
|
||||
* a UTF-8 BOM makes the official pyqgis4-checker skip the file entirely,
|
||||
so a broken file looks clean – it is silent, which is what makes it bad
|
||||
* a direct PyQt5/PyQt6 import breaks the other Qt version
|
||||
* an executable or hidden file in the package is reported on upload
|
||||
|
||||
Run it from the repository root:
|
||||
|
||||
python3 tests/check_sources.py
|
||||
"""
|
||||
|
||||
import os
|
||||
import re
|
||||
import stat
|
||||
import sys
|
||||
|
||||
ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
||||
BALICEK = os.path.join(ROOT, "amcr_viewer")
|
||||
|
||||
# Files that belong in the plugin package even though the upload scanner
|
||||
# would otherwise call them hidden
|
||||
POVOLENE_SKRYTE = {".flake8", ".bandit", ".secrets.baseline"}
|
||||
|
||||
# Extensions that have no business inside a plugin package
|
||||
PODEZRELE = {".exe", ".dll", ".so", ".dylib", ".sh", ".bat", ".cmd",
|
||||
".pyc", ".pyd", ".jar", ".bin"}
|
||||
|
||||
PRIMY_IMPORT = re.compile(r"^\s*(?:from|import)\s+PyQt[56]\b", re.MULTILINE)
|
||||
|
||||
nalezy = []
|
||||
|
||||
|
||||
def zdrojaky():
|
||||
for adresar, _, soubory in os.walk(BALICEK):
|
||||
for soubor in sorted(soubory):
|
||||
if soubor.endswith(".py"):
|
||||
yield os.path.join(adresar, soubor)
|
||||
|
||||
|
||||
def vsechny_soubory():
|
||||
for adresar, _, soubory in os.walk(BALICEK):
|
||||
for soubor in sorted(soubory):
|
||||
yield os.path.join(adresar, soubor)
|
||||
|
||||
|
||||
def zkratka(cesta):
|
||||
return os.path.relpath(cesta, ROOT)
|
||||
|
||||
|
||||
for cesta in zdrojaky():
|
||||
with open(cesta, "rb") as f:
|
||||
zacatek = f.read(3)
|
||||
if zacatek == b"\xef\xbb\xbf":
|
||||
nalezy.append(f"{zkratka(cesta)}: UTF-8 BOM na začátku souboru")
|
||||
|
||||
with open(cesta, encoding="utf-8-sig") as f:
|
||||
text = f.read()
|
||||
for shoda in PRIMY_IMPORT.finditer(text):
|
||||
radek = text[:shoda.start()].count("\n") + 1
|
||||
nalezy.append(f"{zkratka(cesta)}:{radek}: přímý import z PyQt5/PyQt6, "
|
||||
f"použij shim qgis.PyQt")
|
||||
|
||||
for cesta in vsechny_soubory():
|
||||
jmeno = os.path.basename(cesta)
|
||||
rezim = os.stat(cesta).st_mode
|
||||
if rezim & (stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH):
|
||||
nalezy.append(f"{zkratka(cesta)}: spustitelná práva "
|
||||
f"({stat.filemode(rezim)})")
|
||||
if jmeno.startswith(".") and jmeno not in POVOLENE_SKRYTE:
|
||||
nalezy.append(f"{zkratka(cesta)}: skrytý soubor v balíčku pluginu")
|
||||
if os.path.splitext(jmeno)[1].lower() in PODEZRELE:
|
||||
nalezy.append(f"{zkratka(cesta)}: podezřelý typ souboru")
|
||||
|
||||
if nalezy:
|
||||
print("Nálezy:")
|
||||
for nalez in nalezy:
|
||||
print(f" {nalez}")
|
||||
sys.exit(1)
|
||||
print("Kontrola zdrojáků: bez nálezů")
|
||||
@@ -0,0 +1,187 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
Guards the release PR (version/vX.Y.Z -> main).
|
||||
|
||||
Checks that the version actually moved forward and that the three places
|
||||
that name it agree, because plugins.qgis.org and Zenodo both read from
|
||||
files a human has to remember to touch by hand:
|
||||
|
||||
* amcr_viewer/metadata.txt: version= must be higher than on main, and the
|
||||
first changelog entry must be for that exact version
|
||||
* CITATION.cff: version must match metadata.txt, and date-released must
|
||||
not be left pointing at the old release
|
||||
* the branch name (version/vX.Y.Z) must match metadata.txt, so a stray
|
||||
push to the wrong release branch is caught before merge
|
||||
|
||||
Run from the repository root:
|
||||
|
||||
python3 tests/check_version_bump.py <base_sha> <head_ref>
|
||||
"""
|
||||
|
||||
import datetime
|
||||
import re
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
METADATA = "amcr_viewer/metadata.txt"
|
||||
CITATION = "CITATION.cff"
|
||||
|
||||
VERZE_METADATA = re.compile(r"^version=(.+)$", re.MULTILINE)
|
||||
VERZE_CITATION = re.compile(r"^version:\s*'?([^'\n]+)'?\s*$", re.MULTILINE)
|
||||
DATUM_CITATION = re.compile(r"^date-released:\s*'?([^'\n]+)'?\s*$",
|
||||
re.MULTILINE)
|
||||
# Přeskočí úvodní řádek "Plný seznam změn ... /vX.Y.Z" a najde první
|
||||
# skutečnou položku changelogu.
|
||||
POLOZKA_CHANGELOGU = re.compile(r"^\s+v([0-9][^\s(]*)\s*\(", re.MULTILINE)
|
||||
BRANCH_VERZE = re.compile(r"^version/v(.+)$")
|
||||
|
||||
nalezy = []
|
||||
|
||||
|
||||
def nacti_na_base(base_sha, cesta):
|
||||
vysledek = subprocess.run(
|
||||
["git", "show", f"{base_sha}:{cesta}"],
|
||||
capture_output=True, text=True,
|
||||
)
|
||||
if vysledek.returncode != 0:
|
||||
nalezy.append(f"{cesta}: na cílové větvi nejde přečíst "
|
||||
f"(git show {base_sha}:{cesta} selhalo)")
|
||||
return None
|
||||
return vysledek.stdout
|
||||
|
||||
|
||||
def nacti(cesta):
|
||||
with open(cesta, encoding="utf-8") as f:
|
||||
return f.read()
|
||||
|
||||
|
||||
def hledej(vzor, text, cesta, popis):
|
||||
shoda = vzor.search(text)
|
||||
if not shoda:
|
||||
nalezy.append(f"{cesta}: {popis} nenalezeno")
|
||||
return None
|
||||
return shoda.group(1).strip()
|
||||
|
||||
|
||||
def verze_tuple(verze):
|
||||
jadro = verze.split("-", 1)[0]
|
||||
try:
|
||||
return tuple(int(c) for c in jadro.split("."))
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
|
||||
def je_bump(stara, nova):
|
||||
if stara == nova:
|
||||
return False
|
||||
stara_t, nova_t = verze_tuple(stara), verze_tuple(nova)
|
||||
if stara_t is None or nova_t is None:
|
||||
# Nestandardní formát verze – nejde spolehlivě porovnat čísly,
|
||||
# stačí tedy, že se řetězec liší.
|
||||
return True
|
||||
if nova_t != stara_t:
|
||||
return nova_t > stara_t
|
||||
# Stejné jádro (např. "-alpha" přípona): bump platí, pokud se text
|
||||
# liší a nejde o couvnutí z release na prerelease.
|
||||
return "-" in stara or "-" not in nova
|
||||
|
||||
|
||||
def datum(text):
|
||||
try:
|
||||
return datetime.date.fromisoformat(text)
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
|
||||
def main():
|
||||
if len(sys.argv) != 3:
|
||||
print("použití: check_version_bump.py <base_sha> <head_ref>")
|
||||
return 2
|
||||
base_sha, head_ref = sys.argv[1], sys.argv[2]
|
||||
|
||||
base_metadata = nacti_na_base(base_sha, METADATA)
|
||||
base_citation = nacti_na_base(base_sha, CITATION)
|
||||
head_metadata = nacti(METADATA)
|
||||
head_citation = nacti(CITATION)
|
||||
|
||||
if base_metadata is None or base_citation is None:
|
||||
# Bez base souborů nejde nic dalšího smysluplně ověřit.
|
||||
print("Nálezy:")
|
||||
for nalez in nalezy:
|
||||
print(f" {nalez}")
|
||||
return 1
|
||||
|
||||
stara_verze = hledej(VERZE_METADATA, base_metadata, METADATA,
|
||||
"verze na cílové větvi (version=)")
|
||||
nova_verze = hledej(VERZE_METADATA, head_metadata, METADATA,
|
||||
"verze (version=)")
|
||||
stara_citation_verze = hledej(VERZE_CITATION, base_citation, CITATION,
|
||||
"verze na cílové větvi (version:)")
|
||||
nova_citation_verze = hledej(VERZE_CITATION, head_citation, CITATION,
|
||||
"verze (version:)")
|
||||
stare_datum = hledej(DATUM_CITATION, base_citation, CITATION,
|
||||
"date-released na cílové větvi")
|
||||
nove_datum = hledej(DATUM_CITATION, head_citation, CITATION,
|
||||
"date-released")
|
||||
|
||||
if None in (stara_verze, nova_verze, stara_citation_verze,
|
||||
nova_citation_verze, stare_datum, nove_datum):
|
||||
print("Nálezy:")
|
||||
for nalez in nalezy:
|
||||
print(f" {nalez}")
|
||||
return 1
|
||||
|
||||
# 1. metadata.txt: verze musí jít dopředu.
|
||||
if not je_bump(stara_verze, nova_verze):
|
||||
nalezy.append(
|
||||
f"{METADATA}: verze nepovýšena ({stara_verze} -> {nova_verze})")
|
||||
|
||||
# 2. metadata.txt: první položka changelogu musí patřit nové verzi.
|
||||
prvni_polozka = POLOZKA_CHANGELOGU.search(head_metadata)
|
||||
if not prvni_polozka:
|
||||
nalezy.append(f"{METADATA}: v changelog= nenalezena žádná položka "
|
||||
f"'vX.Y.Z (...)'")
|
||||
elif prvni_polozka.group(1) != nova_verze:
|
||||
nalezy.append(
|
||||
f"{METADATA}: první položka changelogu je pro "
|
||||
f"v{prvni_polozka.group(1)}, ale version={nova_verze}")
|
||||
|
||||
# 3. CITATION.cff: verze musí souhlasit s metadata.txt.
|
||||
if nova_citation_verze != nova_verze:
|
||||
nalezy.append(
|
||||
f"{CITATION}: version: {nova_citation_verze} neodpovídá "
|
||||
f"{METADATA} version={nova_verze}")
|
||||
|
||||
# 4. CITATION.cff: date-released se musí posunout, a ne dozadu.
|
||||
stary_datum_obj, novy_datum_obj = datum(stare_datum), datum(nove_datum)
|
||||
if stary_datum_obj is None or novy_datum_obj is None:
|
||||
nalezy.append(f"{CITATION}: date-released není platné datum "
|
||||
f"ISO 8601 ({stare_datum!r} -> {nove_datum!r})")
|
||||
elif novy_datum_obj < stary_datum_obj:
|
||||
nalezy.append(
|
||||
f"{CITATION}: date-released couvlo ({stare_datum} -> "
|
||||
f"{nove_datum})")
|
||||
elif nove_datum == stare_datum and stara_citation_verze != nova_citation_verze:
|
||||
nalezy.append(
|
||||
f"{CITATION}: version se změnila, ale date-released zůstalo "
|
||||
f"na {stare_datum}")
|
||||
|
||||
# 5. Název release větve musí odpovídat verzi, kterou nese.
|
||||
shoda_branch = BRANCH_VERZE.match(head_ref)
|
||||
if shoda_branch and shoda_branch.group(1) != nova_verze:
|
||||
nalezy.append(
|
||||
f"větev {head_ref!r} neodpovídá {METADATA} "
|
||||
f"version={nova_verze}")
|
||||
|
||||
if nalezy:
|
||||
print("Nálezy:")
|
||||
for nalez in nalezy:
|
||||
print(f" {nalez}")
|
||||
return 1
|
||||
print(f"Kontrola verze a changelogu: v{stara_verze} -> v{nova_verze}, "
|
||||
f"bez nálezů")
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
@@ -0,0 +1,130 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
Smoke test: loads the plugin inside a real QGIS and exercises the parts
|
||||
that differ between Qt5 and Qt6.
|
||||
|
||||
It is deliberately offline – no request ever leaves the machine, so the
|
||||
test says nothing about the AMCR API, only about the plugin loading and
|
||||
its widgets being constructible.
|
||||
|
||||
Run it from the repository root:
|
||||
|
||||
python3 tests/smoke_test.py
|
||||
|
||||
QGIS must be importable (inside the qgis/qgis Docker image it already is).
|
||||
The exit code is 0 when everything passed, 1 otherwise.
|
||||
"""
|
||||
|
||||
import os
|
||||
import sys
|
||||
import traceback
|
||||
|
||||
# Offscreen, otherwise the dialogs need an X server
|
||||
os.environ.setdefault("QT_QPA_PLATFORM", "offscreen")
|
||||
|
||||
ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
||||
sys.path.insert(0, ROOT)
|
||||
|
||||
selhani = []
|
||||
|
||||
|
||||
def zkouska(nazev, funkce):
|
||||
"""Runs one check and keeps going even when it raises."""
|
||||
try:
|
||||
detail = funkce()
|
||||
except Exception:
|
||||
selhani.append(nazev)
|
||||
print(f" FAIL {nazev}")
|
||||
print(traceback.format_exc().rstrip())
|
||||
else:
|
||||
print(f" OK {nazev}" + (f" – {detail}" if detail else ""))
|
||||
|
||||
|
||||
from qgis.core import ( # noqa: E402
|
||||
Qgis,
|
||||
QgsApplication,
|
||||
QgsTask,
|
||||
QgsWkbTypes,
|
||||
)
|
||||
from qgis.PyQt import QtCore # noqa: E402
|
||||
from qgis.PyQt.QtCore import QDate # noqa: E402
|
||||
|
||||
print(f"QGIS {Qgis.QGIS_VERSION.split('-')[0]} | Qt {QtCore.QT_VERSION_STR} "
|
||||
f"| PyQt {QtCore.PYQT_VERSION_STR}")
|
||||
|
||||
QgsApplication.setPrefixPath(os.environ.get("QGIS_PREFIX_PATH", "/usr"), True)
|
||||
qgs = QgsApplication([], True)
|
||||
qgs.initQgis()
|
||||
|
||||
import amcr_viewer.amcr_codelists # noqa: E402,F401
|
||||
import amcr_viewer.amcr_dialog as dialog # noqa: E402
|
||||
import amcr_viewer.amcr_tools # noqa: E402,F401
|
||||
import amcr_viewer.amcr_viewer # noqa: E402,F401
|
||||
|
||||
print(" OK import všech modulů pluginu")
|
||||
|
||||
|
||||
def enumy():
|
||||
"""
|
||||
The scoped enum forms must exist. Unscoped aliases still resolve in
|
||||
QGIS 4.2, so a plain import proves nothing – these are read explicitly.
|
||||
"""
|
||||
return (f"QgsTask.Flag.CanCancel={int(QgsTask.Flag.CanCancel)}, "
|
||||
f"PointGeometry={int(QgsWkbTypes.GeometryType.PointGeometry)}, "
|
||||
f"MessageLevel.Info={int(Qgis.MessageLevel.Info)}")
|
||||
|
||||
|
||||
def uloha():
|
||||
ukol = dialog.UpdateCodelistsTask("smoke")
|
||||
assert ukol.canCancel() is True
|
||||
return "canCancel=True"
|
||||
|
||||
|
||||
def dialogy():
|
||||
# A modal warning would block the offscreen run forever
|
||||
dialog.QMessageBox.warning = staticmethod(lambda *a, **k: None)
|
||||
popis = []
|
||||
for typ in ("akce", "lokalita", "samostatny_nalez"):
|
||||
okno = dialog.AmcrFilterDialog(typ)
|
||||
okno.show()
|
||||
QgsApplication.processEvents()
|
||||
popis.append(f"{typ}: {len(okno.date_ranges)} rozmezí")
|
||||
okno.close()
|
||||
return ", ".join(popis)
|
||||
|
||||
|
||||
def filtr_datumu():
|
||||
"""
|
||||
A half-filled range must be completed with the sentinel. The API
|
||||
rejects a one-sided range, so this is the part worth guarding.
|
||||
|
||||
The expected value is written out on purpose – comparing against
|
||||
dialog.DATE_OPEN_TO would only prove the module agrees with itself.
|
||||
"""
|
||||
okno = dialog.AmcrFilterDialog("samostatny_nalez")
|
||||
pole, _, od, _do = okno.date_ranges[0]
|
||||
od.setDate(QDate(2016, 1, 1))
|
||||
hodnota = okno.get_filters()[pole]
|
||||
assert hodnota == "2016-01-01,9999-12-31", hodnota
|
||||
|
||||
# A range left completely empty must add no filter at all
|
||||
prazdne = dialog.AmcrFilterDialog("samostatny_nalez")
|
||||
pole_prazdne = prazdne.date_ranges[0][0]
|
||||
assert pole_prazdne not in prazdne.get_filters()
|
||||
prazdne.close()
|
||||
|
||||
okno.close()
|
||||
return hodnota
|
||||
|
||||
|
||||
zkouska("scoped enumy", enumy)
|
||||
zkouska("UpdateCodelistsTask", uloha)
|
||||
zkouska("filtrační dialogy", dialogy)
|
||||
zkouska("filtr podle data", filtr_datumu)
|
||||
|
||||
qgs.exitQgis()
|
||||
|
||||
if selhani:
|
||||
print(f"\nNEPROŠLO: {', '.join(selhani)}")
|
||||
sys.exit(1)
|
||||
print("\nVše prošlo")
|
||||
Reference in new issue
Block a user