qx-devtools 0.2.0__tar.gz

qx_devtools-0.2.0/.gitignore

@@ -0,0 +1,56 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+.Python
+*.so
+*.egg
+*.egg-info/
+dist/
+build/
+eggs/
+.eggs/
+sdist/
+wheels/
+*.egg-link
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# uv
+.uv/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Type checking
+.mypy_cache/
+.ruff_cache/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Docker
+*.env.local
+
+# Dist artifacts
+dist/
+
+# VS Code extension build artifacts
+extensions/vscode/node_modules/
+extensions/vscode/dist/
+extensions/vscode/*.vsix

qx_devtools-0.2.0/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.4
+Name: qx-devtools
+Version: 0.2.0
+Summary: Qx devtools: ruff/mypy/pre-commit presets, code quality helpers
+Author: Qx Engineering
+License: MIT
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# qx-devtools
+
+Shared code-quality configuration presets for Qx services — ruff, mypy, pre-commit, and editorconfig in one place.
+
+## What lives here
+
+- **`qx.devtools.RUFF_CONFIG`** — string constant with the standard ruff configuration (line length 100, full lint rule set, per-file ignores for tests and Alembic).
+- **`qx.devtools.MYPY_CONFIG`** — string constant with strict mypy configuration (`strict = True`, pydantic plugin, test/alembic exclusions).
+- **`qx.devtools.PRE_COMMIT_CONFIG`** — string constant with a pre-commit config that runs ruff, ruff-format, mypy, and standard file-hygiene hooks.
+- **`qx.devtools.EDITORCONFIG`** — string constant with the standard `.editorconfig` (UTF-8, LF, 4-space indent).
+- **`qx.devtools.write_configs`** — writes any combination of the above files into a target directory. Skips existing files unless `overwrite=True`.
+
+## Usage
+
+Write the standard config files into a new service's root directory:
+
+```python
+from pathlib import Path
+from qx.devtools import write_configs
+
+written = write_configs(Path("my-service/"), ruff=True, mypy=True, pre_commit=True)
+print(f"Written: {[str(p) for p in written]}")
+```
+
+Or call it from the CLI during service scaffolding:
+
+```bash
+uv run python -c "from qx.devtools import write_configs; from pathlib import Path; write_configs(Path('.'))"
+```
+
+## Design rules
+
+- The config strings are plain text constants so services can read, extend, or compose from them without parsing TOML/YAML.
+- `write_configs` is intentionally conservative: it never overwrites by default. Run with `overwrite=True` only when you want to pull in updated framework defaults.
+- Services that want to diverge from a specific rule should do so in their own config file rather than forking the preset — extend, don't override wholesale.

qx_devtools-0.2.0/README.md

@@ -0,0 +1,35 @@
+# qx-devtools
+
+Shared code-quality configuration presets for Qx services — ruff, mypy, pre-commit, and editorconfig in one place.
+
+## What lives here
+
+- **`qx.devtools.RUFF_CONFIG`** — string constant with the standard ruff configuration (line length 100, full lint rule set, per-file ignores for tests and Alembic).
+- **`qx.devtools.MYPY_CONFIG`** — string constant with strict mypy configuration (`strict = True`, pydantic plugin, test/alembic exclusions).
+- **`qx.devtools.PRE_COMMIT_CONFIG`** — string constant with a pre-commit config that runs ruff, ruff-format, mypy, and standard file-hygiene hooks.
+- **`qx.devtools.EDITORCONFIG`** — string constant with the standard `.editorconfig` (UTF-8, LF, 4-space indent).
+- **`qx.devtools.write_configs`** — writes any combination of the above files into a target directory. Skips existing files unless `overwrite=True`.
+
+## Usage
+
+Write the standard config files into a new service's root directory:
+
+```python
+from pathlib import Path
+from qx.devtools import write_configs
+
+written = write_configs(Path("my-service/"), ruff=True, mypy=True, pre_commit=True)
+print(f"Written: {[str(p) for p in written]}")
+```
+
+Or call it from the CLI during service scaffolding:
+
+```bash
+uv run python -c "from qx.devtools import write_configs; from pathlib import Path; write_configs(Path('.'))"
+```
+
+## Design rules
+
+- The config strings are plain text constants so services can read, extend, or compose from them without parsing TOML/YAML.
+- `write_configs` is intentionally conservative: it never overwrites by default. Run with `overwrite=True` only when you want to pull in updated framework defaults.
+- Services that want to diverge from a specific rule should do so in their own config file rather than forking the preset — extend, don't override wholesale.

qx_devtools-0.2.0/pyproject.toml

@@ -0,0 +1,16 @@
+[project]
+name = "qx-devtools"
+version = "0.2.0"
+description = "Qx devtools: ruff/mypy/pre-commit presets, code quality helpers"
+readme = "README.md"
+requires-python = ">=3.14"
+license = { text = "MIT" }
+authors = [{ name = "Qx Engineering" }]
+dependencies = []
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/qx"]

qx_devtools-0.2.0/src/qx/devtools/__init__.py

@@ -0,0 +1,140 @@
+"""Qx devtools: shared code-quality configuration.
+
+Services pin to the same lint/type/format rules by extending the framework
+config rather than re-declaring it. The text constants here let a service's
+pyproject.toml or pre-commit config compose from a single source of truth.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+__version__ = "0.2.0"
+
+__all__ = [
+    "EDITORCONFIG",
+    "MYPY_CONFIG",
+    "PRE_COMMIT_CONFIG",
+    "RUFF_CONFIG",
+    "__version__",
+    "write_configs",
+]
+
+
+RUFF_CONFIG = """\
+# Generated by qx-devtools — pin to framework conventions
+line-length = 100
+target-version = "py312"
+
+[lint]
+select = [
+    "E", "W", "F", "I", "B", "C4", "UP", "N", "S", "RUF", "PL", "ASYNC", "PERF",
+]
+ignore = ["E501", "S101", "PLR0913"]
+
+[lint.per-file-ignores]
+"tests/**" = ["S", "PLR2004"]
+"alembic/versions/**" = ["F401", "E402"]
+
+[format]
+quote-style = "double"
+docstring-code-format = true
+"""
+
+MYPY_CONFIG = """\
+# Generated by qx-devtools
+[mypy]
+python_version = 3.12
+strict = True
+warn_redundant_casts = True
+warn_unused_ignores = True
+warn_return_any = True
+warn_unreachable = True
+plugins = pydantic.mypy
+
+[mypy-tests.*]
+disallow_untyped_defs = False
+
+[mypy-alembic.versions.*]
+ignore_errors = True
+"""
+
+
+PRE_COMMIT_CONFIG = """\
+# Generated by qx-devtools
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.11.2
+    hooks:
+      - id: mypy
+        additional_dependencies: [pydantic, types-PyYAML]
+        args: [--strict]
+        exclude: ^(tests/|alembic/)
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: check-toml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+"""
+
+
+EDITORCONFIG = """\
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,toml,yaml,yml,json}]
+indent_style = space
+indent_size = 4
+"""
+
+
+def write_configs(
+    target: Path,
+    *,
+    ruff: bool = True,
+    mypy: bool = True,
+    pre_commit: bool = True,
+    editorconfig: bool = True,
+    overwrite: bool = False,
+) -> list[Path]:
+    """Write the standard config files into a project directory.
+
+    Returns the list of files written. Files that already exist are skipped
+    unless ``overwrite=True``.
+    """
+    target = Path(target)
+    target.mkdir(parents=True, exist_ok=True)
+    written: list[Path] = []
+
+    files: list[tuple[str, str]] = []
+    if ruff:
+        files.append(("ruff.toml", RUFF_CONFIG))
+    if mypy:
+        files.append(("mypy.ini", MYPY_CONFIG))
+    if pre_commit:
+        files.append((".pre-commit-config.yaml", PRE_COMMIT_CONFIG))
+    if editorconfig:
+        files.append((".editorconfig", EDITORCONFIG))
+
+    for name, content in files:
+        path = target / name
+        if path.exists() and not overwrite:
+            continue
+        path.write_text(content, encoding="utf-8")
+        written.append(path)
+    return written

qx_devtools-0.2.0/tests/test_devtools.py

@@ -0,0 +1,50 @@
+"""qx-devtools tests — config writers produce expected files."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from qx.devtools import (
+    EDITORCONFIG,
+    MYPY_CONFIG,
+    PRE_COMMIT_CONFIG,
+    RUFF_CONFIG,
+    write_configs,
+)
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+def test_constants_present() -> None:
+    assert "line-length" in RUFF_CONFIG
+    assert "python_version" in MYPY_CONFIG
+    assert "pre-commit" in PRE_COMMIT_CONFIG or "ruff" in PRE_COMMIT_CONFIG
+    assert "root = true" in EDITORCONFIG
+
+
+def test_write_configs_creates_all_four(tmp_path: Path) -> None:
+    written = write_configs(tmp_path)
+    names = {p.name for p in written}
+    assert names == {"ruff.toml", "mypy.ini", ".pre-commit-config.yaml", ".editorconfig"}
+    for p in written:
+        assert p.read_text().strip()
+
+
+def test_write_configs_respects_existing(tmp_path: Path) -> None:
+    (tmp_path / "ruff.toml").write_text("# user-customized")
+    written = write_configs(tmp_path)
+    assert not any(p.name == "ruff.toml" for p in written)
+    assert (tmp_path / "mypy.ini").exists()
+
+
+def test_write_configs_overwrite_flag(tmp_path: Path) -> None:
+    (tmp_path / "ruff.toml").write_text("# user-customized")
+    written = write_configs(tmp_path, overwrite=True)
+    assert any(p.name == "ruff.toml" for p in written)
+    assert "line-length" in (tmp_path / "ruff.toml").read_text()
+
+
+def test_write_configs_selective(tmp_path: Path) -> None:
+    written = write_configs(tmp_path, ruff=True, mypy=False, pre_commit=False, editorconfig=False)
+    assert {p.name for p in written} == {"ruff.toml"}