plothist-utils 0.0.1__tar.gz

plothist_utils-0.0.1/.github/release.yaml

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

plothist_utils-0.0.1/.github/workflows/cd.yaml

@@ -0,0 +1,52 @@
+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-pypi:
+    name: Publish Python 🐍 distribution 📦 to PyPI
+    if: github.event_name == 'release' && github.event.action == 'published'
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/plothist_utils
+    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_utils-0.0.1/.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 --group dev --group test
+
+      - name: Run pre-commit
+        run: |
+          uv run pre-commit run --all-files
+
+      - name: Test with pytest
+        run: |
+          uv run python -m pytest

plothist_utils-0.0.1/.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_utils-0.0.1/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+.vscode/
+_build/
+test/
+metadata.yaml
+.venv
+
+# Version file
+_version.py

plothist_utils-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,61 @@
+ci:
+  autoupdate_commit_msg: "chore: update pre-commit hooks"
+  autofix_commit_msg: "style: pre-commit fixes"
+  autoupdate_schedule: monthly
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+        exclude: '.*\.svg$'
+      - id: name-tests-test
+        args: ["--pytest-test-first"]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.2
+    hooks:
+      - id: ruff
+        args: ["--fix", "--show-fixes"]
+      - id: ruff-format
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli
+
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.31.3
+    hooks:
+      - id: check-github-workflows
+        args: ["--verbose"]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        files: src
+        additional_dependencies:
+          - types-requests
+          - types-pyyaml
+
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.32.1
+    hooks:
+      - id: check-readthedocs
+      - id: check-dependabot
+      - id: check-github-workflows
+
+  - repo: https://github.com/henryiii/validate-pyproject-schema-store
+    rev: 2025.02.24
+    hooks:
+      - id: validate-pyproject

plothist_utils-0.0.1/AUTHORS.md

