ultraplot 1.71.0__tar.gz

ultraplot-1.71.0/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,31 @@
+<!-- Thanks for helping us make ultraplot a better package! If this is a bug report, please use the template provided below. If this is a feature request, you can delete the template text (just try to be descriptive with your request). -->
+
+### Description
+
+[Description of the bug or feature.]
+
+### Steps to reproduce
+
+A "[Minimal, Complete and Verifiable Example](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)" will make it much easier for maintainers to help you.
+
+```python
+# your code here
+# we should be able to copy-paste this into python and exactly reproduce your bug
+```
+
+**Expected behavior**: [What you expected to happen]
+
+**Actual behavior**: [What actually happened]
+
+### Equivalent steps in matplotlib
+
+Please try to make sure this bug is related to a ultra-specific feature. If you're not sure, try to replicate it with the [native matplotlib API](https://matplotlib.org/3.1.1/api/index.html). Matplotlib bugs belong on the [matplotlib github page](https://github.com/matplotlib/matplotlib).
+
+```python
+# your code here, if applicable
+import matplotlib.pyplot as plt
+```
+
+### Ultra version
+
+Paste the results of `import matplotlib; print(matplotlib.__version__); import ultra; print(ultra.version)` here.

ultraplot-1.71.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    groups:
+      github-actions:
+        patterns:
+          - '*'

ultraplot-1.71.0/.github/workflows/build-ultraplot.yml

