refactor: switch to uv (#67)

* refactor: switched to uv

* refactor: switched to uv

* ci: enable uv caching

* build: added pyright config to the pyproject.toml

* fix: added package manifest

* refactor: removed un-needed docker-compose version

* build: moved the project version to the pyproject.toml

* fix: test cases

* chore: address pr comments

Author: mplemay

.github/scripts/update_version.py

@@ -0,0 +1,115 @@
+# /// script
+# requires-python = ">=3.13"
+# dependencies = [
+#     "packaging",
+#     "toml",
+# ]
+# ///
+
+import sys
+from pathlib import Path
+from sys import stdout
+
+import toml
+from packaging.version import parse
+
+
+def update_version_rust(new_version: str):
+    cargo_path = Path("Cargo.toml")
+    if not cargo_path.exists():
+        stdout.write("Cargo.toml not found, skipping version update")
+        return
+
+    filedata = toml.loads(cargo_path.read_text())
+
+    # If the new version is a pre-release version, we need to reformat it
+    # to align with Cargo standards
+    # pip format uses "0.1.0.dev1" while Cargo uses "0.1.0-dev1"
+    cargo_version = format_cargo_version(new_version)
+
+    if "package" not in filedata:
+        raise ValueError("Cargo.toml is missing the [package] section")
+
+    filedata["package"]["version"] = cargo_version
+
+    cargo_path.write_text(toml.dumps(filedata))
+
+
+def format_cargo_version(new_version: str) -> str:
+    parsed_version = parse(new_version)
+
+    cargo_version = (
+        f"{parsed_version.major}.{parsed_version.minor}.{parsed_version.micro}"
+    )
+    if parsed_version.is_prerelease and parsed_version.pre is not None:
+        pre_release = ".".join(str(x) for x in parsed_version.pre)
+        cargo_version += f"-{pre_release.replace('.', '')}"
+    if parsed_version.is_postrelease and parsed_version.post is not None:
+        cargo_version += f"-post{parsed_version.post}"
+    if parsed_version.is_devrelease and parsed_version.dev is not None:
+        cargo_version += f"-dev{parsed_version.dev}"
+
+    return cargo_version
+
+
+def update_version_python(new_version: str):
+    pyproject_path = Path("pyproject.toml")
+    if not pyproject_path.exists():
+        print("pyproject.toml not found, skipping version update")  # noqa: T201
+        return
+
+    filedata = toml.loads(pyproject_path.read_text())
+
+    # Parse the new version to ensure it's valid and potentially reformat
+    python_version = format_python_version(new_version)
+
+    updated = False
+
+    # Update poetry version if it exists
+    if "tool" in filedata and "poetry" in filedata["tool"]:
+        filedata["tool"]["poetry"]["version"] = python_version
+        updated = True
+
+    # Update project.version if it exists
+    if "project" in filedata and "version" in filedata["project"]:
+        filedata["project"]["version"] = python_version
+        updated = True
+
+    if not updated:
+        print(  # noqa: T201
+            "Warning: Neither [tool.poetry] nor [project] sections found in pyproject.toml"
+        )
+        return
+
+    pyproject_path.write_text(toml.dumps(filedata))
+
+
+def format_python_version(new_version: str) -> str:
+    parsed_version = parse(new_version)
+    # Assuming semantic versioning, format it as needed
+    python_version = (
+        f"{parsed_version.major}.{parsed_version.minor}.{parsed_version.micro}"
+    )
+    if parsed_version.is_prerelease and parsed_version.pre is not None:
+        pre_release = ".".join(str(x) for x in parsed_version.pre)
+        python_version += (
+            f".dev{parsed_version.pre[-1]}"
+            if pre_release.startswith("dev")
+            else f"b{parsed_version.pre[-1]}"
+        )
+    if parsed_version.is_postrelease and parsed_version.post is not None:
+        python_version += f".post{parsed_version.post}"
+    if parsed_version.is_devrelease and parsed_version.dev is not None:
+        python_version += f".dev{parsed_version.dev}"
+    return python_version
+
+
+if __name__ == "__main__":
+    if len(sys.argv) != 2:
+        stdout.write("Usage: python update_version.py <new_version>")
+        sys.exit(1)
+    new_version = sys.argv[1].lstrip("v")
+    update_version_rust(new_version)
+    update_version_python(new_version)
+    stdout.write(f"Updated version to: {new_version}")
+

.github/scripts/update_version.py.lock

@@ -0,0 +1,27 @@
+version = 1
+revision = 1
+requires-python = ">=3.13"
+
+[manifest]
+requirements = [
+    { name = "packaging" },
+    { name = "toml" },
+]
+
+[[package]]
+name = "packaging"
+version = "24.2"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/d0/63/68dbb6eb2de9cb10ee4c9c14a0148804425e13c4fb20d61cce69f53106da/packaging-24.2.tar.gz", hash = "sha256:c228a6dc5e932d346bc5739379109d49e8853dd8223571c7c5b55260edc0b97f", size = 163950 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/88/ef/eb23f262cca3c0c4eb7ab1933c3b1f03d021f2c48f54763065b6f0e321be/packaging-24.2-py3-none-any.whl", hash = "sha256:09abb1bccd265c01f4a3aa3f7a7db064b36514d2cba19a2f694fe6150451a759", size = 65451 },
+]
+
+[[package]]
+name = "toml"
+version = "0.10.2"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/be/ba/1f744cdc819428fc6b5084ec34d9b30660f6f9daaf70eead706e3203ec3c/toml-0.10.2.tar.gz", hash = "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f", size = 22253 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/44/6f/7120676b6d73228c96e17f1f794d8ab046fc910d781c8d151120c3f1569e/toml-0.10.2-py2.py3-none-any.whl", hash = "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b", size = 16588 },
+]

