Migrate to Pyproject + Hatchling (UV)

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 minimum_pre_commit_version: 2.2.0
 default_language_version:
     python: python3
-default_stages: [commit]
+default_stages: [pre-commit]
 fail_fast: true
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
@@ -40,5 +40,5 @@ repos:
         always_run: true
         language: system
         types: [python]
-        stages: [push]
+        stages: [pre-push]
         verbose: true

README.md

@@ -11,12 +11,26 @@ reproducibly generate, persist, and load artifacts using parameter based persist
 
 # Installation
 
+## Install as Dependency
 ```
 pip install persistable
 ```
 
 Note, this package requires Python 3.9+.
 
+## Install as Contributor
+The following assumes [uv](https://github.com/astral-sh/uv) is installed.
+
+Clone this repo and install into a venv using uv:
+```bash
+uv sync
+```
+
+Install the pre-commit hooks
+```bash
+uv run pre-commit install
+```
+
 # How It Works
 Each Persistable object has the following feature:
 

pyproject.toml

@@ -1,7 +1,53 @@
+[project]
+name = "persistable"
+dynamic = ["version"]
+description = "Reproducible parameter based pipelines and persisting"
+authors = [{ name = "Alexander Loosley", email = "aloosley@alumni.brown.edu" }, {name = "Stephan Sahm", email = "Stephan.Sahm@gmx.de"}]
+readme = "README.md"
+keywords = ["persisting", "models", "pipeline"]
+requires-python = ">=3.9"
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3"
+]
+dependencies = [
+    "numpy>=1.21.0",
+]
+
+[project.urls]
+Repository = "https://github.com/aloosley/persistable"
+
+[dependency-groups]
+dev = [
+    "pre-commit>=2.19.0",
+    "pytest>=7.1.2",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "persistable/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "persistable/"
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["persistable/"]
+
+
 [tool.black]
 line-length = 120
-target-version = ['py310']
+target-version = ['py313']
+
+[tool.flake8]
+max-line-length = 120
 
 [tool.mypy]
-python_version = "3.10"
 ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]