plothist 1.3.0__tar.gz → 1.3.2__tar.gz

plothist-1.3.2/.github/dependabot.yaml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      actions:
+        patterns:
+          - "*"

plothist-1.3.2/.github/release.yaml

@@ -0,0 +1,5 @@
+changelog:
+  exclude:
+    authors:
+      - dependabot
+      - pre-commit-ci

plothist-1.3.2/.github/workflows/cd.yaml

@@ -0,0 +1,79 @@
+name: CD
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  release:
+    types:
+      - published
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.6.8"
+      - name: Build distribution
+        run: uv build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    if: github.event_name == 'release' && github.event.action == 'published'
+    needs:
+      - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/plothist
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+
+  publish-to-pypi:
+    name: Publish Python 🐍 distribution 📦 to PyPI
+    if: github.event_name == 'release' && github.event.action == 'published'
+    needs:
+      - build
+      - publish-to-testpypi
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/plothist
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

plothist-1.3.2/.github/workflows/ci.yaml

@@ -0,0 +1,36 @@
+# This workflow will install Python dependencies, run tests with a variety of Python versions
+name: CI
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.6.8"
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Run pre-commit
+        run: |
+          uv run pre-commit run --all-files
+
+      - name: Test with pytest
+        run: |
+          uv run python -m pytest

plothist-1.3.2/.github/workflows/pr.yaml

@@ -0,0 +1,21 @@
+name: "Lint PR"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+      - reopened
+
+permissions:
+  pull-requests: read
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{plothist-1.3.0 → plothist-1.3.2}/.pre-commit-config.yaml

@@ -1,3 +1,6 @@
+ci:
+  autoupdate_commit_msg: "chore: update pre-commit hooks"
+
 repos:
   - repo: https://github.com/adamchainz/blacken-docs
     rev: "1.19.1"
@@ -5,7 +8,7 @@ repos:
       - id: blacken-docs
         args: ["--line-length", "120"]
         additional_dependencies:
-        - black==24.2.0
+          - black==24.2.0
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
@@ -31,6 +34,6 @@ repos:
   - repo: https://github.com/codespell-project/codespell
     rev: v2.4.1
     hooks:
-    - id: codespell
-      additional_dependencies:
-        - tomli
+      - id: codespell
+        additional_dependencies:
+          - tomli

{plothist-1.3.0 → plothist-1.3.2}/PKG-INFO

@@ -1,27 +1,32 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: plothist
-Version: 1.3.0
+Version: 1.3.2
 Summary: Plot histograms in a scalable way and a beautiful style.
+Project-URL: Homepage, https://github.com/cyrraz/plothist
+Project-URL: Documentation, https://plothist.readthedocs.io/
+Project-URL: Bug Tracker, https://github.com/cyrraz/plothist/issues
 Author-email: Cyrille Praz <cyrraz.code@protonmail.com>, Tristan Fillinger <tristan.github@gmail.com>
-Requires-Python: >=3.9
-Description-Content-Type: text/x-rst
+License-File: AUTHORS.md
+License-File: LICENSE
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Education
-Classifier: Intended Audience :: Financial and Insurance Industry
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
 Requires-Dist: boost-histogram>=1.4.0
-Requires-Dist: numpy>=1.14.5
 Requires-Dist: matplotlib>=3.0
+Requires-Dist: numpy>=1.14.5
 Requires-Dist: pyyaml>=5.3.1
-Requires-Dist: scipy>=1.6.0
 Requires-Dist: requests>=2.25.0
-Project-URL: Bug Tracker, https://github.com/cyrraz/plothist/issues
-Project-URL: Documentation, https://plothist.readthedocs.io/
-Project-URL: Homepage, https://github.com/cyrraz/plothist
+Requires-Dist: scipy>=1.6.0
+Provides-Extra: dev
+Requires-Dist: pre-commit>=4.1.0; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest>=8.3.5; extra == 'test'
+Description-Content-Type: text/x-rst
 
 
 ========
@@ -78,4 +83,3 @@ plothist
    :target: https://zenodo.org/doi/10.5281/zenodo.10995667
 .. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
-

plothist-1.3.2/docs/CONTRIBUTING.rst

@@ -0,0 +1,47 @@
+.. _contributing:
+
+============
+Contributing
+============
+
+Building from source
+====================
+
+Follow the instructions in :ref:`install-dev-version` to install the development version of ``plothist``.
+
+Setting up a development environment
+====================================
+
+Nox
+---
+
+The fastest way to start with development is to use ``nox``.
+
+``Nox`` is an automation tool that helps manage and run development tasks such as testing and linting.
+It is especially useful for ensuring your code works across different Python versions and adheres to the project's quality standards.
+``Nox`` handles everything for you, including setting up a temporary virtual environment for each run.
+
+To set up ``nox``:
+
+1. If you don't have it already, install ``pipx`` by following the instructions on their `website <https://pipx.pypa.io/stable/>`_.
+2. Install ``nox`` using ``pipx``:
+
+   .. code-block:: console
+
+      pipx install nox
+
+To use ``nox``, simply run:
+
+.. code-block:: console
+
+   nox
+
+This will lint and test the project using multiple Python versions.
+
+You can also run specific jobs:
+
+.. code-block:: console
+
+   nox -l        # List all the defined sessions
+   nox -s lint   # Run the linter only
+   nox -s tests  # Run the tests only

