Merge pull request #63 from ariostas/ariostas/repo-review-fixes

chore: apply a few fixes from `sp-repo-review`

Author: ariostas

.github/dependabot.yml

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

.github/workflows/cd.yml

@@ -24,11 +24,9 @@ jobs:
 
       - uses: hynek/build-and-inspect-python-package@v2
 
-
-
   deploy:
     if: github.event_name == 'release' && github.event.action == 'published'
-    needs: [ dist ]
+    needs: [dist]
     runs-on: ubuntu-latest
     environment:
       name: pypi

.github/workflows/ci.yml

@@ -21,19 +21,19 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - '3.10'
-          - '3.11'
-          - '3.12'
-          - '3.13'
-          - '3.14'
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
         runs-on:
           - ubuntu-latest
         include:
-          - python-version: '3.10'
+          - python-version: "3.10"
             runs-on: macOS-13
-          - python-version: '3.10'
+          - python-version: "3.10"
             runs-on: macOS-14
-          - python-version: '3.10'
+          - python-version: "3.10"
             runs-on: windows-latest
     steps:
       - uses: actions/checkout@v5

.github/workflows/docs.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.x'
+          python-version: "3.x"
 
       - name: Install dependencies
         run: |
@@ -47,7 +47,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: 'docs/_build/html'
+          path: "docs/_build/html"
 
   deploy:
     name: Deploy docs to GitHub Pages

.pre-commit-config.yaml

@@ -1,3 +1,8 @@
+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
@@ -17,7 +22,7 @@ repos:
     rev: "0.50"
     hooks:
       - id: check-manifest
-        stages: [ manual ]
+        stages: [manual]
 
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.10.0
@@ -33,36 +38,35 @@ repos:
     rev: v3.19.1
     hooks:
       - id: pyupgrade
-        args: [ --py310-plus ]
+        args: [--py310-plus]
 
   - repo: https://github.com/asottile/setup-cfg-fmt
     rev: v2.8.0
     hooks:
       - id: setup-cfg-fmt
-        args: [ --max-py-version=3.13, --include-version-classifiers ]
+        args: [--max-py-version=3.13, --include-version-classifiers]
 
   # Notebook formatting
   - repo: https://github.com/nbQA-dev/nbQA
     rev: 1.9.1
     hooks:
       - id: nbqa-isort
-        additional_dependencies: [ isort ]
+        additional_dependencies: [isort]
 
       - id: nbqa-pyupgrade
-        additional_dependencies: [ pyupgrade ]
-        args: [ --py310-plus ]
-
+        additional_dependencies: [pyupgrade]
+        args: [--py310-plus]
 
   - repo: https://github.com/kynan/nbstripout
     rev: 0.8.1
     hooks:
       - id: nbstripout
 
   - repo: https://github.com/sondrelg/pep585-upgrade
-    rev: 'v1.0'
+    rev: "v1.0"
     hooks:
       - id: upgrade-type-hints
-        args: [ '--futures=true' ]
+        args: ["--futures=true"]
 
   - repo: https://github.com/MarcoGorelli/auto-walrus
     rev: 0.3.4
@@ -75,7 +79,6 @@ repos:
   #    hooks:
   #      - id: oxipng
 
-
   - repo: https://github.com/python-jsonschema/check-jsonschema
     rev: 0.33.0
     hooks:
@@ -84,26 +87,44 @@ repos:
       - id: check-dependabot
       - id: check-readthedocs
 
-
   - repo: https://github.com/dannysepler/rm_unneeded_f_str
     rev: v0.2.0
     hooks:
       - id: rm-unneeded-f-str
 
-
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: "v0.11.10"
     hooks:
       - id: ruff
-        types_or: [ python, pyi, jupyter ]
-        args: [ --fix, --show-fixes , --line-length=120 ]
+        types_or: [python, pyi, jupyter]
+        args: [--fix, --show-fixes, --line-length=120]
       # Run the formatter.
       - id: ruff-format
-        types_or: [ python, pyi, jupyter ]
+        types_or: [python, pyi, jupyter]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: "v1.17.1"
     hooks:
       - id: mypy
         files: src
         args: []
