densitty 0.8.2__tar.gz → 1.0.0__tar.gz

densitty-1.0.0/.github/workflows/checks.yml

@@ -0,0 +1,40 @@
+# Presubmit Lint/Format/Type checking
+# For documentation on GitHub Actions Workflows, see:
+# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+name: Checks
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Check out
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        with:
+          fetch-depth: 0 # Needed for setuptools_scm to work correctly
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@681c641aba71e4a1c380be3ab5e12ad51f415867
+
+      - name: Set up Python 3.14
+        uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548
+        with:
+          python-version: 3.14
+          allow-prereleases: true
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Run lint
+        run: uv run --with pylint python -m pylint --ignore util.pyi densitty
+
+      - name: Check format
+        run: uv run --with black python -m black -l 99 --check densitty/*.py tests/*.py

densitty-1.0.0/.github/workflows/periodic.yml

@@ -0,0 +1,42 @@
+# Test on 3.10-3.15 on all platforms, weekly, just in case something breaks on
+# intermediate or beta python versions.
+
+# For documentation on GitHub Actions Workflows, see:
+# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+name: PeriodicTests
+on:
+  schedule:
+    - cron: "40 4 2,9,16,22 * *"
+
+jobs:
+  test_schedule:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14", "3.14t", "3.15"]
+      fail-fast: false
+
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Check out
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        with:
+          fetch-depth: 0 # Needed for setuptools_scm to work correctly
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@681c641aba71e4a1c380be3ab5e12ad51f415867
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548
+        with:
+          python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        run: make test-ci

densitty-1.0.0/.github/workflows/tests.yml

@@ -0,0 +1,43 @@
+# Pre-submit testing, for Python 3.10 and 3.14 on Linux/Mac/Windows
+# For documentation on GitHub Actions Workflows, see:
+# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+name: Tests
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.10", "3.14", "3.14t"]
+      fail-fast: false
+
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Check out
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        with:
+          fetch-depth: 0 # Needed for setuptools_scm to work correctly
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@681c641aba71e4a1c380be3ab5e12ad51f415867
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548
+        with:
+          python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        run: make test-ci

densitty-1.0.0/Makefile

@@ -0,0 +1,84 @@
+#TEST_PACKAGES := numpy,pytest,readchar,rich
+
+.PHONY: test-ci
+test-ci:
+	rm -rf tests/new_goldens
+	mkdir -p tests/new_goldens
+	PYTHONPATH=. uv run python -m pytest tests/*.py
+
+.PHONY: test
+test: test-ci ## Add output to show current test coverage, but no report
+	PYTHONPATH=. uv run python -m pytest --cov=densitty tests/*.py
+
+.PHONY: testcov
+testcov: ## Output test coverage report
+	PYTHONPATH=. uv run python -m pytest --cov=densitty --cov-report=html tests/*.py
+
+.PHONY: golden-accept
+golden-accept:
+	PYTHONPATH=. uv run python tests/golden_diff.py
+
+.PHONY: lint
+lint:
+## Ignore stub file, as it seems to confuse pylint
+	PYTHONPATH=. uv run python -m pylint --ignore util.pyi densitty
+
+.PHONY: format
+format:
+	uv run python -m black -l 99 densitty/*.py
+	uv run python -m black -l 99 tests/*.py
+
+.PHONY: check-format
+check-format:
+	uv run python -m black -l 99 --check densitty/*.py tests/*.py
+
+.PHONY: typecheck
+typecheck:
+	PYTHONPATH=. uv run python -m mypy densitty
+	PYTHONPATH=. uv run python -m mypy tests/numpy_tests.py
+	PYTHONPATH=. uv run python -m mypy tests/axis_tests.py
+
+.PHONY: check ## essentially the same as the presubmit checks
+check: lint check-format typecheck test
+
+.PHONY: colors
+colors:
+	PYTHONPATH=. uv run python tests/color_tests.py
+
+.PHONY: examples
+examples:
+	PYTHONPATH=. uv run python examples/run_examples.py
+
+.PHONY: screenshots
+screenshots:
+	uv run --with iterm2,pyobjc examples/generate_screenshots.py
+
+.PHONY: gallery
+gallery: screenshots
+	uv run examples/generate_example_markdown.py
+
+.PHONY: build
+build: ## Build wheel file
+	rm -rf ./dist
+	uvx --from build pyproject-build --installer uv
+
+.PHONY: tag
+tag: ## Add a Git tag and push it to origin with syntax: make tag TAG=tag_name
+ifeq ($(origin TAG),undefined)
+	$(error "ERROR: use like 'make tag TAG=tag_name'")
+else
+	@echo "Creating git tag: ${TAG}"
+	git tag -a ${TAG} -m ""
+	@echo "Pushing tag to origin: ${TAG}"
+	git push origin ${TAG}
+endif
+
+.PHONY: publish-test
+publish-test: build
+	@echo "Publishing to testpypi"
+	uvx twine upload --repository testpypi dist/*
+
+.PHONY: publish
+publish: build
+	@echo "Publishing to REAL pypi"
+	uvx twine upload dist/*

densitty-1.0.0/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.4
+Name: densitty
+Version: 1.0.0
+Summary: densitty - create textual 2-D density plots, heatmaps, and 2-D histograms in Python
+Author: Bill Tompkins
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/BillTompkins/densitty
+Keywords: densitty,ascii,ascii-art,plotting,terminal,Python
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3 :: Only
+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 :: Python :: Free Threading :: 3 - Stable
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+<h1 align="center">densitty</h1>
+<h2 align="center">Terminal-based 2-D Histogram, Density Plots, and Heatmaps in Python</h2>
+
+Generate 2-D histograms (density plots, heat maps, eye diagrams) similar to [matplotlib's hist2d](https://matplotlib.org/stable/gallery/statistics/hist.html "hist2d"), but with output in the terminal, and no external dependencies.
+
+![Plot Output](https://billtompkins.github.io/densitty/docs/inline-histplot2d.png "example output image")
+
+## [Examples/Gallery](https://billtompkins.github.io/densitty/docs/examples.html)
+
+## [Usage Notes](https://billtompkins.github.io/densitty/docs/usage.html)
+
+## [Color, Size, and Glyph Support](https://billtompkins.github.io/densitty/docs/terminal_support.html)
+
+## [API](https://billtompkins.github.io/densitty/docs/api.html)
+
+## [GitHub](https://github.com/BillTompkins/densitty/tree/main)

densitty-1.0.0/README.md

@@ -0,0 +1,16 @@
+<h1 align="center">densitty</h1>
+<h2 align="center">Terminal-based 2-D Histogram, Density Plots, and Heatmaps in Python</h2>
+
+Generate 2-D histograms (density plots, heat maps, eye diagrams) similar to [matplotlib's hist2d](https://matplotlib.org/stable/gallery/statistics/hist.html "hist2d"), but with output in the terminal, and no external dependencies.
+
+![Plot Output](https://billtompkins.github.io/densitty/docs/inline-histplot2d.png "example output image")
+
+## [Examples/Gallery](https://billtompkins.github.io/densitty/docs/examples.html)
+
+## [Usage Notes](https://billtompkins.github.io/densitty/docs/usage.html)
+
+## [Color, Size, and Glyph Support](https://billtompkins.github.io/densitty/docs/terminal_support.html)
+
+## [API](https://billtompkins.github.io/densitty/docs/api.html)
+
+## [GitHub](https://github.com/BillTompkins/densitty/tree/main)

densitty-1.0.0/densitty/__init__.py

@@ -0,0 +1,9 @@
+"""In-terminal 2-D histogram/density/heatmap plotting"""
+
+from .detect import densityplot2d, grid_heatmap, histplot2d, plot
+from .detect import GRAYSCALE, FADE_IN, RAINBOW, REV_RAINBOW
+from .axis import Axis
+from .plotting import Plot
+from .colorbar import make_colorbar
+from .binning import histogram2d
+from .smoothing import smooth2d

densitty-1.0.0/densitty/ansi.py

@@ -0,0 +1,108 @@
+"""ANSI code/color support"""
+
+# <pedantic> that the 256-color support here is not actually ANSI X3.64, though it uses ANSI-ish
+# escape sequences. I believe it was originally done in Xterm. And 4b colors (16-color)
+# are really an aixterm extension to the ANSI-specified 8-color standard. </pedantic>
+
+from typing import Optional, Sequence
+
+from .util import nearest
+
+RESET = "\033[0m"
+
+
+def compose(codes: Sequence[str]) -> str:
+    """Given a list of individual color codes, produce the full escape sequence."""
+    return f"\033[{';'.join(codes)}m"
+
+
+def colormap_16(colors):
+    """Produce a function that returns closest 4b/16color ANSI color codes from colormap.
+    Parameters
+    ----------
+    colors: Sequence[int]
+            Ordered 16-color ANSI colors corresponding to the 0.0..1.0 range
+    """
+
+    def as_colorcodes(bg_frac: Optional[float], fg_frac: Optional[float]) -> str:
+        """Return ANSI color code for 16-color value(s)
+        Parameters
+        ----------
+        fg_frac: Optional[float]
+                 Value 0.0..1.0 for foreground, or None if background-only
+        fg_frac: Optional[float]
+                 Value 0.0..1.0 for background, or None for foreground-only
+        """
+        codes = []
+        if fg_frac is not None:
+            codes += [f"{30 + nearest(colors, fg_frac)}"]
+        if bg_frac is not None:
+            codes += [f"{40 + nearest(colors, bg_frac)}"]
+        return compose(codes)
+
+    return as_colorcodes
+
+
+def colormap_256(colors):
+    """Produce a function that returns closest 8b/256color ANSI color codes from colormap.
+    Parameters
+    ----------
+    colors: Sequence[int]
+            Ordered 256-color ANSI colors corresponding to the 0.0..1.0 range
+    """
+
+    def as_colorcodes(bg_frac: Optional[float], fg_frac: Optional[float]):
+        """Return ANSI color code for 256-color value(s)
+        Parameters
+        ----------
+        fg_frac: Optional[float]
+                 Value 0.0..1.0 for foreground, or None if background-only
+        fg_frac: Optional[float]
+                 Value 0.0..1.0 for background, or None for foreground-only
+        """
+        codes = []
+        if fg_frac is not None:
+            fg = nearest(colors, fg_frac)
+            codes += [f"38;5;{fg}"]
+        if bg_frac is not None:
+            bg = nearest(colors, bg_frac)
+            codes += [f"48;5;{bg}"]
+        return compose(codes)
+
+    return as_colorcodes
+
+
+########################################################
+# Colormaps. Assumed 256-color unless suffixed with _16
+# pylint: disable=invalid-name
+
+
+# ANSI 16-color map colors in ROYGBIV order: Red, Yellow, Green, Cyan, Blue
+RAINBOW_16 = colormap_16((5, 1, 3, 2, 6))
+
+# ANSI 16-color 'rainbow', Reversed:
+REV_RAINBOW_16 = colormap_16((6, 2, 3, 1, 5))
+
+# ANSI 16-color map colors: Black, Blue, Cyan, Green, Yellow, Red, Magenta, White
+FADE_IN_16 = colormap_16((0, 4, 6, 2, 3, 1, 5, 7))
+
+# ANSI 256-color map colors in a grayscale black->white
+GRAYSCALE = colormap_256([0] + list(range(232, 256)) + [15])
+
+rainbow_256_colors = (
+    # fmt: off
+    (196, 202, 208, 214, 220, 190, 154, 118, 82, 46, 47, 48, 43, 80, 81, 39, 27, 21, 56, 91)
+    # fmt: on
+)
+RAINBOW = colormap_256(rainbow_256_colors)
+REV_RAINBOW = colormap_256(tuple(reversed(rainbow_256_colors)))
+
+BLUE_RED = colormap_256((21, 56, 91, 126, 161, 196))
+FADE_IN = colormap_256(
+    # fmt: off
+    (16, 53, 54, 55, 56, 57, 21, 21, 27, 39, 81, 80, 43, 48, 47,
+     46, 82, 118, 154, 190, 220, 214, 208, 202, 196)
+    # fmt: on
+)
+HOT = colormap_256((16, 52, 88, 124, 160, 196, 202, 208, 214, 220, 226, 227, 228, 229, 230, 231))
+COOL = colormap_256((50, 81, 111, 141, 171, 201))