{plothist-1.3.0 → plothist-1.3.2}/docs/conf.py

@@ -26,9 +26,9 @@ copyright = "2023-2024, Cyrille Praz, Tristan Fillinger"
 author = "Cyrille Praz, Tristan Fillinger"
 
 # The short X.Y version
-version = "1.3.0"
+version = "1.3.2"
 # The full version, including alpha/beta/rc tags
-release = "1.3.0"
+release = "1.3.2"
 
 
 # -- General configuration ---------------------------------------------------

{plothist-1.3.0 → plothist-1.3.2}/docs/examples/advanced/1d_comparison_advanced.py

@@ -29,10 +29,10 @@ x4 = df[name][df[category] == 5]
 
 x_range = [-9, 9]
 
-h1 = make_hist(x1, bins=50, range=x_range)
-h2 = make_hist(x2, bins=50, range=x_range)
-h3 = make_hist(x3, bins=50, range=x_range)
-h4 = make_hist(x4, bins=50, range=x_range)
+h1 = make_hist(x3, bins=50, range=x_range)
+h2 = make_hist(x4, bins=50, range=x_range)
+h3 = make_hist(x1, bins=50, range=x_range)
+h4 = make_hist(x2, bins=50, range=x_range)
 
 # Create the 3 axes that we need for this plot
 fig, axes = create_comparison_figure(
@@ -62,10 +62,10 @@ plot_error_hist(h4, label="Test B", ax=ax_main, color="red", density=True)
 
 # First comparison is using pulls. We also change the color of the bars to make the plot easier to read
 plot_comparison(
-    h4, h3, ax=ax1_comparison, comparison="pull", color=colors[0], alpha=0.7
+    h2, h1, ax=ax1_comparison, comparison="pull", color=colors[0], alpha=0.7
 )
 # Second comparison is using the default "ratio". Same strategy as pulls
-plot_comparison(h2, h1, ax=ax2_comparison, color=colors[1], alpha=0.7)
+plot_comparison(h4, h3, ax=ax2_comparison, color=colors[1], alpha=0.7)
 
 # Harmonize the range of each axes
 ax_main.set_xlim(x_range)

{plothist-1.3.0 → plothist-1.3.2}/docs/examples/model_ex/model_all_comparisons.py

@@ -62,7 +62,7 @@ fig, axes = create_comparison_figure(
 )
 background_sum = sum(background_hists)
 
-fig, ax_main, ax_comparison = plot_data_model_comparison(
+plot_data_model_comparison(
     data_hist=data_hist,
     stacked_components=background_hists,
     stacked_labels=background_categories_labels,
@@ -77,9 +77,9 @@ fig, ax_main, ax_comparison = plot_data_model_comparison(
 
 add_text(
     "Multiple data-model comparisons, $\mathbf{with}$ model uncertainty",
-    ax=ax_main,
+    ax=axes[0],
 )
-add_text(f'  $\mathbf{{→}}$ comparison = "ratio"', ax=ax_comparison, fontsize=13)
+add_text(f'  $\mathbf{{→}}$ comparison = "ratio"', ax=axes[1], fontsize=13)
 
 for k_comp, comparison in enumerate(
     ["split_ratio", "pull", "relative_difference", "difference"], start=2

{plothist-1.3.0 → plothist-1.3.2}/docs/examples/model_ex/model_all_comparisons_no_model_unc.py

@@ -63,7 +63,7 @@ fig, axes = create_comparison_figure(
 )
 background_sum = sum(background_hists)
 
-fig, ax_main, ax_comparison = plot_data_model_comparison(
+plot_data_model_comparison(
     data_hist=data_hist,
     stacked_components=background_hists,
     stacked_labels=background_categories_labels,
@@ -79,9 +79,9 @@ fig, ax_main, ax_comparison = plot_data_model_comparison(
 
 add_text(
     "Multiple data-model comparisons, $\mathbf{without}$ model uncertainty",
-    ax=ax_main,
+    ax=axes[0],
 )
-add_text(f'  $\mathbf{{→}}$ comparison = "ratio"', ax=ax_comparison, fontsize=13)
+add_text(f'  $\mathbf{{→}}$ comparison = "ratio"', ax=axes[1], fontsize=13)
 
 for k_comp, comparison in enumerate(
     ["split_ratio", "pull", "relative_difference", "difference"], start=2