@@ -0,0 +1,130 @@
+name: Build and Test
+on:
+  workflow_call:
+    inputs:
+      python-version:
+        required: true
+        type: string
+      matplotlib-version:
+        required: true
+        type: string
+
+env:
+  LC_ALL: en_US.UTF-8
+  LANG: en_US.UTF-8
+
+jobs:
+  build-ultraplot:
+    name: Test Python ${{ inputs.python-version }} with MPL ${{ inputs.matplotlib-version }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    defaults:
+      run:
+        shell: bash -el {0}
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - uses: mamba-org/setup-micromamba@v2.0.7
+        with:
+          environment-file: ./environment.yml
+          init-shell: bash
+          create-args: >-
+            --verbose
+            python=${{ inputs.python-version }}
+            matplotlib=${{ inputs.matplotlib-version }}
+          cache-environment: true
+          cache-downloads: false
+
+      - name: Build Ultraplot
+        run: |
+          pip install --no-build-isolation --no-deps .
+
+      - name: Test Ultraplot
+        run: |
+          pytest -n auto --cov=ultraplot --cov-branch --cov-report term-missing --cov-report=xml ultraplot
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: Ultraplot/ultraplot
+
+  compare-baseline:
+    name: Compare baseline Python ${{ inputs.python-version }} with MPL ${{ inputs.matplotlib-version }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -el {0}
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: mamba-org/setup-micromamba@v2.0.7
+        with:
+          environment-file: ./environment.yml
+          init-shell: bash
+          create-args: >-
+            --verbose
+            python=${{ inputs.python-version }}
+            matplotlib=${{ inputs.matplotlib-version }}
+          cache-environment: true
+          cache-downloads: false
+
+      # Cache Baseline Figures (Restore step)
+      - name: Cache Baseline Figures
+        id: cache-baseline
+        uses: actions/cache@v4
+        with:
+          path: ./ultraplot/tests/baseline # The directory to cache
+          # Key is based on OS, Python/Matplotlib versions, and the PR number
+          key: ${{ runner.os }}-baseline-pr-${{ github.event.pull_request.number }}-${{ inputs.python-version }}-${{ inputs.matplotlib-version }}
+          restore-keys: |
+            ${{ runner.os }}-baseline-pr-${{ github.event.pull_request.number }}-${{ inputs.python-version }}-${{ inputs.matplotlib-version }}-
+
+      # Conditional Baseline Generation (Only runs on cache miss)
+      - name: Generate baseline from main
+        # Skip this step if the cache was found (cache-hit is true)
+        if: steps.cache-baseline.outputs.cache-hit != 'true'
+        run: |
+          mkdir -p ultraplot/tests/baseline
+          # Checkout the base branch (e.g., 'main') to generate the official baseline
+          git fetch origin ${{ github.event.pull_request.base.sha }}
+          git checkout ${{ github.event.pull_request.base.sha }}
+
+          # Install the Ultraplot version from the base branch's code
+          pip install --no-build-isolation --no-deps .
+
+          # Generate the baseline images and hash library
+          python -c "import ultraplot as plt; plt.config.Configurator()._save_yaml('ultraplot.yml')"
+          pytest -x -W ignore \
+            --mpl-generate-path=./ultraplot/tests/baseline/ \
+            --mpl-default-style="./ultraplot.yml"\
+            ultraplot/tests
+
+          # Return to the PR branch for the rest of the job
+          git checkout ${{ github.sha }}
+
+      # Image Comparison (Uses cached or newly generated baseline)
+      - name: Image Comparison Ultraplot
+        run: |
+          # Re-install the Ultraplot version from the current PR branch
+          pip install --no-build-isolation --no-deps .
+
+          mkdir -p results
+          python -c "import ultraplot as plt; plt.config.Configurator()._save_yaml('ultraplot.yml')"
+          pytest -x -W ignore \
+            --mpl \
+            --mpl-baseline-path=./ultraplot/tests/baseline \
+            --mpl-results-path=./results/ \
+            --mpl-generate-summary=html \
+            --mpl-default-style="./ultraplot.yml" \
+            ultraplot/tests
+
+      # Return the html output of the comparison even if failed
+      - name: Upload comparison failures
+        if: always()
+        uses: actions/upload-artifact@v6
+        with:
+          name: failed-comparisons-${{ inputs.python-version }}-${{ inputs.matplotlib-version }}-${{ github.sha }}
+          path: results/*

ultraplot-1.71.0/.github/workflows/main.yml

@@ -0,0 +1,155 @@
+name: Matrix Test
+on:
+  push:
+    branches: [main, devel]
+  pull_request:
+    branches: [main, devel]
+
+jobs:
+  run-if-changes:
+    runs-on: ubuntu-latest
+    outputs:
+      run: ${{ (github.event_name == 'push' && github.ref_name == 'main') && 'true' || steps.filter.outputs.python }}
+    steps:
+      - uses: actions/checkout@v6
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            python:
+              - 'ultraplot/**'
+
+  get-versions:
+    runs-on: ubuntu-latest
+    needs:
+      - run-if-changes
+    if: always() && needs.run-if-changes.outputs.run == 'true'
+    outputs:
+      python-versions: ${{ steps.set-versions.outputs.python-versions }}
+      matplotlib-versions: ${{ steps.set-versions.outputs.matplotlib-versions }}
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: pip install tomli
+
+      - id: set-versions
+        run: |
+          # Create a Python script to read and parse versions
+          cat > get_versions.py << 'EOF'
+          import tomli
+          import re
+          import json
+
+          # Read pyproject.toml
+          with open("pyproject.toml", "rb") as f:
+              data = tomli.load(f)
+
+          # Get Python version requirement
+          python_req = data["project"]["requires-python"]
+
+          # Parse min and max versions
+          min_version = re.search(r">=(\d+\.\d+)", python_req)
+          max_version = re.search(r"<(\d+\.\d+)", python_req)
+
+          python_versions = []
+          if min_version and max_version:
+              # Convert version strings to tuples
+              min_v = tuple(map(int, min_version.group(1).split(".")))
+              max_v = tuple(map(int, max_version.group(1).split(".")))
+
+              # Generate version list
+              current = min_v
+              while current < max_v:
+                  python_versions.append(".".join(map(str, current)))
+                  current = (current[0], current[1] + 1)
+
+
+          # parse MPL versions
+          mpl_req = None
+          for d in data["project"]["dependencies"]:
+            if d.startswith("matplotlib"):
+              mpl_req = d
+              break
+          assert mpl_req is not None, "matplotlib version not found in dependencies"
+          min_version = re.search(r">=(\d+\.\d+)", mpl_req)
+          max_version = re.search(r"<(\d+\.\d+)", mpl_req)
+
+          mpl_versions = []
+          if min_version and max_version:
+              # Convert version strings to tuples
+              min_v = tuple(map(int, min_version.group(1).split(".")))
+              max_v = tuple(map(int, max_version.group(1).split(".")))
+
+              # Generate version list
+              current = min_v
+              while current < max_v:
+                  mpl_versions.append(".".join(map(str, current)))
+                  current = (current[0], current[1] + 1)
+
+          # If no versions found, default to 3.9
+          if not mpl_versions:
+              mpl_versions = ["3.9"]
+
+          # Create output dictionary
+          output = {
+              "python_versions": python_versions,
+              "matplotlib_versions": mpl_versions
+          }
+
+          # Print as JSON
+          print(json.dumps(output))
+          EOF
+
+          # Run the script and capture output
+          OUTPUT=$(python3 get_versions.py)
+          PYTHON_VERSIONS=$(echo $OUTPUT | jq -r '.python_versions')
+          MPL_VERSIONS=$(echo $OUTPUT | jq -r '.matplotlib_versions')
+
+          echo "Detected Python versions: ${PYTHON_VERSIONS}"
+          echo "Detected Matplotlib versions: ${MPL_VERSIONS}"
+          echo "python-versions=$(echo $PYTHON_VERSIONS | jq -c)" >> $GITHUB_OUTPUT
+          echo "matplotlib-versions=$(echo $MPL_VERSIONS | jq -c)" >> $GITHUB_OUTPUT
+
+  build:
+    needs:
+      - get-versions
+      - run-if-changes
+    if: always() && needs.run-if-changes.outputs.run == 'true' && needs.get-versions.result == 'success'
+    strategy:
+      matrix:
+        python-version: ${{ fromJson(needs.get-versions.outputs.python-versions) }}
+        matplotlib-version: ${{ fromJson(needs.get-versions.outputs.matplotlib-versions) }}
+      fail-fast: false
+    uses: ./.github/workflows/build-ultraplot.yml
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}-${{ matrix.python-version }}-${{ matrix.matplotlib-version }}
+      cancel-in-progress: true
+    with:
+      python-version: ${{ matrix.python-version }}
+      matplotlib-version: ${{ matrix.matplotlib-version }}
+
+  build-success:
+    needs:
+      - build
+      - run-if-changes
+    if: always()
+    runs-on: ubuntu-latest
+    steps:
+      - run: |
+          if [[ '${{ needs.run-if-changes.outputs.run }}' == 'false' ]]; then
+            echo "No changes detected, tests skipped."
+          else
+            if [[ '${{ needs.build.result }}' == 'success' ]]; then
+              echo "All tests passed successfully!"
+            else
+              echo "Tests failed!"
+              exit 1
+            fi
+          fi

ultraplot-1.71.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,121 @@
+name: Publish to PyPI
+on:
+  pull_request:
+  release:
+    types: [published]
+  push:
+    tags: ["v*"]
+
+concurrency:
+  group: publish-pypi-{{ github.sha }}
+  cancel-in-progress: false
+
+jobs:
+  build-packages:
+    name: Build packages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Get tags
+        run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
+        shell: bash
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Build package
+        run: |
+          python -m pip install --upgrade pip wheel setuptools setuptools_scm build twine
+          python -m build --sdist --wheel . --outdir dist
+
+      - name: Check files
+        run: |
+          ls dist
+        shell: bash
+
+      - name: Test wheels
+        run: |
+          pushd dist
+          python -m pip install ultraplot*.whl
+
+          version=$(python -c "import ultraplot; print(ultraplot.__version__)")
+          echo "Version: $version"
+          if [[ "$version" == "0."* ]]; then
+            echo "Version is not set correctly!"
+            exit 1
+          fi
+
+          python -m twine check *
+          popd
+        shell: bash
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v6
+        with:
+          name: dist-${{ github.sha }}-${{ github.run_id }}-${{ github.run_number }}
+          path: dist/*
+          if-no-files-found: error
+
+  publish-pypi-test:
+    name: Publish to TestPyPI
+    needs: build-packages
+    if: github.event_name != 'pull_request'
+    environment:
+      name: test
+      url: https://test.pypi.org/project/ultraplot/
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v7
+        with:
+          name: dist-${{ github.sha }}-${{ github.run_id }}-${{ github.run_number }}
+          path: dist
+
+      - name: Check files
+        run: |
+          ls dist
+        shell: bash
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          verbose: true
+          # releases generate both release and tag events so
+          # we get a race condition if we don't skip existing
+          skip-existing: ${{ (github.event_name == 'release' || github.event_name == 'push') && 'true' || 'false' }}
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: publish-pypi-test
+    environment:
+      name: prod
+      url: https://pypi.org/project/ultraplot/
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release'
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v7
+        with:
+          name: dist-${{ github.sha }}-${{ github.run_id }}-${{ github.run_number }}
+          path: dist
+
+      - name: Check files
+        run: |
+          ls dist
+        shell: bash
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true

ultraplot-1.71.0/.gitignore

@@ -0,0 +1,50 @@
+# VIM extras
+.session.vim
+.vimsession
+.*.sw[a-z]
+
+# Pytest-mpl test directory ignore
+baseline
+baseline/*
+results
+results/*
+ultraplot.yml
+
+# PyPi stuff
+build
+dist
+.eggs
+*.egg-info
+
+# Local docs builds
+docs/api
+docs/_build
+docs/_static/ultraplotrc
+docs/_static/rctable.rst
+docs/_static/*
+
+# Development subfolders
+dev
+sources
+
+# Python extras
+.ipynb_checkpoints
+*.log
+*.pyc
+.*.pyc
+__pycache__
+test.py
+
+# OS files
+.DS_Store
+.DS_Store?
+._*
+.Trashes
+
+# Old files
+tmp
+trash
+garbage
+
+# version file
+ultraplot/_version.py

ultraplot-1.71.0/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+ci:
+    autofix_commit_msg: |
+        [pre-commit.ci] auto fixes from pre-commit.com hooks
+
+        for more information, see https://pre-commit.ci
+    autofix_prs: false
+    autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
+    autoupdate_schedule: monthly
+    skip: []
+    submodules: false
+
+repos:
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 25.12.0
+    hooks:
+      - id: black

ultraplot-1.71.0/.readthedocs.yml

@@ -0,0 +1,24 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+version: 2
+
+# Set the OS and build tools
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "mambaforge-latest"
+
+# Conda settings
+conda:
+  environment: ./environment.yml
+
+# Sphinx settings
+sphinx:
+  configuration: ./docs/conf.py
+  builder: html
+
+# Python settings
+python:
+  install:
+    - method: pip
+      path: .

ultraplot-1.71.0/.zenodo.json

@@ -0,0 +1,39 @@
+{
+  "title": "UltraPlot: A succinct wrapper for Matplotlib",
+  "upload_type": "software",
+  "description": "UltraPlot provides a compact and extensible API on top of Matplotlib, inspired by ProPlot. It simplifies the creation of scientific plots with consistent layout, colorbars, and shared axes.",
+  "creators": [
+    {
+      "name": "van Elteren, Casper",
+      "orcid": "0000-0001-9862-8936",
+      "affiliation": "University of Amsterdam, Polder Center, Institute for Advanced Study Amsterdam"
+    },
+    {
+      "name": "Becker, Matthew R.",
+      "orcid": "0000-0001-7774-2246",
+      "affiliation": "Argonne National Laboratory, Lemont, IL USA"
+    }
+  ],
+  "license": "MIT",
+  "keywords": [
+    "matplotlib",
+    "scientific visualization",
+    "plotting",
+    "wrapper",
+    "python"
+  ],
+  "related_identifiers": [
+    {
+      "relation": "isDerivedFrom",
+      "identifier": "https://github.com/lukelbd/proplot",
+      "scheme": "url"
+    },
+    {
+      "relation": "isDerivedFrom",
+      "identifier": "https://matplotlib.org/",
+      "scheme": "url"
+    }
+  ],
+  "version": "1.57",
+  "publication_date": "2025-01-01" // need to fix
+}

ultraplot-1.71.0/CITATION.cff

@@ -0,0 +1,33 @@
+cff-version: 1.2.0
+message: "If you use UltraPlot in your work, please cite it using the following metadata."
+title: "UltraPlot"
+authors:
+  - family-names: "van Elteren"
+    given-names: "Casper"
+    orcid: "https://orcid.org/0000-0001-9862-8936"
+  - family-names: "Becker"
+    given-names: "Matthew R."
+    orcid: "https://orcid.org/0000-0001-7774-2246"
+date-released: "2025-01-01"
+version: "1.57"
+doi: "10.5281/zenodo.15733580"
+repository-code: "https://github.com/Ultraplot/UltraPlot"
+license: "MIT"
+keywords:
+  - plotting
+  - matplotlib
+  - scientific visualization
+  - wrapper
+references:
+  - type: software
+    name: "ProPlot"
+    authors:
+      - family-names: "Davis"
+        given-names: "Luke"
+    url: "https://github.com/lukelbd/proplot"
+  - type: software
+    name: "Matplotlib"
+    authors:
+      - family-names: "Hunter"
+        given-names: "John D."
+    url: "https://matplotlib.org/"