Standardised pyproject + pre-commit

Author: patrick-kidger

.pre-commit-config.yaml

@@ -17,15 +17,24 @@
 # IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+
 repos:
+  - repo: local
+    hooks:
+      - id: sort_pyproject
+        name: sort_pyproject
+        entry: toml-sort -i --sort-table-keys --sort-inline-tables
+        language: python
+        files: ^pyproject\.toml$
+        additional_dependencies: ["toml-sort==0.23.1"]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.7.3
+    rev: v0.13.0
     hooks:
-      - id: ruff-format  # formatter
-        types_or: [ python, pyi, jupyter ]
-      - id: ruff  # linter
-        types_or: [ python, pyi, jupyter ]
-        args: [ --fix ]
+      - id: ruff-format # formatter
+        types_or: [python, pyi, jupyter, toml]
+      - id: ruff # linter
+        types_or: [python, pyi, jupyter, toml]
+        args: [--fix]
   - repo: https://github.com/RobertCraigie/pyright-python
     rev: v1.1.391
     hooks:
@@ -40,4 +49,5 @@ repos:
         files: ^test/types/
         additional_dependencies:
           [beartype, numpy<2]
-        args: ["--ignore-missing-imports", "--follow-imports=skip"]
+        args: ["--ignore-missing-imports", "--follow-imports=skip"]
+

pyproject.toml

@@ -1,34 +1,38 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling"]
+
 [project]
-name = "jaxtyping"
-version = "0.3.3"
-description = "Type annotations and runtime checking for shape and dtype of JAX/NumPy/PyTorch/etc. arrays."
-readme = "README.md"
-requires-python =">=3.10"
-license = {file = "LICENSE"}
 authors = [
-  {name = "Patrick Kidger", email = "contact@kidger.site"},
+  {email = "contact@kidger.site", name = "Patrick Kidger"}
 ]
-keywords = ["jax", "neural-networks", "deep-learning", "equinox", "typing"]
 classifiers = [
-    "Development Status :: 3 - Alpha",
-    "Intended Audience :: Developers",
-    "Intended Audience :: Financial and Insurance Industry",
-    "Intended Audience :: Information Technology",
-    "Intended Audience :: Science/Research",
-    "License :: OSI Approved :: MIT License",
-    "Natural Language :: English",
-    "Programming Language :: Python :: 3",
-    "Topic :: Scientific/Engineering :: Artificial Intelligence",
-    "Topic :: Scientific/Engineering :: Information Analysis",
-    "Topic :: Scientific/Engineering :: Mathematics",
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Financial and Insurance Industry",
+  "Intended Audience :: Information Technology",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Natural Language :: English",
+  "Programming Language :: Python :: 3",
+  "Topic :: Scientific/Engineering :: Artificial Intelligence",
+  "Topic :: Scientific/Engineering :: Information Analysis",
+  "Topic :: Scientific/Engineering :: Mathematics"
 ]
-urls = {repository = "https://github.com/google/jaxtyping" }
 dependencies = ["wadler_lindig>=0.1.3"]
+description = "Type annotations and runtime checking for shape and dtype of JAX/NumPy/PyTorch/etc. arrays."
 entry-points = {pytest11 = {jaxtyping = "jaxtyping._pytest_plugin"}}
+keywords = ["jax", "neural-networks", "deep-learning", "equinox", "typing"]
+license = {file = "LICENSE"}
+name = "jaxtyping"
+readme = "README.md"
+requires-python = ">=3.10"
+urls = {repository = "https://github.com/google/jaxtyping"}
+version = "0.3.3"
 
 [project.optional-dependencies]
 dev = [
-  "pre-commit>=4.3.0",
+  "pre-commit>=4.3.0"
 ]
 docs = [
   "hippogriffe==0.2.1",
@@ -39,39 +43,39 @@ docs = [
   "mkdocs-material==9.6.7",
   "mkdocstrings==0.28.3",
   "mkdocstrings-python==1.16.8",
-  "pymdown-extensions==10.14.3",
+  "pymdown-extensions==10.14.3"
 ]
 tests = [
-    "beartype>=0.21.0",
-    "cloudpickle>=3.1.1",
-    "equinox>=0.13.1",
-    "ipython>=8.37.0",
-    "jax>=0.5.3",
-    "mlx[cpu]>=0.29.1",
-    "numpy<2",
-    "pytest>=8.4.2",
-    "pytest-asyncio>=1.2.0",
-    "tensorflow>=2.18.1",
-    "typeguard==2.13.3",
+  "beartype>=0.21.0",
+  "cloudpickle>=3.1.1",
+  "equinox>=0.13.1",
+  "ipython>=8.37.0",
+  "jax>=0.5.3",
+  "mlx[cpu]>=0.29.1",
+  "numpy<2",
+  "pytest>=8.4.2",
+  "pytest-asyncio>=1.2.0",
+  "tensorflow>=2.18.1",
+  "typeguard==2.13.3"
 ]
 
-
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
 [tool.hatch.build]
 include = ["jaxtyping/*"]
 
 [tool.ruff.lint]
-select = ["E", "F", "I001"]
 ignore = ["E721", "E731", "F722"]
+select = ["E", "F", "I001"]
 
-[tool.ruff.lint.per-file-ignores]
-"jaxtyping/_typeguard/__init__.py" = ["E", "F", "I001"]
+[tool.ruff.lint.flake8-import-conventions.extend-aliases]
+"collections" = "co"
+"functools" = "ft"
+"itertools" = "it"
 
 [tool.ruff.lint.isort]
 combine-as-imports = true
-lines-after-imports = 2
 extra-standard-library = ["typing_extensions"]
+lines-after-imports = 2
 order-by-type = false
+
+[tool.ruff.lint.per-file-ignores]
+"jaxtyping/_typeguard/__init__.py" = ["E", "F", "I001"]