qgis-plugin-analyzer 1.3.0__tar.gz → 1.4.0__tar.gz

{qgis_plugin_analyzer-1.3.0 → qgis_plugin_analyzer-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qgis-plugin-analyzer
-Version: 1.3.0
+Version: 1.4.0
 Summary: A professional static analysis tool for QGIS (PyQGIS) plugins
 Author-email: geociencio <juanbernales@gmail.com>
 License: GPL-3.0-or-later
@@ -27,6 +27,8 @@ License-File: LICENSE
 Dynamic: license-file
 
 # QGIS Plugin Analyzer 🛡️
+
+👉 **[View Full Rules Catalog (RULES.md)](RULES.md)**
 ![GitHub release (latest by date)](https://img.shields.io/github/v/release/geociencio/qgis-plugin-analyzer?color=blue&logo=github)
 ![Python Version](https://img.shields.io/badge/python-3.8%2B-blue?logo=python)
 ![License](https://img.shields.io/badge/License-GPLv3-blue.svg)
@@ -86,6 +88,11 @@ If you have [uv](https://github.com/astral-sh/uv) installed, you can install the
 uv tool install git+https://github.com/geociencio/qgis-plugin-analyzer.git
 ```
 
+**2. Standard pip installation (Git):**
+```bash
+pip install git+https://github.com/geociencio/qgis-plugin-analyzer.git
+```
+
 **2. Local installation for development:**
 ```bash
 git clone https://github.com/geociencio/qgis-plugin-analyzer
@@ -122,10 +129,9 @@ You can run `qgis-plugin-analyzer` automatically before every commit to ensure q
 
 ```yaml
   - repo: https://github.com/geociencio/qgis-plugin-analyzer
-    rev: v1.1.0  # Use the latest tag
+    rev: v1.4.0  # Use the latest tag
     hooks:
       - id: qgis-plugin-analyzer
-      - id: qgis-plugin-analyzer
 ```
 
 ## 🤖 GitHub Action
@@ -143,8 +149,38 @@ steps:
       args: --profile release
 ```
 
+## ⚙️ Configuration (`pyproject.toml`)
+
+You can customize the analyzer's behavior using a `[tool.qgis-analyzer]` section in your `pyproject.toml`.
+
+```toml
+[tool.qgis-analyzer]
+# Profiles allow different settings for CI vs Local
+[tool.qgis-analyzer.profiles.default]
+strict = false
+generate_html = false  # CLI default
+
+[tool.qgis-analyzer.profiles.release]
+strict = true
+fail_on_error = true
+
+[tool.qgis-analyzer.profiles.default.rules]
+QGS101 = "error"    # Ban specific module imports
+QGS105 = "warning"  # Warn on iface usage
+QGS303 = "ignore"   # Ignore resource path checks
+```
+
+## ⚠️ Technical Limitations
+
+This tool performs **Static Analysis** (AST & Regex parsing). It does **not** execute your code or load QGIS libraries.
+- **Dynamic Imports**: Imports inside functions or conditional blocks might be analyzed differently than top-level imports.
+- **Runtime Validation**: Checks like "Missing Resources" rely on static string analysis of `.qrc` files and path strings. It cannot verify resources loaded dynamically at runtime.
+- **False Positives**: While we strive for accuracy, complex meta-programming or unusual patterns might trigger false positives. Use `# noqa` or `.analyzerignore` to handle these cases.
+
 ## ⌨️ Full CLI Reference
 
+> **Note**: The Python package is named `qgis-plugin-analyzer`, but the command-line tool is installed as `qgis-analyzer`.
+
 ### `qgis-analyzer analyze`
 Audits an existing QGIS plugin repository.
 

{qgis_plugin_analyzer-1.3.0 → qgis_plugin_analyzer-1.4.0}/README.md

@@ -1,4 +1,6 @@
 # QGIS Plugin Analyzer 🛡️
+
+👉 **[View Full Rules Catalog (RULES.md)](RULES.md)**
 ![GitHub release (latest by date)](https://img.shields.io/github/v/release/geociencio/qgis-plugin-analyzer?color=blue&logo=github)
 ![Python Version](https://img.shields.io/badge/python-3.8%2B-blue?logo=python)
 ![License](https://img.shields.io/badge/License-GPLv3-blue.svg)
@@ -58,6 +60,11 @@ If you have [uv](https://github.com/astral-sh/uv) installed, you can install the
 uv tool install git+https://github.com/geociencio/qgis-plugin-analyzer.git
 ```
 
+**2. Standard pip installation (Git):**
+```bash
+pip install git+https://github.com/geociencio/qgis-plugin-analyzer.git
+```
+
 **2. Local installation for development:**
 ```bash
 git clone https://github.com/geociencio/qgis-plugin-analyzer
@@ -94,10 +101,9 @@ You can run `qgis-plugin-analyzer` automatically before every commit to ensure q
 
 ```yaml
   - repo: https://github.com/geociencio/qgis-plugin-analyzer
-    rev: v1.1.0  # Use the latest tag
+    rev: v1.4.0  # Use the latest tag
     hooks:
       - id: qgis-plugin-analyzer
-      - id: qgis-plugin-analyzer
 ```
 
 ## 🤖 GitHub Action
@@ -115,8 +121,38 @@ steps:
       args: --profile release
 ```
 
+## ⚙️ Configuration (`pyproject.toml`)
+
+You can customize the analyzer's behavior using a `[tool.qgis-analyzer]` section in your `pyproject.toml`.
+
+```toml
+[tool.qgis-analyzer]
+# Profiles allow different settings for CI vs Local
+[tool.qgis-analyzer.profiles.default]
+strict = false
+generate_html = false  # CLI default
+
+[tool.qgis-analyzer.profiles.release]
+strict = true
+fail_on_error = true
+
+[tool.qgis-analyzer.profiles.default.rules]
+QGS101 = "error"    # Ban specific module imports
+QGS105 = "warning"  # Warn on iface usage
+QGS303 = "ignore"   # Ignore resource path checks
+```
+
+## ⚠️ Technical Limitations
+
+This tool performs **Static Analysis** (AST & Regex parsing). It does **not** execute your code or load QGIS libraries.
+- **Dynamic Imports**: Imports inside functions or conditional blocks might be analyzed differently than top-level imports.
+- **Runtime Validation**: Checks like "Missing Resources" rely on static string analysis of `.qrc` files and path strings. It cannot verify resources loaded dynamically at runtime.
+- **False Positives**: While we strive for accuracy, complex meta-programming or unusual patterns might trigger false positives. Use `# noqa` or `.analyzerignore` to handle these cases.
+
 ## ⌨️ Full CLI Reference
 
+> **Note**: The Python package is named `qgis-plugin-analyzer`, but the command-line tool is installed as `qgis-analyzer`.
+
 ### `qgis-analyzer analyze`
 Audits an existing QGIS plugin repository.
 

{qgis_plugin_analyzer-1.3.0 → qgis_plugin_analyzer-1.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "qgis-plugin-analyzer"
-version = "1.3.0"
+version = "1.4.0"
 description = "A professional static analysis tool for QGIS (PyQGIS) plugins"
 readme = "README.md"
 requires-python = ">=3.8"

{qgis_plugin_analyzer-1.3.0 → qgis_plugin_analyzer-1.4.0}/src/qgis_plugin_analyzer.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qgis-plugin-analyzer
-Version: 1.3.0
+Version: 1.4.0
 Summary: A professional static analysis tool for QGIS (PyQGIS) plugins
 Author-email: geociencio <juanbernales@gmail.com>
 License: GPL-3.0-or-later
@@ -27,6 +27,8 @@ License-File: LICENSE
 Dynamic: license-file
 
 # QGIS Plugin Analyzer 🛡️
+
+👉 **[View Full Rules Catalog (RULES.md)](RULES.md)**
 ![GitHub release (latest by date)](https://img.shields.io/github/v/release/geociencio/qgis-plugin-analyzer?color=blue&logo=github)
 ![Python Version](https://img.shields.io/badge/python-3.8%2B-blue?logo=python)
 ![License](https://img.shields.io/badge/License-GPLv3-blue.svg)
@@ -86,6 +88,11 @@ If you have [uv](https://github.com/astral-sh/uv) installed, you can install the
 uv tool install git+https://github.com/geociencio/qgis-plugin-analyzer.git
 ```
 
+**2. Standard pip installation (Git):**
+```bash
+pip install git+https://github.com/geociencio/qgis-plugin-analyzer.git
+```
+
 **2. Local installation for development:**
 ```bash
 git clone https://github.com/geociencio/qgis-plugin-analyzer
@@ -122,10 +129,9 @@ You can run `qgis-plugin-analyzer` automatically before every commit to ensure q
 
 ```yaml
   - repo: https://github.com/geociencio/qgis-plugin-analyzer
-    rev: v1.1.0  # Use the latest tag
+    rev: v1.4.0  # Use the latest tag
     hooks:
       - id: qgis-plugin-analyzer
-      - id: qgis-plugin-analyzer
 ```
 
 ## 🤖 GitHub Action
@@ -143,8 +149,38 @@ steps:
       args: --profile release
 ```
 
+## ⚙️ Configuration (`pyproject.toml`)
+
+You can customize the analyzer's behavior using a `[tool.qgis-analyzer]` section in your `pyproject.toml`.
+
+```toml
+[tool.qgis-analyzer]
+# Profiles allow different settings for CI vs Local
+[tool.qgis-analyzer.profiles.default]
+strict = false
+generate_html = false  # CLI default
+
+[tool.qgis-analyzer.profiles.release]
+strict = true
+fail_on_error = true
+
+[tool.qgis-analyzer.profiles.default.rules]
+QGS101 = "error"    # Ban specific module imports
+QGS105 = "warning"  # Warn on iface usage
+QGS303 = "ignore"   # Ignore resource path checks
+```
+
+## ⚠️ Technical Limitations
+
+This tool performs **Static Analysis** (AST & Regex parsing). It does **not** execute your code or load QGIS libraries.
+- **Dynamic Imports**: Imports inside functions or conditional blocks might be analyzed differently than top-level imports.
+- **Runtime Validation**: Checks like "Missing Resources" rely on static string analysis of `.qrc` files and path strings. It cannot verify resources loaded dynamically at runtime.
+- **False Positives**: While we strive for accuracy, complex meta-programming or unusual patterns might trigger false positives. Use `# noqa` or `.analyzerignore` to handle these cases.
+
 ## ⌨️ Full CLI Reference
 
+> **Note**: The Python package is named `qgis-plugin-analyzer`, but the command-line tool is installed as `qgis-analyzer`.
+
 ### `qgis-analyzer analyze`
 Audits an existing QGIS plugin repository.