sawmill-parser 0.3.2__tar.gz → 0.5.0__tar.gz

{sawmill_parser-0.3.2 → sawmill_parser-0.5.0}/.gitignore

@@ -79,3 +79,6 @@ docs/_build/
 # OS
 .DS_Store
 Thumbs.db
+
+# Claude Code local settings
+.claude/

sawmill_parser-0.5.0/CLAUDE.md

@@ -0,0 +1,83 @@
+# Sawmill
+
+Terminal log analyser for structured tool logs. Plugins parse tool-specific
+formats (Vivado, Slang, ...); the base app filters, groups, waives
+and reports. Batch CLI for CI, Textual TUI for interactive triage.
+
+## Setup
+
+```bash
+source sourceme          # creates .venv with uv, installs dev extras, installs pre-commit
+source sourceme --clean  # rebuild the venv
+pytest tests/ -v
+python -m sphinx -b html docs docs/_build/html   # needs `uv sync --all-extras`
+```
+
+Always use `uv`, never `pip`. Activate `.venv` before running anything.
+
+## Layout
+
+```
+sawmill/
+  __main__.py      CLI entry point
+  cli/             rich-click commands, processing, reporting, formatting
+  core/            filter, severity, aggregation, config, plugin manager, waivers
+  models/          pydantic models: Message, FilterDefinition, Waiver, plugin API
+  plugin/          SawmillPlugin base class and pluggy hookspec
+  tui/             Textual app, session persistence, widgets
+  utils/           dirs, git, toml, author helpers
+tests/             mirrors sawmill/ (sawmill/core/filter.py -> tests/core/test_filter.py)
+tools/bench/       synthetic log generator and benchmark runner
+tools/sawmill-plugin-generator/   scaffolds a new plugin package
+docs/              Sphinx, furo theme; built by .github/workflows/docs.yml
+```
+
+Plugins live in their own repositories and register through the
+`sawmill.plugins` entry point. There are no built-in plugins.
+
+## Architecture rules
+
+**The plugin is the sole source of truth for the log format.** The base app
+never parses log content, detects severity, or assumes severity names exist.
+
+- Plugins implement `can_handle`, `load_and_parse` (an iterator of `Message`,
+  plugin API 2), `get_severity_levels` (required), and optionally
+  `get_filters`, `get_grouping_fields`, `extract_file_reference`.
+- Severity comparisons in the base app use `SeverityLevel.level` (an int),
+  never the string id. Any severity scheme a plugin defines must work.
+- Large logs are streamed; see `docs/performance/` before touching the
+  load path or the TUI table.
+
+## In-progress redesign
+
+The waiver and suppression system is being replaced by a manifest and rule
+model. The design, decisions and task plan are in
+`docs/development/manifest-design.rst`. Read it before changing anything
+under `core/waiver.py`, `core/suppress.py`, `core/config.py`, the CLI
+options, or TUI session persistence. The user guide pages on waivers and the
+`.sawmill` directory describe the old behaviour until Stage D of that plan.
+
+## Coding standards
+
+- PEP 8, type hints on every signature, docstrings on public classes and
+  functions. Ruff and mypy run in pre-commit.
+- Tests alongside or before implementation. Async Textual tests use
+  `app.run_test()` with `pilot`.
+- `tomli` for reading TOML, `tomli_w` for writing. Validate regexes before
+  storing them.
+
+## Git
+
+- Short, conventional commit messages. One logical change per commit.
+- No `Co-Authored-By` or generated-by lines.
+- Never modify git config.
+- Use git worktrees for parallel work.
+
+## Testing
+
+- testing will require additional plugins; see table below.
+
+| Tool | Install Path |
+|---|---|
+| Xilinx Vivado | https://github.com/sjalloq/sawmill-plugin-vivado.git |
+| Slang | https://github.com/sjalloq/sawmill-plugin-slang.git |

sawmill_parser-0.5.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.5
+Name: sawmill-parser
+Version: 0.5.0
+Summary: A configurable TUI for post-processing and filtering structured tool logs
+Project-URL: Homepage, https://github.com/sjalloq/sawmill
+Project-URL: Documentation, https://sjalloq.github.io/sawmill
+Project-URL: Repository, https://github.com/sjalloq/sawmill
+Author: Sawmill Contributors
+License: MIT
+Keywords: eda,filter,log,terminal,tui
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: pluggy>=1.3.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: rich-click>=1.7.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: textual>=0.40.0
+Requires-Dist: tomli-w>=1.0.0
+Requires-Dist: tomli>=2.0.0
+Requires-Dist: tomlkit>=0.12
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Requires-Dist: sawmill-plugin-slang; extra == 'dev'
+Requires-Dist: sawmill-plugin-vivado; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo; extra == 'docs'
+Requires-Dist: sphinx; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
+Requires-Dist: sphinx-copybutton; extra == 'docs'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="assets/sawmill.png" alt="Sawmill - Cutting through the noise" width="600">
+</p>
+
+<h1 align="center">Sawmill</h1>
+
+<p align="center">
+  <strong>A plugin-driven terminal log analyser</strong>
+</p>
+
+Sawmill filters, groups and waives messages from structured tool logs such as
+Vivado and Slang output. A batch CLI gates CI pipelines on log
+content; a terminal UI handles interactive triage. Plugins own the parsing,
+so any log format can be supported.
+
+## Install
+
+```bash
+uv tool install sawmill-parser sawmill-plugin-vivado
+```
+
+Or from a clone:
+
+```bash
+source sourceme     # creates .venv with uv and installs dev extras
+```
+
+## Usage
+
+```bash
+sawmill vivado.log                              # open one log in the TUI
+sawmill init                                    # create .sawmill/manifest.toml
+sawmill init --target pnr 'build/pnr/*.log'     # add a target
+sawmill view                                    # TUI over every target
+sawmill check --report build/report.json        # CI gate: exit 1 on unwaived failures
+sawmill report --format junit -o build/sawmill.xml
+sawmill rules unused                            # rules that matched nothing
+sawmill plugins list
+```
+
+Targets and rules live in a checked-in `.sawmill/` directory: a
+`manifest.toml` naming the targets (plugin plus log globs) and rule files
+under `.sawmill/rules/` that waive expected messages.
+
+Full documentation, including the manifest and rule formats, CLI reference,
+TUI guide, CI integration and plugin authoring, is at
+https://sjalloq.github.io/sawmill.
+
+## Plugins
+
+| Plugin | Repository |
+|--------|------------|
+| `vivado` | https://github.com/sjalloq/sawmill-plugin-vivado |
+| `slang` | https://github.com/sjalloq/sawmill-plugin-slang |
+
+Plugins register through the `sawmill.plugins` entry point and are
+auto-detected from log content. `tools/sawmill-plugin-generator` scaffolds a
+new one.
+
+## Development
+
+```bash
+source sourceme
+pytest tests/ -v
+pre-commit run --all-files
+```
+
+## License
+
+MIT

