Merge pull request #59 from legend-exp/pkg-update

Migrate to pyproject.toml, upgrade pre-commit config

Author: gipert

.github/workflows/main.yml

@@ -1,41 +1,43 @@
 name: lgdo
 
 on:
+  workflow_dispatch:
+  pull_request:
   push:
     branches:
       - main
-      - 'releases/**'
-  pull_request:
-  release:
+      - "releases/**"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
-jobs:
+env:
+  FORCE_COLOR: 3
 
+jobs:
   build-and-test:
     name: Test lgdo with Python
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.9', '3.10', '3.11']
+        python-version: ["3.9", "3.10", "3.11"]
         os: [ubuntu-latest, macOS-latest]
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Get dependencies and install lgdo
-      run: |
-        python -m pip install --upgrade pip wheel setuptools
-        python -m pip install --upgrade .[test]
-    - name: Run unit tests
-      run: |
-        python -m pytest
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Get dependencies and install lgdo
+        run: |
+          python -m pip install --upgrade pip wheel setuptools
+          python -m pip install --upgrade .[test]
+      - name: Run unit tests
+        run: |
+          python -m pytest
 
   test-coverage:
     name: Calculate and upload test coverage
@@ -46,7 +48,7 @@ jobs:
           fetch-depth: 2
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: "3.10"
 
       - name: Generate Report
         run: |
@@ -65,7 +67,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: "3.10"
       - name: Setup build environment
         run: |
           sudo apt-get install -y pandoc

.pre-commit-config.yaml

@@ -4,105 +4,83 @@ ci:
   autofix_commit_msg: "style: pre-commit fixes"
 
 repos:
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: "v4.5.0"
-  hooks:
-  - id: check-added-large-files
-  - id: check-case-conflict
-  - id: check-executables-have-shebangs
-  - id: check-merge-conflict
-  - id: check-symlinks
-  - id: check-yaml
-  - id: check-json
-  - id: check-toml
-  - id: check-docstring-first
-  - id: debug-statements
-  - id: end-of-file-fixer
-  - id: forbid-new-submodules
-  - id: mixed-line-ending
-  - id: requirements-txt-fixer
-  - id: trailing-whitespace
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: "1.16.0"
+    hooks:
+      - id: blacken-docs
+        additional_dependencies: [black==23.*]
 
-- repo: https://github.com/asottile/setup-cfg-fmt
-  rev: "v2.5.0"
-  hooks:
-  - id: setup-cfg-fmt
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.5.0"
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-yaml
+      - id: check-json
+      - id: check-toml
+      - id: check-docstring-first
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: forbid-new-submodules
+      - id: mixed-line-ending
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
 
-- repo: https://github.com/PyCQA/isort
-  rev: "5.13.2"
-  hooks:
-  - id: isort
+  - repo: https://github.com/kynan/nbstripout
+    rev: "0.6.1"
+    hooks:
+      - id: nbstripout
+        args:
+          [
+            "--drop-empty-cells",
+            "--extra-keys",
+            "metadata.kernelspec metadata.language_info",
+          ]
 
-- repo: https://github.com/asottile/pyupgrade
-  rev: "v3.15.0"
-  hooks:
-  - id: pyupgrade
-    args: ["--py38-plus"]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.1.13"
+    hooks:
+      - id: ruff
+        args: ["--fix", "--show-fixes"]
+      - id: ruff-format
 
-- repo: https://github.com/psf/black
-  rev: "23.12.1"
-  hooks:
-  - id: black-jupyter
+  - repo: https://github.com/codespell-project/codespell
+    rev: "v2.2.6"
+    hooks:
+      - id: codespell
+        args: ["-L", "nd,unparseable,compiletime"]
 
-- repo: https://github.com/pre-commit/mirrors-mypy
-  rev: "v1.8.0"
-  hooks:
-    - id: mypy
-      files: src
-      stages: [manual]
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: "v0.9.0.6"
+    hooks:
+      - id: shellcheck
 