@@ -0,0 +1,2 @@
+Cyrille Praz ([@cyrraz](https://github.com/cyrraz))
+Tristan Fillinger ([@0ctagon](https://github.com/0ctagon))

plothist_utils-0.0.1/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023-2025, Cyrille Praz, Tristan Fillinger
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

plothist_utils-0.0.1/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: plothist_utils
+Version: 0.0.1
+Summary: Utilities for the plothist package
+Project-URL: Homepage, https://github.com/0ctagon/plothist_utils
+Project-URL: Documentation, https://plothist.readthedocs.io/
+Project-URL: Bug Tracker, https://github.com/0ctagon/plothist_utils/issues
+Author-email: Cyrille Praz <cyrraz.code@protonmail.com>, Tristan Fillinger <tristan.github@gmail.com>
+License-File: AUTHORS.md
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: numpy>=1.14.5
+Description-Content-Type: text/markdown
+
+# plothist_utils
+[![CI Status][ci-badge]][ci-link]
+[![CD Status][cd-badge]][cd-link]
+[![PyPI version][pypi-version]][pypi-link]
+<!-- [![Conda-Forge][conda-badge]][conda-link] -->
+
+Sub-package to hold the fonts and some data to make the examples of [plothist](https://github.com/cyrraz/plothist).
+
+[ci-badge]:     https://github.com/0ctagon/plothist_utils/actions/workflows/ci.yaml/badge.svg
+[ci-link]:      https://github.com/0ctagon/plothist_utils/actions/workflows/ci.yaml?query=branch%3Amain
+[cd-badge]:     https://github.com/0ctagon/plothist_utils/actions/workflows/cd.yaml/badge.svg
+[cd-link]:      https://github.com/0ctagon/plothist_utils/actions/workflows/cd.yaml?query=branch%3Amain
+[pypi-link]:    https://pypi.org/project/plothist_utils/
+[pypi-version]: https://badge.fury.io/py/plothist_utils.svg
+
+
+## Fonts
+Fonts distributed in this package have open licenses and can be redistributed. While it would be preferable to download the files from their original repositories, there is no convenient way to do that due to varying repo structures. The following fonts are included:
+
+
+#### Latin Modern Math
+
+https://mirrors.cicku.me/ctan/fonts/lm-math/
+
+#### Latin Modern Roman
+
+https://www.1001fonts.com/latin-modern-roman-font.html
+
+#### Latin Modern Sans
+
+https://www.1001fonts.com/latin-modern-sans-font.html

plothist_utils-0.0.1/README.md

@@ -0,0 +1,31 @@
+# plothist_utils
+[![CI Status][ci-badge]][ci-link]
+[![CD Status][cd-badge]][cd-link]
+[![PyPI version][pypi-version]][pypi-link]
+<!-- [![Conda-Forge][conda-badge]][conda-link] -->
+
+Sub-package to hold the fonts and some data to make the examples of [plothist](https://github.com/cyrraz/plothist).
+
+[ci-badge]:     https://github.com/0ctagon/plothist_utils/actions/workflows/ci.yaml/badge.svg
+[ci-link]:      https://github.com/0ctagon/plothist_utils/actions/workflows/ci.yaml?query=branch%3Amain
+[cd-badge]:     https://github.com/0ctagon/plothist_utils/actions/workflows/cd.yaml/badge.svg
+[cd-link]:      https://github.com/0ctagon/plothist_utils/actions/workflows/cd.yaml?query=branch%3Amain
+[pypi-link]:    https://pypi.org/project/plothist_utils/
+[pypi-version]: https://badge.fury.io/py/plothist_utils.svg
+
+
+## Fonts
+Fonts distributed in this package have open licenses and can be redistributed. While it would be preferable to download the files from their original repositories, there is no convenient way to do that due to varying repo structures. The following fonts are included:
+
+
+#### Latin Modern Math
+
+https://mirrors.cicku.me/ctan/fonts/lm-math/
+
+#### Latin Modern Roman
+
+https://www.1001fonts.com/latin-modern-roman-font.html
+
+#### Latin Modern Sans
+
+https://www.1001fonts.com/latin-modern-sans-font.html

plothist_utils-0.0.1/noxfile.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+import nox
+
+nox.options.sessions = ["lint", "tests"]
+nox.needs_version = ">=2025.2.9"
+nox.options.default_venv_backend = "uv|venv"
+
+PYTHON_ALL_VERSIONS = ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+
+@nox.session(reuse_venv=True)
+def lint(session: nox.Session) -> None:
+    """
+    Run the linter.
+    """
+    session.install("pre-commit")
+    session.run("pre-commit", "run", "--all-files", *session.posargs)
+
+
+@nox.session(python=PYTHON_ALL_VERSIONS)
+def tests(session: nox.Session) -> None:
+    """
+    Run the unit and regular tests.
+    """
+    pyproject = nox.project.load_toml("pyproject.toml")
+    session.install("-e", ".")
+    session.install(*nox.project.dependency_groups(pyproject, "test"))
+    session.run("pytest", *session.posargs)

plothist_utils-0.0.1/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "plothist_utils"
+description = "Utilities for the plothist package"
+authors = [
+    {name = "Cyrille Praz", email = "cyrraz.code@protonmail.com"},
+    {name = "Tristan Fillinger", email = "tristan.github@gmail.com"},
+    ]
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+    "numpy>=1.14.5",
+]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/0ctagon/plothist_utils"
+Documentation = "https://plothist.readthedocs.io/"
+"Bug Tracker" = "https://github.com/0ctagon/plothist_utils/issues"
+
+[tool.codespell]
+skip = '*.pdf,./test/*,*.svg,./docs/html/*'
+quiet-level = 3
+write-changes = true
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.1.0",
+]
+test = [
+    "pytest>=8.3.5",
+    "pytest-cov>=4.1.0",
+    "matplotlib>=3.0.0",
+]
+
+
+[tool.hatch]
+version.source = "vcs"
+build.hooks.vcs.version-file = "src/plothist_utils/_version.py"
+
+[tool.ruff.lint]
+extend-select = [
+    "B",           # flake8-bugbear
+    "I",           # isort
+    "C4",          # flake8-comprehensions
+    "ISC",         # flake8-implicit-str-concat
+    "G",           # flake8-logging-format
+    "PGH",         # pygrep-hooks
+    "PIE",         # flake8-pie
+    "RUF",         # Ruff-specific
+    "UP",          # pyupgrade
+    "YTT",         # flake8-2020
+    "EXE",         # flake8-executable
+    "NPY",         # NumPy specific rules
+    "TID251",      # flake8-tidy-imports
+    "SIM",         # flake8-simplify
+    "RET",         # flake8-return
+    "PD",          # pandas-vet
+]
+ignore = [
+    "E402",  # module level import not at top of file
+    "NPY002",  # Replace legacy `np.random` call with `np.random.Generator`
+    "PD901",  # Avoid using the generic variable name `df` for DataFrames
+]

plothist_utils-0.0.1/src/plothist_utils/__init__.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+from ._version import version as __version__
+from .get_dummy_data import get_dummy_data
+
+__all__ = ("__version__", "get_dummy_data")

plothist_utils-0.0.1/src/plothist_utils/_version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.0.1'
+__version_tuple__ = version_tuple = (0, 0, 1)

plothist_utils-0.0.1/src/plothist_utils/_version.pyi

@@ -0,0 +1,2 @@
+version: str
+version_tuple: tuple[int, int, int] | tuple[int, int, int, str, str]