sawmill_parser-0.5.0/README.md

@@ -0,0 +1,70 @@
+<p align="center">
+  <img src="assets/sawmill.png" alt="Sawmill - Cutting through the noise" width="600">
+</p>
+
+<h1 align="center">Sawmill</h1>
+
+<p align="center">
+  <strong>A plugin-driven terminal log analyser</strong>
+</p>
+
+Sawmill filters, groups and waives messages from structured tool logs such as
+Vivado and Slang output. A batch CLI gates CI pipelines on log
+content; a terminal UI handles interactive triage. Plugins own the parsing,
+so any log format can be supported.
+
+## Install
+
+```bash
+uv tool install sawmill-parser sawmill-plugin-vivado
+```
+
+Or from a clone:
+
+```bash
+source sourceme     # creates .venv with uv and installs dev extras
+```
+
+## Usage
+
+```bash
+sawmill vivado.log                              # open one log in the TUI
+sawmill init                                    # create .sawmill/manifest.toml
+sawmill init --target pnr 'build/pnr/*.log'     # add a target
+sawmill view                                    # TUI over every target
+sawmill check --report build/report.json        # CI gate: exit 1 on unwaived failures
+sawmill report --format junit -o build/sawmill.xml
+sawmill rules unused                            # rules that matched nothing
+sawmill plugins list
+```
+
+Targets and rules live in a checked-in `.sawmill/` directory: a
+`manifest.toml` naming the targets (plugin plus log globs) and rule files
+under `.sawmill/rules/` that waive expected messages.
+
+Full documentation, including the manifest and rule formats, CLI reference,
+TUI guide, CI integration and plugin authoring, is at
+https://sjalloq.github.io/sawmill.
+
+## Plugins
+
+| Plugin | Repository |
+|--------|------------|
+| `vivado` | https://github.com/sjalloq/sawmill-plugin-vivado |
+| `slang` | https://github.com/sjalloq/sawmill-plugin-slang |
+
+Plugins register through the `sawmill.plugins` entry point and are
+auto-detected from log content. `tools/sawmill-plugin-generator` scaffolds a
+new one.
+
+## Development
+
+```bash
+source sourceme
+pytest tests/ -v
+pre-commit run --all-files
+```
+
+## License
+
+MIT

{sawmill_parser-0.3.2 → sawmill_parser-0.5.0}/docs/conf.py

@@ -18,14 +18,13 @@ templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 html_theme = "furo"
-html_static_path = ["_static"]
 
 autodoc_member_order = "bysource"
 autodoc_typehints = "description"
 
-# Suppress duplicate object warnings from Pydantic model fields
-# and dataclass fields that appear as both class-level and instance-level
-suppress_warnings = ["autodoc.duplicate_object"]
+# Render Google-style ``Attributes:`` sections as ``:ivar:`` fields so they
+# do not duplicate the attribute entries autodoc already generates.
+napoleon_use_ivar = True
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),

{sawmill_parser-0.3.2 → sawmill_parser-0.5.0}/docs/development/contributing.rst

@@ -68,37 +68,6 @@ Run manually:
 
    $ pre-commit run --all-files
 
-Docker dev loop
----------------
-
-The ``ralph-loop.sh`` script runs Claude Code in a Docker container for
-autonomous development iterations:
-
-.. code-block:: console
-
-   $ ./ralph-loop.sh --iterations 3
-   $ ./ralph-loop.sh --continuous
-
-Options:
-
-``--iterations N``
-   Run N iterations (default: 1).
-
-``--continuous``
-   Run until all tasks complete or an error occurs.
-
-``--dry-run``
-   Show what would be done without executing.
-
-``--no-docker``
-   Run directly on the host instead of in a container.
-
-``--interactive``
-   Drop into an interactive shell after each iteration.
-
-The ``Dockerfile`` builds a container with Python 3.11, Node.js, and
-Claude Code CLI pre-installed.
-
 Building docs
 -------------
 
@@ -106,8 +75,8 @@ Install documentation dependencies and build:
 
 .. code-block:: console
 
-   $ pip install -r docs/requirements.txt
-   $ cd docs && make html
+   $ uv sync --all-extras
+   $ python -m sphinx -b html docs docs/_build/html
 
 The built documentation is in ``docs/_build/html/``. Open
 ``docs/_build/html/index.html`` in a browser to review.