konform 0.1.0__py3-none-win_amd64.whl

konform-0.1.0.dist-info/METADATA

@@ -0,0 +1,265 @@
+Metadata-Version: 2.4
+Name: konform
+Version: 0.1.0
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+License-File: LICENSE
+Summary: Multi-rule Python linter and language server — fast, configurable, CI-ready
+Keywords: konform,python,linter,imports,language-server
+Home-Page: https://github.com/benediktziegler/konform
+Author-email: Benedikt Ziegler <benediktziegler@gmail.com>
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Bug Tracker, https://github.com/benediktziegler/konform/issues
+Project-URL: Homepage, https://github.com/benediktziegler/konform
+Project-URL: Source, https://github.com/benediktziegler/konform
+
+# konform
+
+Multi-rule Python linter and language server — fast, configurable, and CI-ready.
+
+## Rules
+
+### KIS001 — Google-style imports
+
+Checks that every `from X import Y` only imports a sub-module, not an object
+(function, class, or constant), following the
+[Google Python Style Guide §2.2](https://google.github.io/styleguide/pyguide.html#22-imports).
+
+```python
+# Bad — KIS001: `join` is a function, not a module
+from os.path import join
+
+# Good
+import os.path
+from os import path       # `path` is a module
+```
+
+### KPT — User-defined pattern rules
+
+Load regex patterns from `konform_patterns.toml` (auto-discovered next to
+`pyproject.toml`) or inline in `pyproject.toml`:
+
+```toml
+[[tool.konform.KPT.rules]]
+id      = "KPT001"
+message = "Use the project logger instead of bare print()."
+pattern = '^\s*print\s*\('
+files   = ["src/**/*.py"]
+level   = "warning"
+```
+
+## Installation
+
+```bash
+pip install konform
+```
+
+Wheels ship a pre-compiled Rust binary — no Rust installation needed at runtime.
+
+## Usage
+
+```bash
+# Lint all Python files under src/
+konform check src/
+
+# Lint and apply auto-fixes in one pass
+konform check --fix src/
+
+# Apply fixes only (no lint report)
+konform check --fix src/
+
+# Show a unified diff of what format would change
+konform check --diff src/
+
+# Output violations as JSON (e.g. for tooling)
+konform check --output-format json src/
+
+# Suppress hints and summary (violations only)
+konform check -q src/
+
+# No output — just exit 1 on violations
+konform check -s src/
+
+# List all rules
+konform rule --list
+
+# Explain a rule
+konform rule --explain KIS001
+
+# Clear the local cache
+konform clean
+```
+
+## Configuration
+
+Add a `[tool.konform]` section to `pyproject.toml` (or a standalone `konform.toml`):
+
+```toml
+[tool.konform]
+select    = []        # [] = all rules; prefix match: "KIS" = all KIS* rules
+ignore    = []
+level     = "error"   # "warning" | "error"
+cache_dir = ".konform_cache"
+workers   = 0         # 0 = os.cpu_count()
+
+# ── KIS — import style ────────────────────────────────────────────────────
+[tool.konform.KIS]
+exceptions = [
+    "__future__", "typing", "typing_extensions", "collections.abc",
+    "mycompany.compat",
+]
+level = "error"
+unresolved_level = "warning"   # "warning" (default) | "error" | "off"
+                                # Used when a package isn't installed in this
+                                # environment, so KIS001 can't tell whether the
+                                # imported name is a module or not.
+
+# ── KPT — user-defined patterns ───────────────────────────────────────────
+[tool.konform.KPT]
+level = "warning"
+# Optional: load patterns from an external file instead of inline rules.
+# rules_file = "konform_patterns.toml"
+
+[[tool.konform.KPT.rules]]
+id      = "KPT001"
+message = "Use the project logger instead of bare print()."
+pattern = '^\s*print\s*\('
+files   = ["src/**/*.py"]
+level   = "warning"
+```
+
+### Pattern files
+
+Patterns can also live in a standalone `konform_patterns.toml` placed next to
+`pyproject.toml`. konform auto-discovers it (no config key needed):
+
+```toml
+# konform_patterns.toml
+[[rules]]
+id      = "KPT002"
+message = "Remove breakpoint() — debugging artefact."
+pattern = '^\s*breakpoint\s*\(\s*\)'
+level   = "error"
+```
+
+## Suppressing violations
+
+```python
+from os.path import join   # noqa: KIS001   ← exact rule
+from os.path import join   # noqa: KIS       ← whole category
+from os.path import join   # noqa             ← everything on this line
+```
+
+### Aliasing noqa codes
+
+When a rule code changes (e.g. a rule is renamed, or a project migrates
+from another linter's codes), old `# noqa` comments would otherwise stop
+working. Define aliases in your config so they keep suppressing the
+renamed/canonical rule:
+
+```toml
+# pyproject.toml
+[tool.konform.noqa_aliases]
+IS001 = "KIS001"
+IS    = "KIS"
+```
+
+```python
+from os.path import join   # noqa: IS001   ← suppresses KIS001 via alias
+```
+
+## Language Server (LSP)
+
+konform ships a built-in LSP server that shares the same rule engine as the
+CLI — no second process, no stale results.
+
+```bash
+konform server   # starts the LSP over stdin/stdout
+```
+
+### Neovim (nvim-lspconfig)
+
+```lua
+vim.api.nvim_create_autocmd("FileType", {
+  pattern = "python",
+  callback = function()
+    vim.lsp.start({
+      name = "konform",
+      cmd  = { "konform", "server" },
+      root_dir = vim.fs.dirname(
+        vim.fs.find({ "pyproject.toml", "konform.toml" }, { upward = true })[1]
+      ),
+    })
+  end,
+})
+```
+
+### VS Code (`settings.json`)
+
+Add via the generic
+[`None ls`](https://marketplace.visualstudio.com/items?itemName=esbenp.none-ls-vscode)
+or any client that supports a custom LSP command:
+
+```json
+{
+  "nls.server": {
+    "command": ["konform", "server"]
+  }
+}
+```
+
+### Zed
+
+```json
+{
+  "lsp": {
+    "konform": {
+      "binary": {
+        "path": "konform",
+        "arguments": ["server"]
+      }
+    }
+  }
+}
+```
+
+## Development
+
+```bash
+# Compile the Rust binary and install it in the dev venv (required before tests)
+hatch run develop
+
+# Run tests with coverage
+hatch test -c
+
+# Build release wheels for all platforms
+hatch run maturin:build-all
+```
+
+## CLI reference
+
+```
+konform check  [OPTIONS] <PATHS>…    Lint files (default subcommand)
+konform check --fix-only [OPTIONS] <PATHS>…  Apply all auto-fixes in-place, exit 0
+konform server                       Start the LSP server (stdin/stdout)
+konform rule   --list                List all rules
+konform rule   --explain <CODE>      Show full rule documentation
+konform clean  [--config PATH]       Delete the cache directory
+konform version                      Print konform's version
+
+Global options (available on all subcommands):
+  --color auto|always|never          Colour output control
+  --isolated                         Ignore all config files
+  -v / --verbose                     Extra output
+  -q / --quiet                       Violations only (no summary/hints)
+  -s / --silent                      No output; exit code only
+```
+

konform-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+konform-0.1.0.data/scripts/konform.exe,sha256=795KpXaJohYKC4d4ugTIctMIDEZ-N0ZhGv4z3eoJZso,7414784
+konform-0.1.0.dist-info/METADATA,sha256=RrmLvNAttvAnDiAOZY5EcMcXw0w-x4prp4WCRRTDFpk,7498
+konform-0.1.0.dist-info/WHEEL,sha256=8Aej0W0a6Cz6apA3IzJrTnxLRVLAt-w0Oh8SA3Con_c,94
+konform-0.1.0.dist-info/licenses/LICENSE,sha256=JTqvz-BECEbtxIvxL56QkuZXnV1daKGXip_Xcb2vPnQ,1094
+konform-0.1.0.dist-info/sboms/konform.cyclonedx.json,sha256=R7a1xYOZyziejBvZAJvukAJvHr_5FrrbfVEbUUpQjaU,183091
+konform-0.1.0.dist-info/RECORD,,

konform-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.15.0)
+Root-Is-Purelib: false
+Tag: py3-none-win_amd64

konform-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Benedikt Ziegler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.