metabrowser 0.1.0__tar.gz

metabrowser-0.1.0/.flowmarkignore

@@ -0,0 +1,4 @@
+.agents/
+.claude/
+.tbd/
+tests/fixtures/

metabrowser-0.1.0/.gitignore

@@ -0,0 +1,190 @@
+# Additions to standard GitHub .gitignore:
+*.bak
+*.orig
+tmp/
+trash/
+
+# Python tool caches
+.ruff_cache/
+
+# JavaScript tool caches
+node_modules/
+
+# GitHub's standard Python .gitignore:
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc
+
+# Agent tool per-user local overrides (tracked scaffolding lives beside these).
+# Claude Code writes local tool-permission grants here with absolute paths.
+.claude/settings.local.json
+.codex/settings.local.json

metabrowser-0.1.0/.node-version

@@ -0,0 +1 @@
+24.18.0

metabrowser-0.1.0/.npmrc

@@ -0,0 +1,9 @@
+# Supply-chain policy (see SUPPLY-CHAIN-SECURITY.md): no lifecycle scripts,
+# exact pins, a committed lockfile, and a 14-day release cool-off.
+# min-release-age requires npm 11.10 or newer; CI and publishing pin a Node
+# release that includes a compatible npm.
+ignore-scripts=true
+engine-strict=true
+min-release-age=14
+package-lock=true
+save-exact=true

metabrowser-0.1.0/.nvmrc

@@ -0,0 +1 @@
+24.18.0

metabrowser-0.1.0/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to Metabrowser are documented here.
+
+## 0.1.0
+
+Initial standalone release:
+
+- Local file, log, Markdown, structured-data, image, and binary browsing.
+- Primary `metab` command with a `metabrowser` compatibility alias.
+- Concise zero-install and global-tool onboarding, plus a portable Agent Skill that
+  delegates to the pinned `uvx metabrowser@0.1.0` runner.
+- Trusted manifest-driven plugins with JavaScript views and Python data hooks.
+- KPress-backed Markdown rendering through `kpress==0.2.2`.
+- Gzip- and zlib-transparent previews, frontmatter classification, Markdown rendering,
+  and KPress export with bounded input, output, and text windows.
+- Background inventory indexing, live filesystem updates, and recent-file navigation.
+- SSH and optional GCP remote tunnels.
+- MIT licensing, PyPI packaging, locked uv environments, and isolated wheel checks.
+- Review hardening for bounded compressed reads, safe rendered labels, byte-accurate
+  event streaming, renderer disposal, explicitly repository-configured development
+  commands, and release builds without mutable dependency caches.
+
+<!-- This document follows common-doc-guidelines.md.
+See github.com/jlevy/practical-prose and review guidelines before editing.
+-->

metabrowser-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+Contributions are welcome through GitHub issues and pull requests.
+
+## Before You Start
+
+For a substantial change, open an issue describing the user problem, proposed contract,
+and compatibility impact.
+Security reports follow [SECURITY.md](SECURITY.md), not the public issue tracker.
+
+## Development Workflow
+
+1. Fork and clone the repository.
+2. Create a focused branch from current `main`.
+3. Install the prerequisites in [development](docs/development.md): uv and the Node
+   version pinned for your version manager.
+4. Run `make install`.
+5. Add or update tests with the implementation.
+6. Run `make format` and `make verify`.
+7. Review the diff and built artifacts for unrelated files or private data.
+8. Open a pull request with the problem, approach, validation, and compatibility notes.
+
+The project uses uv exclusively.
+Do not add requirements files or instructions that invoke raw `pip` or an activated
+virtual environment.
+
+## Scope and Compatibility
+
+Keep core generic. Consumer-specific schemas, renderers, endpoints, and styles belong in
+plugins. Add capabilities through the documented plugin SDK instead of exposing private
+shell state.
+
+Avoid breaking public CLI flags, Python plugin types, manifest fields, HTTP envelopes,
+or browser SDK methods without an explicit migration plan and release note.
+
+## Documentation and Tests
+
+Apply `tbd guidelines common-doc-guidelines` when creating or restructuring
+documentation, and format Markdown with Flowmark through `make format`. Documentation
+must be safe for a public repository and must not contain credentials, private paths,
+private issue IDs, or copied operational data.
+
+Choose the narrowest test layer that proves the behavior.
+See [end-to-end testing](docs/e2e-testing.md) for the suite structure.
+
+By contributing, you agree that your contribution is licensed under the repository’s
+[MIT License](LICENSE).
+
+<!-- This document follows common-doc-guidelines.md.
+See github.com/jlevy/practical-prose and review guidelines before editing.
+-->

