qansitextviewer 0.1.0__tar.gz

qansitextviewer-0.1.0/.githooks/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+# Installed via `just hooks` (sets git core.hooksPath to .githooks/).
+# Rejects non-conventional commit messages before they are created.
+uv run cz check --commit-msg-file "$1"

qansitextviewer-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,81 @@
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+
+permissions:
+  contents: read
+
+env:
+  QT_QPA_PLATFORM: offscreen
+  UV_PYTHON: "3.14"
+
+jobs:
+  test:
+    name: test (py${{ matrix.python-version }})
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.14"]
+    env:
+      UV_PYTHON: ${{ matrix.python-version }}
+    steps:
+      # Pinned to actions/checkout v7.0.1.
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+      # Pinned to astral-sh/setup-uv v10.1.0.
+      - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4
+      - name: Install Qt runtime libs
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            libgl1 libegl1 libxkbcommon0 libdbus-1-3 libfontconfig1
+      - name: Sync dependencies
+        run: uv sync --group dev
+      - name: Run tests
+        run: uv run --no-sync pytest -p no:cacheprovider -q
+
+  lint:
+    name: lint
+    runs-on: ubuntu-24.04
+    steps:
+      # Pinned to actions/checkout v7.0.1.
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+      # Pinned to astral-sh/setup-uv v10.1.0.
+      - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4
+      - name: Check lockfile is in sync
+        run: uv lock --check
+      - name: Ruff check
+        run: uvx ruff@0.16.7 check ansi_text_viewer demo.py main.py tests
+      - name: Ruff format check
+        run: uvx ruff@0.16.7 format --check ansi_text_viewer demo.py main.py tests
+
+  typecheck:
+    name: typecheck
+    runs-on: ubuntu-24.04
+    steps:
+      # Pinned to actions/checkout v7.0.1.
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+      # Pinned to astral-sh/setup-uv v10.1.0.
+      - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4
+      - name: Sync dependencies
+        run: uv sync --group dev
+      - name: mypy
+        run: uv run --no-sync mypy ansi_text_viewer
+      - name: ty
+        run: uv run --no-sync ty check ansi_text_viewer
+
+  docs:
+    name: docs
+    runs-on: ubuntu-24.04
+    steps:
+      # Pinned to actions/checkout v7.0.1.
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+      # Pinned to astral-sh/setup-uv v10.1.0.
+      - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4
+      - name: Sync dependencies
+        run: uv sync --group dev
+      - name: Build docs
+        run: uv run --no-sync mkdocs build

qansitextviewer-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,45 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: build
+    runs-on: ubuntu-24.04
+    steps:
+      # Pinned to actions/checkout v7.0.1.
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+      # Pinned to astral-sh/setup-uv v10.1.0.
+      - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4
+      - name: Sync dependencies
+        run: uv sync --group dev
+      - name: Build docs
+        run: uv run --no-sync mkdocs build --site-dir site
+      # Pinned to actions/upload-pages-artifact v5.0.0.
+      - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9
+        with:
+          path: site
+
+  deploy:
+    name: deploy
+    needs: build
+    runs-on: ubuntu-24.04
+    permissions:
+      pages: write
+      id-token: write
+    concurrency:
+      group: github-pages
+      cancel-in-progress: false
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy.outputs.page_url }}
+    steps:
+      # Pinned to actions/deploy-pages v5.0.1.
+      - id: deploy
+        uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346

qansitextviewer-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,81 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Existing tag to release (e.g. v0.2.0)."
+        required: true
+
+permissions:
+  contents: read
+
+jobs:
+  release:
+    name: release
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+    env:
+      TAG: ${{ inputs.tag || github.ref_name }}
+    steps:
+      # Pinned to actions/checkout v7.0.1.
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+        with:
+          fetch-depth: 0
+      # Pinned to astral-sh/setup-uv v10.1.0.
+      - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4
+      - name: Build distributions
+        run: uv build
+      - name: Check distributions
+        run: uv run --with twine twine check dist/*
+      - name: Extract release notes
+        run: |
+          python - <<'EOF'
+          import os
+          import re
+
+          tag = os.environ["TAG"]
+          version = tag[1:] if tag.startswith("v") else tag
+          text = open("CHANGELOG.md", encoding="utf-8").read()
+          match = re.search(
+              rf"^## \[{re.escape(version)}\].*?\n(.*?)(?=^## \[|\Z)",
+              text,
+              re.S | re.M,
+          )
+          if not match:
+              raise SystemExit(f"No CHANGELOG entry for [{version}]")
+          with open("release-notes.md", "w", encoding="utf-8") as f:
+              f.write(match.group(1).strip() + "\n")
+          EOF
+      - name: Create release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          if ! gh release view "$TAG" >/dev/null 2>&1; then
+            gh release create "$TAG" \
+              --title "$TAG" \
+              --notes-file release-notes.md \
+              dist/*
+          else
+            gh release upload "$TAG" dist/* --clobber
+          fi
+
+  publish-pypi:
+    name: publish-pypi
+    needs: release
+    runs-on: ubuntu-24.04
+    permissions:
+      id-token: write
+    steps:
+      # Pinned to actions/checkout v7.0.1.
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+      # Pinned to astral-sh/setup-uv v10.1.0.
+      - uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4
+      - name: Build distributions
+        run: uv build
+      - name: Publish to PyPI
+        run: uv publish --trusted-publishing always

qansitextviewer-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

qansitextviewer-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14

qansitextviewer-0.1.0/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+All notable changes to this project are documented here, newest first.
+Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [0.1.0] - 2026-09-17
+
+### Added
+
+- Async non-blocking appends (`appendAnsiTextAsync`, progress/finished
+  signals, cancel) with byte-identical output to the sync path.
+- Pluggable highlight rules (`HighlightRule` protocol, `Span`,
+  `add_highlight_rule`) covering log levels, tracebacks, JSON, CMake,
+  justfiles, URLs, and `file:line` links.
+- Theme-following default text colors with manual override
+  (`setDefaultColors`, `setColorsFollowTheme`) and session persistence.
+- Font controls (`setFontSize`, `setFontFamily`, `useSystemFont`).
+- Strict boolean parsing (`"false"`/`"0"`/`"off"` work) and symmetric
+  `is...()` getters for every flag.
+- Bookmarks stored on text blocks; gutter click, list panel, navigation
+  skips filtered-out lines.
+- Sessions (JSON save/load with validation), export (txt/html/md),
+  selection stats, current-line highlight, max-blocks/line-length caps.
+- Color knobs (`setLogLevelColors`, `setBookmarkColor`,
+  `setSearchHighlightColor` active color, `currentLineColor`).
+- Debug diagnostics: every silent fallback logs on the `ansi_text_viewer`
+  logger; contract violations raise with the offender named.
+- Tooling: pytest suite, ruff (Google docstrings), mypy + ty, MkDocs API
+  docs with gallery, SHA-pinned CI on Python 3.11–3.14, commitizen with
+  conventional commits and Pages deploy workflow.
+- Packaging: PyPI metadata (license, classifiers, authors, URLs),
+  `py.typed` marker verified in the wheel via `twine check`.
+
+### Changed
+
+- Default text colors now follow the theme instead of fixed
+  terminal white-on-black.
+- Links open on ++ctrl+click++ only (was: single click).
+- Python requirement lowered to `>=3.11`.
+
+### Removed
+
+- `test.py` demo shim — import the demo from `demo` instead:
+  `from demo import TestWindow`.