Hatch to manage Python virtualenvs

.github/workflows/test.yml

@@ -34,11 +34,12 @@ jobs:
           toolchain: stable
           profile: minimal
           default: true
+      - name: Install Hatch
+        run: |
+          pip install hatch
       - name: Build Ypy
         run: |
-          pip install maturin
-          maturin develop
+          hatch run maturin develop
       - name: Run Tests
         run: |
-          pip install pytest
-          pytest
+          hatch run pytest

Cargo.toml

@@ -2,10 +2,7 @@
 name = "y-py"
 version = "0.5.4"
 rust-version = "1.58"
-authors = ["John Waidhofer <[email protected]>", "Kevin Jahns <[email protected]>", "Pierre-Olivier Simonard <[email protected]>"]
 edition = "2018"
-homepage = "https://github.com/y-crdt/ypy"
-repository = "https://github.com/y-crdt/ypy"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

README.md

@@ -39,28 +39,28 @@ assert value == "hello world!"
 
 ## Development Setup
 
-0. Install Rust and Python
-1. Install `maturin` in order to build Ypy
+0. [Install Rust](https://www.rust-lang.org/tools/install) and [Python](https://www.python.org/downloads/) 
+  - Some alternative bootstrapping options are [pyenv](https://github.com/pyenv/pyenv) for Python, or using [mamba](https://github.com/conda-forge/miniforge) to `mamba install rust python`.
+1. Install [hatch](https://hatch.pypa.io/latest/install/) (`python -m pip install hatch`)
+2. Create a development build of the library
 
+*Make sure to `unset CONDA_PREFIX` if you are in a conda environment. If `hatch` is not found on your PATH, you can run `python -m hatch` instead*
 ```
-pip install maturin
+hatch run maturin develop
 ```
 
-2. Create a development build of the library
-   `maturin develop`
-
 ## Tests
 
-All tests are located in `/tests`. You can run them with `pytest`.
+All tests are located in `/tests`. There is a `test` environment matrix defined in `pyproject.toml` that will run `pytest` against `py37` through `py310`.
 
 ```
-pytest
+hatch run test:pytest
 ```
 
 ## Build Ypy :
 
-Build the library as a wheel and store them in `target/wheels` :
+Build the library as a wheel and store them in `target/wheels`:
 
 ```
-maturin build
+hatch run maturin build
 ```

pyproject.toml

@@ -1,3 +1,20 @@
 [build-system]
 requires = ["maturin>=0.13,<0.14"]
 build-backend = "maturin"
+
+[project]
+name = "y-py"
+version = "0.5.4"
+description = "Python bindings for the Y-CRDT built from yrs (Rust)"
+authors = [
+    { name = "John Waidhofer", email = "[email protected]" },
+    { name = "Kevin Jahns", email = "[email protected]" },
+    { name = "Pierre-Olivier Simonard", email = "[email protected]" }
+]
+readme = "README.md"
+homepage = "https://github.com/y-crdt/ypy"
+repository = "https://github.com/y-crdt/ypy"
+dependencies = ["pytest", "maturin"]
+
+[[tool.hatch.envs.test.matrix]]
+python = ["37", "38", "39", "310"]