metabrowser-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Joshua Levy
+
+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.

metabrowser-0.1.0/Makefile

@@ -0,0 +1,105 @@
+# Makefile for easy development workflows.
+# See docs/development.md for docs.
+# GitHub Actions use these targets so local and CI gates stay aligned.
+
+.DEFAULT_GOAL := default
+# Keep install and quality stages ordered even when callers pass `-j`.
+.NOTPARALLEL:
+
+# Safe default for every dependency resolution invoked through this Makefile.
+UV_EXCLUDE_NEWER ?= 14 days
+export UV_EXCLUDE_NEWER
+# Prevent machine-global uv policy from changing the repository lock. Pass the
+# checked-in configuration explicitly so every command is self-contained and
+# reviewable instead of depending on an inherited UV_CONFIG_FILE setting.
+UV := uv --config-file $(CURDIR)/uv.toml
+UVX := uvx --config-file $(CURDIR)/uv.toml
+UV_RUN := $(UV) run --frozen
+# First-party exception reviewed in SUPPLY-CHAIN-SECURITY.md. The cutoff is
+# package-scoped and only admits the exact formatter release pinned here.
+FLOWMARK_VERSION := 0.3.2
+FLOWMARK_EXCEPTION := 2026-07-16T00:00:00Z
+FLOWMARK := $(UVX) --exclude-newer-package 'flowmark-rs=$(FLOWMARK_EXCEPTION)' flowmark-rs@$(FLOWMARK_VERSION)
+
+# Some managed agent environments export pnpm-style npm variables that npm 11
+# treats as unknown configuration. Repository policy lives in .npmrc, so prevent
+# those ambient aliases from adding warnings or changing command behavior.
+unexport NPM_CONFIG_FROZEN_LOCKFILE
+unexport NPM_CONFIG_MINIMUM_RELEASE_AGE
+# A host-level publication cutoff conflicts with the repository's release-age gate in
+# npm 11. Repository installs must use the reviewed .npmrc policy instead.
+unexport NPM_CONFIG_BEFORE
+
+.PHONY: default install hooks-install biome-fix browser-types format format-markdown lint lint-check test audit lock upgrade build verify clean
+
+default: install format lint test
+
+install:
+	# --locked also asserts uv.lock matches pyproject.toml and uv.toml, so a
+	# stale or locally contaminated lock fails here instead of shipping.
+	$(UV) sync --all-extras --all-groups --locked
+	npm ci
+
+hooks-install: install
+	npx --no-install lefthook install
+
+biome-fix:
+	npx --no-install biome check --write --unsafe --no-errors-on-unmatched $(STAGED_FILES)
+
+browser-types:
+	npx --no-install tsc --noEmit -p tsconfig.json
+	npx --no-install tsc --noEmit -p tsconfig.legacy.json
+
+format lint lint-check test audit build: | install
+
+lint:
+	$(UV_RUN) python -m devtools.lint
+	$(UV_RUN) python -m devtools.public_hygiene
+	$(UV_RUN) python -m devtools.check_supply_chain
+
+format:
+	$(MAKE) format-markdown
+	$(UV_RUN) ruff format src tests devtools
+	npx --no-install biome format --write \
+		src/metabrowser/static src/metabrowser/builtin_plugins tests/dom \
+		biome.json package.json tsconfig.json tsconfig.legacy.json
+
+format-markdown:
+	$(FLOWMARK) --auto --inplace --nobackup .
+
+# Check-only lint, matching CI (does not modify files).
+lint-check:
+	$(UV_RUN) python -m devtools.lint --check
+	$(UV_RUN) python -m devtools.public_hygiene
+	$(UV_RUN) python -m devtools.check_supply_chain
+	$(FLOWMARK) --auto --check .
+
+test:
+	$(UV_RUN) pytest
+
+audit:
+	npm audit --audit-level=moderate
+	$(UV) --preview-features audit-command audit --frozen
+
+lock:
+	$(UV) lock
+
+upgrade:
+	$(UV) lock --upgrade
+	$(UV) sync --all-extras --all-groups --frozen
+
+build:
+	$(UV) build --clear --no-build-isolation
+	$(UV_RUN) python -m devtools.check_distribution
+
+verify: install lint-check test audit build
+
+clean:
+	-rm -rf dist/
+	-rm -rf *.egg-info/
+	-rm -rf .pytest_cache/
+	-rm -rf .ruff_cache/
+	-rm -rf .mypy_cache/
+	-rm -rf .venv/
+	-rm -rf node_modules/
+	-find . -type d -name "__pycache__" -exec rm -rf {} +