+
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: "1.20.0"
+    hooks:
+      - id: blacken-docs
+        additional_dependencies: [black==24.*]
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: "v2.4.1"
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli; python_version<'3.11'
+        args: ["-L", "gaus"]
+
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: "v3.6.2"
+    hooks:
+      - id: prettier
+        types_or: [yaml, markdown, html, css, scss, javascript, json]

.readthedocs.yaml

@@ -16,6 +16,5 @@ python:
       extra_requirements:
         - docs
 
-
 sphinx:
   configuration: docs/conf.py

CHANGELOG.md

@@ -1,8 +1,6 @@
-Changelog
-=========
+# Changelog
 
-1.0.1 (16 Oct. 2025)
---------------------
+## 1.0.1 (16 Oct. 2025)
 
 Complete overhaul of the parsing and conversion logic to improve reliability and maintainability.
 TODO

README.md

@@ -26,19 +26,15 @@
 
 <!-- prettier-ignore-end -->
 
-Formulate
-=========
+# Formulate
 
 Easy conversions between different styles of expressions. Formulate
 currently supports converting between
 [ROOT](https://root.cern.ch/doc/master/classTFormula.html) and
 [numexpr](https://numexpr.readthedocs.io/en/latest/user_guide.html)
 style expressions.
 
-
-
-Installation
-------------
+## Installation
 
 Install formulate like any other Python package, ideally inside a virtual environment:
 
@@ -54,33 +50,31 @@ conda install -c conda-forge formulate
 
 (`-c conda-forge` is only needed if you don't have the `conda-forge` channel already configured)
 
-Roadmap and releases
-----------------------
+## Roadmap and releases
 
 For the roadmap, planned features, breaking changes and versioning please see the [roadmap](https://github.com/scikit-hep/formulate/discussions/61).
 
-Usage
------
+## Usage
 
 ### API
 
-
 The most basic usage involves calling `from_$BACKEND` and then `to_$BACKEND`, for example when starting with a ROOT style expression:
 
-```python
+```pycon
 >>> import formulate
->>> momentum = formulate.from_root('TMath::Sqrt(X_PX**2 + X_PY**2 + X_PZ**2)')
+>>> momentum = formulate.from_root("TMath::Sqrt(X_PX**2 + X_PY**2 + X_PZ**2)")
 >>> momentum
 Call(function='sqrt', arguments=[BinaryOperator(operator='add', left=BinaryOperator(operator='add', left=BinaryOperator(operator='pow', left=Symbol(name='X_PX'), right=Literal(value=2)), right=BinaryOperator(operator='pow', left=Symbol(name='X_PY'), right=Literal(value=2))), right=BinaryOperator(operator='pow', left=Symbol(name='X_PZ'), right=Literal(value=2)))])
 >>> momentum.to_numexpr()
 'sqrt((((X_PX ** 2) + (X_PY ** 2)) + (X_PZ ** 2)))'
 >>> momentum.to_root()
 'TMath::Sqrt((((X_PX ** 2) + (X_PY ** 2)) + (X_PZ ** 2)))'
 ```
+
 Similarly, when starting with a `numexpr` style expression:
 
-```python
->>> my_selection = formulate.from_numexpr('(X_PT > 5) & ((Mu_NHits > 3) | (Mu_PT > 10))')
+```pycon
+>>> my_selection = formulate.from_numexpr("(X_PT > 5) & ((Mu_NHits > 3) | (Mu_PT > 10))")
 >>> my_selection.to_root()
 '((X_PT > 5) && ((Mu_NHits > 3) || (Mu_PT > 10)))'
 >>> my_selection.to_numexpr()

docs/quickstart/example.rst

@@ -72,9 +72,9 @@ With numexpr:
 
     # Create some sample data
     data = {
-        'X_PT': np.array([3, 6, 9, 12]),
-        'Mu_NHits': np.array([2, 4, 1, 5]),
-        'Mu_PT': np.array([8, 5, 12, 7])
+        "X_PT": np.array([3, 6, 9, 12]),
+        "Mu_NHits": np.array([2, 4, 1, 5]),
+        "Mu_PT": np.array([8, 5, 12, 7]),
     }
 
     # Use the converted numexpr expression

docs/quickstart/installation.rst

@@ -54,4 +54,5 @@ To verify that Formulate is installed correctly, you can run:
 .. jupyter-execute::
 
     import formulate
+
     print(formulate.__version__)