switch from rye to uv (#100)

Roger-luo · web-flow · commit c05dd18892fa · 2024-11-09T18:14:09.000-05:00
* setup uv

* fix ci

* fix doc build

* clean up README

* fix doc ci

* update script with uv
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -24,16 +24,20 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - name: setup-rye
-        uses: eifinger/setup-rye@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
         with:
-            enable-cache: true
-            cache-prefix: "rye-cache-ci"
-      - run: rye pin cpython@${{ matrix.python-version }}
-      - run: rye sync
-      - name: Test with pytest & generate coverage
-        run: |
-          rye run coverage:github
+          # Install a specific version of uv.
+          version: "0.5.1"
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+      - name: Install the project
+        run: uv sync --all-extras --dev
+      - name: Run tests
+        # For example, using `pytest`
+        run: uv run just coverage
       - name: Upload Coverage to Codecov
         uses: codecov/codecov-action@v4
         with:
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -16,16 +16,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Set up rye
-        uses: eifinger/setup-rye@v3
-      - name: Update Rye
-        run: |
-          rye self update
-      - name: Sync dependencies using rye
-        run: |
-          rye config --set-bool behavior.use-uv=true
-          rye pin 3.10
-          rye sync
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          # Install a specific version of uv.
+          version: "0.5.1"
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - name: Install Documentation dependencies
+        run: uv sync --group doc
       - name: Set up build cache
         uses: actions/cache@v4
         id: cache
@@ -38,7 +37,7 @@ jobs:
         env:
           GH_TOKEN: ${{ secrets.GH_TOKEN }}
         run: |
-          rye run mkdocs build
+          uv run mkdocs build
       - name: Deploy preview
         uses: rossjrw/pr-preview-action@v1
         with:
diff --git a/README.md b/README.md
@@ -14,66 +14,8 @@ _The multi-level intermediate representation (MLIR) compiler for high-level sema
 
 ## Installation
 
-### Install via `rye` (Recommended)
+### Install via `uv` (Recommended)
 
-This package is registered in `quera-algo` repository. If you have not set up the repository, you can add the following to `~/.rye/config.toml`:
-
-```toml
-[[sources]]
-name = "quera-algo"
-url = "https://rluo@quera.com:<PASSWORD>@quera.jfrog.io/artifactory/api/pypi/quera-algo/simple"
-type = "index"
-```
-
-where `<PASSWORD>` can be found on QuEra's JFrog Artifactory. Then you can install the package by:
-
-```bash
-rye add kirin-toolchain
-rye sync
-```
-
-### Install via `pip` (Less Recommended)
-
-Or you can use it via `pip` by copying the following to `~/.pip/pip.conf`:
-
-```conf
-[global]
-index-url = https://rluo@quera.com:<PASSWORD>@quera.jfrog.io/artifactory/api/pypi/quera-algo/simple
+```py
+uv add kirin-toolchain
 ```
-
-then install the package by:
-
-```bash
-pip install kirin-toolchain
-```
-
-## See Also
-
-Several dialects are defined in their own packages. The close relatives are
-defined as namespace packages. See [kirin-workspace](https://github.com/QuEraComputing/kirin-workspace) to develop them together.
-
-## Roadmap
-
-Some features of this compiler before we all in [MLIR][mlir]:
-
-- [x] a [MLIR-like][mlir] IR infrastructure specialized for FLAIR
-  - [ ] progressive lowering
-  - [x] dialects for several compilation stages
-- [x] a [Julia-like][julia] JIT compiler
-  - [x] abstract interpretation
-  - [x] linear type system on SSA with type inference
-- [x] [Jax][jax]-like frontend
-
-## References
-
-- current [flair.py][flair.py]
-- [xdsl][xdsl]
-- [mlir][mlir]
-- [Julia/base/compiler][julia] compiler
-- [jax][jax]
-
-[flair.py]: https://github.com/QuEraComputing/flair.py
-[xdsl]: https://github.com/xdslproject/xdsl
-[mlir]: https://mlir.llvm.org/
-[julia]: https://github.com/JuliaLang/julia/tree/master/base/compiler
-[jax]: https://jax.readthedocs.io/en/latest/
diff --git a/justfile b/justfile
@@ -0,0 +1,22 @@
+coverage-run:
+    coverage run -m pytest test
+
+coverage-xml:
+    coverage xml
+
+coverage-html:
+    coverage html
+
+coverage-report:
+    coverage report
+
+coverage-open:
+    open htmlcov/index.html
+
+coverage: coverage-run coverage-xml coverage-report
+
+doc:
+    mkdocs serve
+
+doc-build:
+    mkdocs build
diff --git a/pyproject.toml b/pyproject.toml
@@ -15,50 +15,6 @@ requires-python = ">= 3.10"
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
-[tool.rye]
-managed = true
-dev-dependencies = [
-    "black>=24.2.0",
-    "ruff>=0.3.0",
-    "pytest>=8.1.1",
-    "ipython>=8.12.3",
-    "pre-commit>=3.5.0",
-    "python-pptx>=0.6.23",
-    "isort>=5.13.2",
-    "coverage>=7.4.4",
-    "mkdocs>=1.5.3",
-    "mike>=2.0.0",
-    "twine>=5.0.0",
-    "tomlkit>=0.12.4",
-    "numpy>=1.26.4",
-    "mypy>=1.11.2",
-    "pyright>=1.1.380",
-    "mkdocs-material>=9.5.27",
-    "mkdocstrings[python]>=0.25.1",
-    "mkdocs-gen-files>=0.5.0",
-    "mkdocs-literate-nav>=0.6.1",
-    "mkdocs-minify-plugin>=0.8.0",
-    "griffe-inherited-docstrings>=1.1.1",
-]
-
-[tool.rye.scripts]
-clean = "git clean -f"
-release = "python scripts/release.py"
-"coverage:run" = "coverage run -m pytest test"
-"coverage:xml" = "coverage xml"
-"coverage:html" = "coverage html"
-"coverage:report" = "coverage report"
-"coverage:open" = "open htmlcov/index.html"
-"coverage:github" = { chain = [
-    "coverage:run",
-    "coverage:xml",
-    "coverage:report",
-] }
-"test:all" = "pytest test"
-"doc:serve" = "mkdocs serve"
-"doc:build" = "mkdocs build"
-
-
 [tool.hatch.metadata]
 allow-direct-references = true
 
@@ -104,3 +60,30 @@ dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
 
 [tool.coverage.run]
 include = ["src/kirin/*"]
+
+[tool.uv]
+dev-dependencies = [
+    "black>=24.10.0",
+    "coverage>=7.6.4",
+    "ipython>=8.29.0",
+    "isort>=5.13.2",
+    "mypy>=1.13.0",
+    "numpy>=2.1.3",
+    "pre-commit>=4.0.1",
+    "pyright>=1.1.388",
+    "pytest>=8.3.3",
+    "ruff>=0.7.3",
+    "rust-just>=1.36.0",
+]
+
+[dependency-groups]
+doc = [
+    "griffe-inherited-docstrings>=1.1.1",
+    "mike>=2.1.3",
+    "mkdocs>=1.6.1",
+    "mkdocs-gen-files>=0.5.0",
+    "mkdocs-literate-nav>=0.6.1",
+    "mkdocs-material>=9.5.44",
+    "mkdocs-minify-plugin>=0.8.0",
+    "mkdocstrings[python]>=0.27.0",
+]
diff --git a/scripts/release.py b/scripts/release.py
@@ -86,9 +86,9 @@ def fail_and_revert(msg):
 if subprocess.run(["git", "push"]).returncode != 0:
     fail_and_revert("Failed to push")
 
-# 1. build the package via rye
-print("rye build -c")
-if subprocess.run(["rye", "build", "-c"]).returncode != 0:
+# 1. build the package via uv
+print("uv build -c")
+if subprocess.run(["uv", "build", "-c"]).returncode != 0:
     fail_and_revert("Failed to build the package")
 
 # 2. create a new release
diff --git a/uv.lock b/uv.lock
