checkmate5 5.1.0.dev4__py3-none-any.whl → 5.1.0.dev5__py3-none-any.whl

{checkmate5-5.1.0.dev4.dist-info → checkmate5-5.1.0.dev5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: checkmate5
-Version: 5.1.0.dev4
+Version: 5.1.0.dev5
 Summary: A meta-code checker written in Python.
 Author: Andreas Dewes
 License: AGPL-3.0
@@ -37,6 +37,8 @@ Checkmate is a cross-language (meta-)tool for static code analysis, written in P
 
 # Description
 
+# Checkmate5: Backend Configuration, PK-Key, & Snapshots Usage
+
 This guide explains how to configure the backend parameter for Checkmate5 (SQLite/Postgres), details the role and usage of the `pk` ("primary key") parameter, and describes how "snapshots" are used to associate findings with file hashes in project history.
 
 ---
@@ -59,8 +61,14 @@ You can specify the backend when initializing a new project or via configuration
 
 #### Example CLI Usage
 ```bash
-checkmate init --backend sql --backend-opts "postgresql://user:password@localhost/dbname" --pk myproject123
-checkmate init --backend sqlite --backend-opts "sqlite:///path/to/db.sqlite"
+# Initialize a new project using PostgreSQL
+checkmate init --backend sql --backend-opts "postgresql://user:password@localhost/mydatabase" --pk myproject123
+
+# Initialize a new project using SQLite (file-based)
+checkmate init --backend sqlite --backend-opts "sqlite:///path/to/db.sqlite" --pk myproject456
+
+# Initialize a new project using SQLite (in-memory, good for testing)
+checkmate init --backend sqlite --backend-opts "sqlite:///:memory:" --pk testproject
 ```
 
 #### Configuration Structure Example (`.checkmate/config.json`)
@@ -156,6 +164,44 @@ Checkmate can compare ("diff") snapshots to show what changed between two states
 
 ---
 
+## Sample Usage
+
+### Initialize a New Project
+
+```bash
+# Using PostgreSQL as backend
+checkmate init --backend sql --backend-opts "postgresql://user:password@localhost/mydatabase" --pk myproject123
+
+# Using SQLite as backend
+checkmate init --backend sqlite --backend-opts "sqlite:///myproject.db" --pk myproject456
+```
+
+### Run Analysis
+
+```bash
+# Analyze the current state (creates a new snapshot)
+checkmate analyze
+
+# Analyze a specific branch or commit (for git-enabled projects)
+checkmate analyze --branch main
+
+# Analyze and generate summary/diffs between snapshots (for history comparison)
+checkmate summary
+checkmate snapshots
+```
+
+### View and Export Findings
+
+```bash
+# Show detected issues (optionally for a specific snapshot)
+checkmate issues --snapshot <snapshot_id>
+
+# Export findings to HTML or JSON report
+checkmate issues html
+```
+
+---
+
 ## Summary Table
 
 | Parameter        | Description                                     | Example Value                    |

{checkmate5-5.1.0.dev4.dist-info → checkmate5-5.1.0.dev5.dist-info}/RECORD

@@ -67,9 +67,9 @@ checkmate/scripts/manage.py,sha256=vb4L171yfctLbZpQxn_kZ1hQLtCDqdQQGiq7BJlnQ2A,4
 checkmate/settings/__init__.py,sha256=z32hPz-kGS-tTGa6dWCFjrrrbS_eagLd-YrqBP3gjWI,33
 checkmate/settings/base.py,sha256=3WBXZITqoWepIja96bo5JTi-TDpQALPTCugL0E8z-yE,4551
 checkmate/settings/defaults.py,sha256=qZqK82L4Qb96JkUP7J240rL_SPa3CNi3emZBh2LvSf4,1825
-checkmate5-5.1.0.dev4.dist-info/licenses/LICENSE.txt,sha256=SGQTFjJQjkYGoK1PCFfMKpfgRLm3yL0h9Mq2o26sm2E,151451
-checkmate5-5.1.0.dev4.dist-info/METADATA,sha256=tO8lYZxV8mWijVRnkpDTrMf8dxfyDV94dLUMIxxyLYw,7148
-checkmate5-5.1.0.dev4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-checkmate5-5.1.0.dev4.dist-info/entry_points.txt,sha256=FbGnau5C4z98WmBYpMJqUzobQEr1AIi9aZApSavNojQ,60
-checkmate5-5.1.0.dev4.dist-info/top_level.txt,sha256=tl6eIJXedpLZbcbmYEwlhEzuTaSt0TvIRUesOb8gtng,10
-checkmate5-5.1.0.dev4.dist-info/RECORD,,
+checkmate5-5.1.0.dev5.dist-info/licenses/LICENSE.txt,sha256=SGQTFjJQjkYGoK1PCFfMKpfgRLm3yL0h9Mq2o26sm2E,151451
+checkmate5-5.1.0.dev5.dist-info/METADATA,sha256=hRIjiRKiF6Sjkvk8FQYN6zrokv_EyZe_9LYiPJeNqog,8340
+checkmate5-5.1.0.dev5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+checkmate5-5.1.0.dev5.dist-info/entry_points.txt,sha256=FbGnau5C4z98WmBYpMJqUzobQEr1AIi9aZApSavNojQ,60
+checkmate5-5.1.0.dev5.dist-info/top_level.txt,sha256=tl6eIJXedpLZbcbmYEwlhEzuTaSt0TvIRUesOb8gtng,10
+checkmate5-5.1.0.dev5.dist-info/RECORD,,