Migrate to uv (#1073)

* Migrate pyproject.toml to uv

* Update getting started docs

* Update workflow to use setup-uv

Author: misode

.github/workflows/main.yml

@@ -29,30 +29,15 @@ jobs:
         if: github.event_name == 'pull_request'
         run: git fetch origin ${{ github.base_ref }}
 
-      - name: Set up Python
-        uses: actions/setup-python@v5
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v3
         with:
-          python-version: '3.10'
-
-      - name: Install Poetry
-        uses: snok/[email protected]
-        with:
-          virtualenvs-in-project: true
-
-      - name: Setup cache
-        id: cached-poetry-dependencies
-        uses: actions/cache@v4
-        with:
-          path: .venv
-          key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
-
-      - name: Install dependencies
-        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-        run: poetry install
+          version: '0.5.4'
+          enable-cache: true
 
       - name: Build and publish all modules
         if: github.event_name != 'pull_request'
-        run: poetry run beet -p beet-release.yaml -l ${{ env.LOG_LEVEL }} build
+        run: uv run beet -p beet-release.yaml -l ${{ env.LOG_LEVEL }} build
         env:
           BEET_MODRINTH_TOKEN: ${{ secrets.MODRINTH_TOKEN }}
           BEET_SMITHED_TOKEN: ${{ secrets.SMITHED_TOKEN }}
@@ -61,7 +46,7 @@ jobs:
 
       - name: Build all modules for pull request
         if: github.event_name == 'pull_request'
-        run: poetry run beet -p beet-release.yaml -l ${{ env.LOG_LEVEL }} build
+        run: uv run beet -p beet-release.yaml -l ${{ env.LOG_LEVEL }} build
         env:
           LOG_LEVEL: ${{ runner.debug == 1 && 'DEBUG' || 'INFO'}}
 
@@ -121,29 +106,14 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python 3.10
-        uses: actions/setup-python@v5
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v3
         with:
-          python-version: '3.10'
-
-      - name: Install Poetry
-        uses: snok/[email protected]
-        with:
-          virtualenvs-in-project: true
-
-      - name: Setup cache
-        id: cached-poetry-dependencies
-        uses: actions/cache@v4
-        with:
-          path: .venv
-          key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
-
-      - name: Install dependencies
-        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-        run: poetry install
+          version: '0.5.4'
+          enable-cache: true
 
       - name: Build all modules for tests
-        run: poetry run beet -p beet-test.yaml -l ${{ env.LOG_LEVEL }} build
+        run: uv run beet -p beet-test.yaml -l ${{ env.LOG_LEVEL }} build
         env:
           LOG_LEVEL: ${{ runner.debug == 1 && 'DEBUG' || 'INFO'}}
 

.gitignore

@@ -11,6 +11,7 @@ __pycache__/
 *.py[cod]
 *$py.class
 .python-version
+*.egg-info/
 
 ### Beet ###
 out/

docs/getting-started.md

@@ -9,9 +9,16 @@ This guide will show how to setup a local development environment to build, test
 ## Installation
 To contribute to our project you need to install [Git](https://git-scm.com/downloads) and a text editor. We recommend [VSCode](https://code.visualstudio.com/).
 
-Our modules are built using [beet](https://github.com/mcbeet/beet), which allows us to automatically validate and generate part of our data packs and resource packs. However this requires some extra setup:
-* [Python](https://www.python.org/downloads/) (version 3.10)
-* [Poetry](https://python-poetry.org/docs/)
+Our modules are built using [beet](https://github.com/mcbeet/beet), which is a Python framework that allows us to automatically validate and generate part of our data packs and resource packs.
+
+You will need to install [uv](https://docs.astral.sh/uv/) as project manager. If you don't already have Python installed, uv will do that automatically.
+```sh
+# MacOS, Linux, or Git Bash (recommended)
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Powershell on Windows
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
 
 Create your own fork of this repository.
 ![Forking the repository on GitHub](images/create-fork.png)
@@ -21,25 +28,25 @@ Clone your fork locally:
 git clone https://github.com/<username>/GM4_Datapacks.git
 ```
 
-Open the `GM4_Datapacks` folder in VScode. Then run `poetry install`. This will install beet and all our other dependencies.
+Open the `GM4_Datapacks` folder in VScode. Then run `uv sync`. This will install beet and all our other dependencies.
 
 You are now ready to build our modules and make changes!
 
 ## Building modules
 The source of each module is stored in each `gm4_*` folder. To convert them to a valid data pack, you need to use Beet:
 
 ```
-poetry run beet dev --link <world_name> --watch metallurgy *_shamir
+uv run beet dev --link <world_name> --watch metallurgy *_shamir
 ```
-* `poetry run` makes sure that the command uses the correct Python dependencies
+* `uv run` makes sure that the command uses the correct Python dependencies
 * `beet dev` builds the data packs to the `out` folder
 * `--link <world_name>` copies the packs to a local world
 * `--watch` watches for file changes and then rebuilds
 * `metallurgy *_shamir` specifies the list of module IDs to build
 
 Building the release version of all modules is also possible. It will output the zipped data packs in the `release/<version>` folder. Running this could take a few minutes!
 ```
-poetry run beet -p beet-release.yaml build
+uv run beet -p beet-release.yaml build
 ```
 
 ## Submitting changes
@@ -55,7 +62,7 @@ git checkout -b <branch_name>
 While making changes, test the data packs in a local world:
 
 ```
-poetry run beet dev --link <world_name> --watch <module_id>
+uv run beet dev --link <world_name> --watch <module_id>
 ```
 
 When you are happy with the changes, create a commit on the branch.

pyproject.toml

@@ -1,25 +1,30 @@
-[tool.poetry]
+[project]
 name = "gm4"
 version = "1.0.0"
-description = "Datapacks for https://gm4.co"
-authors = ["Gamemode 4 Contributors"]
+description = "Data packs for https://gm4.co"
+authors = [
+    {name = "Gamemode 4 Contributors"},
+]
+requires-python = ">= 3.10, < 4.0"
+dependencies = [
+    "beet @ git+https://github.com/misode/beet.git@fix-overlay-folders",
+    "mecha >= 0.95.2",
+    "bolt >= 0.49.1",
+    "PyYAML >= 6.0, < 7.0",
+    "pydantic >= 2.6.1, < 3.0.0",
+    "requests >= 2.28.1, < 3.0.0",
+    "pillow >= 10.0.0, < 11.0.0",
+    "repro-zipfile >= 0.1.0, < 1.0.0",
+]
 
-[tool.poetry.dependencies]
-python = "^3.10"
-beet = { git = "https://github.com/misode/beet.git", rev = "fix-overlay-folders" }
-mecha = ">=0.95.2"
-bolt = ">=0.49.1"
-PyYAML = "^6.0"
-pydantic = "^2.6.1"
-requests = "^2.28.1"
-pillow = "^10.0.0"
-repro-zipfile = "^0.1.0"
+[tool.uv]
+dev-dependencies = [
+    "black >= 22.6.0, < 23.0.0",
+    "isort >= 5.10.1, < 6.0.0",
+    "uv >= 0.5.4",
+]
 
-[tool.poetry.dev-dependencies]
-black = "^22.6.0"
-isort = "^5.10.1"
-
-[tool.poetry.plugins.beet]
+[project.entry-points.beet]
 commands = "gm4.commands"
 autoload = "gm4.plugins.autoload"
 
@@ -32,5 +37,7 @@ typeCheckingMode = "strict"
 profile = "black"
 
 [build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"
+requires = ["setuptools"]
+
+[tool.setuptools]
+packages = ["gm4"]