.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        python-version: ["3.11", "3.12"]
+        python-version: ["3.11", "3.12", "3.13"]
     services:
       postgres:
         image: postgres:latest
@@ -30,33 +30,26 @@ jobs:
           --health-timeout 5s
           --health-retries 5
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - name: Install uv and with python version ${{ matrix.python-version }}
+        uses: astral-sh/setup-uv@v5
         with:
+          enable-cache: true
           python-version: ${{ matrix.python-version }}
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-      - name: Install dependencies
-        run: poetry install
       - name: Run tests
-        run: |
-          poetry run pytest -v --continue-on-collection-errors
+        run: uv run pytest -v --continue-on-collection-errors
         env:
           ICEAXE_LOG_LEVEL: DEBUG
 
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - name: Install uv with Python 3.13
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: "3.12"
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-      - name: Install dependencies
-        run: poetry install
+          enable-cache: true
+          python-version: 3.13
       - name: Run lint
         run: make lint
 
@@ -68,15 +61,17 @@ jobs:
         os: [ubuntu-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - name: Install uv with Python 3.13
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: "3.12"
+          enable-cache: true
+          python-version: 3.13
 
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
+      - name: Update version
+        if: startsWith(github.ref, 'refs/tags/v')
+        shell: bash
+        run: uv run .github/scripts/update_version.py ${{ github.ref_name }}
 
       - name: Clean build artifacts
         run: |
@@ -87,13 +82,6 @@ jobs:
           find . -type f -name "*.o" -delete
           find . -type f -name "*.c" -delete
 
-      - name: Update version in pyproject.toml
-        if: startsWith(github.ref, 'refs/tags/v')
-        run: |
-          VERSION=${GITHUB_REF#refs/tags/v}
-          poetry version $VERSION
-        shell: bash
-
       - name: Set up QEMU
         if: runner.os == 'Linux'
         uses: docker/setup-qemu-action@v3
@@ -102,7 +90,7 @@ jobs:
 
       - name: Build SDist
         if: matrix.os == 'ubuntu-latest'
-        run: poetry build --format sdist
+        run: uv build --sdist
 
       - name: Build wheels
         uses: pypa/[email protected]

MANIFEST.in

@@ -0,0 +1 @@
+include iceaxe/*.pyx

Makefile

@@ -23,19 +23,19 @@ lint-validation: lint-validation-iceaxe
 # Testing target
 test: test-iceaxe
 
-# Install all sub-project dependencies with poetry
+# Install all sub-project dependencies with uv
 install-deps: install-deps-iceaxe
 
 install-deps-iceaxe:
 	@echo "Installing dependencies for $(ICEAXE)..."
-	@(cd $(ICEAXE) && poetry install)
+	@(cd $(ICEAXE) && uv sync)
 
-# Clean the current poetry.lock files, useful for remote CI machines
+# Clean the current uv.lock files, useful for remote CI machines
 # where we're running on a different base architecture than when
 # developing locally
-clean-poetry-lock:
-	@echo "Cleaning poetry.lock files..."
-	@rm -f $(ICEAXE)/poetry.lock
+clean-uv-lock:
+	@echo "Cleaning uv.lock files..."
+	@rm -f $(ICEAXE)/uv.lock
 
 # Standard linting - local development, with fixing enabled
 lint-iceaxe:
@@ -59,25 +59,25 @@ test-iceaxe:
 
 define test-common
 	echo "Running tests for $(2)..."
-	@(cd $(1) && poetry run pytest -W error -vv $(test-args) $(2))
+	@(cd $(1) && uv run pytest -W error -vv $(test-args) $(2))
 endef
 
 define lint-common
 	echo "Running linting for $(2)..."
-	@(cd $(1) && poetry run ruff format $(2))
-	@(cd $(1) && poetry run ruff check --fix $(2))
+	@(cd $(1) && uv run ruff format $(2))
+	@(cd $(1) && uv run ruff check --fix $(2))
 	echo "Running pyright for $(2)..."
-	@(cd $(1) && poetry run pyright $(2))
+	@(cd $(1) && uv run pyright $(2))
 endef
 
 define lint-validation-common
 	echo "Running lint validation for $(2)..."
-	@(cd $(1) && poetry run ruff format --check $(2))
-	@(cd $(1) && poetry run ruff check $(2))
+	@(cd $(1) && uv run ruff format --check $(2))
+	@(cd $(1) && uv run ruff check $(2))
 	echo "Running mypy for $(2)..."
-	@(cd $(1) && poetry run mypy $(2))
+	@(cd $(1) && uv run mypy $(2))
 	echo "Running pyright for $(2)..."
-	@(cd $(1) && poetry run pyright $(2))
+	@(cd $(1) && uv run pyright $(2))
 endef
 
 

README.md

@@ -28,7 +28,7 @@ To auto-optimize your self hosted Postgres install, check out our new [autopg](h
 If you're using poetry to manage your dependencies:
 
 ```bash
-poetry add iceaxe
+uv add iceaxe
 ```
 
 Otherwise install with pip:
@@ -229,7 +229,7 @@ network connections in the first place.
 We have basic benchmarking tests in the `__tests__/benchmarks` directory. To run them, you'll need to execute the pytest suite:
 
 ```bash
-poetry run pytest -m integration_tests
+uv run pytest -m integration_tests
 ```
 
 Current benchmarking as of October 11 2024 is:
@@ -242,8 +242,8 @@ Current benchmarking as of October 11 2024 is:
 ## Development
 
 If you update your Cython implementation during development, you'll need to re-compile the Cython code. This can be done with
-a simple poetry install. Poetry is set up to create a dynamic `setup.py` based on our `build.py` definition.
+a simple uv sync.
 
 ```bash
-poetry install
+uv sync
 ```

build.py

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   postgres:
     image: postgres:16

docker-compose.test.yml

@@ -7,13 +7,13 @@ SQL queries that are actually sent to your database. You can set the `ICEAXE_LOG
 variable to `DEBUG` to enable verbose logging:
 
 ```bash
-ICEAXE_LOG_LEVEL=DEBUG poetry run runserver
+ICEAXE_LOG_LEVEL=DEBUG uv run runserver
 ```
 
 This results in a lot of output, so you may want to pipe it to a file:
 
 ```bash
-ICEAXE_LOG_LEVEL=DEBUG poetry run runserver > debug.log
+ICEAXE_LOG_LEVEL=DEBUG uv run runserver > debug.log
 ```
 
 Each entry in the log will be a JSON formatted, single-lined