-- repo: https://github.com/hadialqattan/pycln
-  rev: "v2.4.0"
-  hooks:
-  - id: pycln
-    args: ["--all"]
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: "v1.10.0"
+    hooks:
+      - id: python-no-log-warn
+      - id: rst-backticks
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
 
-- repo: https://github.com/PyCQA/flake8
-  rev: "6.1.0"
-  hooks:
-  - id: flake8
-    additional_dependencies: [
-      flake8-bugbear>=23.1.17,
-      flake8-print,
-      # flake8-docstrings,
-      pep8-naming
-    ]
-    # args: ["--docstring-convention", "numpy"]  # or google, change me
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v4.0.0-alpha.8"
+    hooks:
+      - id: prettier
+        types_or: [yaml, markdown, html, css, scss, javascript, json]
+        args: [--prose-wrap=always]
 
-- repo: https://github.com/kynan/nbstripout
-  rev: "0.6.1"
-  hooks:
-    - id: nbstripout
-      args: ["--drop-empty-cells",
-             "--extra-keys", "metadata.kernelspec metadata.language_info"]
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.15
+    hooks:
+      - id: validate-pyproject
 
-- repo: https://github.com/mgedmin/check-manifest
-  rev: "0.49"
-  hooks:
-  - id: check-manifest
-    stages: [manual]
-
-- repo: https://github.com/codespell-project/codespell
-  rev: "v2.2.6"
-  hooks:
-  - id: codespell
-    args: ["-L", "nd,unparseable,compiletime"]
-
-- repo: https://github.com/shellcheck-py/shellcheck-py
-  rev: "v0.9.0.6"
-  hooks:
-  - id: shellcheck
-
-- repo: https://github.com/pre-commit/pygrep-hooks
-  rev: "v1.10.0"
-  hooks:
-  - id: python-no-log-warn
-  - id: rst-backticks
-  - id: rst-directive-colons
-  - id: rst-inline-touching-normal
-
-- repo: https://github.com/pre-commit/mirrors-prettier
-  rev: "v4.0.0-alpha.8"
-  hooks:
-    - id: prettier
-      types_or: [json]
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.27.3
+    hooks:
+      - id: check-dependabot
+      - id: check-github-workflows
+      - id: check-readthedocs

.readthedocs.yaml

@@ -16,13 +16,8 @@ build:
   jobs:
     pre_build:
       - rm -rf docs/source/api
-      - sphinx-apidoc
-        --private
-        --module-first
-        --force
-        --output-dir docs/source/api
-        src/lgdo
-        src/lgdo/_version.py
+      - sphinx-apidoc --private --module-first --force --output-dir
+        docs/source/api src/lgdo src/lgdo/_version.py
 
 python:
   install:

README.md

@@ -11,7 +11,8 @@
 ![License](https://img.shields.io/github/license/legend-exp/legend-pydataobj)
 [![Read the Docs](https://img.shields.io/readthedocs/legend-pydataobj?logo=readthedocs)](https://legend-pydataobj.readthedocs.io)
 
-This package provides a Python implementation of the LEGEND Data Objects (LGDO) and I/O
-to HDF5, including [Numba](https://numba.pydata.org/)-accelerated custom compression
-algorithms for particle detector signals. More documentation is available in the
+This package provides a Python implementation of the LEGEND Data Objects (LGDO)
+and I/O to HDF5, including [Numba](https://numba.pydata.org/)-accelerated custom
+compression algorithms for particle detector signals. More documentation is
+available in the
 [LEGEND data format specification](https://legend-exp.github.io/legend-data-format-specs).

codecov.yml

@@ -9,7 +9,7 @@ coverage:
     patch: false
 
 github_checks:
-    annotations: false
+  annotations: false
 
 ignore:
   - tests

docs/source/conf.py

@@ -1,4 +1,5 @@
 # Configuration file for the Sphinx documentation builder.
+from __future__ import annotations
 
 import sys
 from pathlib import Path