Merge pull request #2849 from crytic/build-system-hatchling

Build: Migrate from setuptools to hatchling with uv

Author: smonicas

.github/workflows/black_auto.yml

@@ -31,11 +31,11 @@ jobs:
           python-version: 3.8
 
       - name: Run black
-        uses: psf/black@stable
+        uses: psf/black@24.8.0
         with:
           options: ""
           summary: false
-          version: "~= 22.3.0"
+          version: "<24.10.0"
 
       - name: Annotate diff changes using reviewdog
         uses: reviewdog/action-suggester@v1

.github/workflows/ci.yml

@@ -35,15 +35,19 @@ jobs:
           # Requires nvm
           - os: windows-2022
             type: truffle
+          # fasttext fails to install on Windows
+          - os: windows-2022
+            type: simil
     steps:
       - uses: actions/checkout@v6
-      - name: Set up Python ${{ matrix.python }}
-        uses: actions/setup-python@v6
+      - name: Install uv and Python ${{ matrix.python }}
+        uses: astral-sh/setup-uv@v7
         with:
           python-version: ${{ matrix.python }}
+          activate-environment: true
       - name: Install dependencies
         run: |
-          pip install ".[test]"
+          uv sync --group test
           solc-select use 0.8.0 --always-install
           solc-select use 0.7.0 --always-install
           solc-select use 0.5.1 --always-install

.github/workflows/docs.yml

@@ -31,10 +31,12 @@ jobs:
         uses: actions/checkout@v6
       - name: Setup Pages
         uses: actions/configure-pages@v5
-      - uses: actions/setup-python@v6
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@v7
         with:
-          python-version: '3.8'
-      - run: pip install -e ".[doc]"
+          python-version: "3.8"
+          activate-environment: true
+      - run: uv sync --group doc
       - run: pdoc -o html/ slither '!slither.tools' #TODO fix import errors on pdoc run
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v4

.github/workflows/doctor.yml

@@ -36,27 +36,13 @@ jobs:
         with:
           python-version: ${{ matrix.python }}
 
-      - name: Try system-wide Slither
-        run: |
-          echo "::group::Install slither"
-          pip3 install .
-          echo "::endgroup::"
-
-          # escape cwd so python doesn't pick up local module
-          cd /
-
-          echo "::group::Via module"
-          python3 -m slither.tools.doctor .
-          echo "::endgroup::"
-
-          echo "::group::Via binary"
-          slither-doctor .
-          echo "::endgroup::"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
 
-      - name: Try user Slither
+      - name: Try system-wide Slither
         run: |
           echo "::group::Install slither"
-          pip3 install --user .
+          uv pip install --system .
           echo "::endgroup::"
 
           # escape cwd so python doesn't pick up local module
@@ -73,10 +59,10 @@ jobs:
       - name: Try venv Slither
         run: |
           echo "::group::Install slither"
-          python3 -m venv venv
-          source venv/bin/activate || source venv/Scripts/activate
+          uv venv          
+          uv pip install .
+          source .venv/bin/activate || source .venv/Scripts/activate
           hash -r
-          pip3 install .
           echo "::endgroup::"
 
           # escape cwd so python doesn't pick up local module

.github/workflows/pip-audit.yml

@@ -20,20 +20,16 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v6
 
-      - name: Install Python
-        uses: actions/setup-python@v6
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@v7
         with:
           python-version: "3.10"
 
       - name: Install Slither
         run: |
-          python -m venv /tmp/pip-audit-env
-          source /tmp/pip-audit-env/bin/activate
-
-          python -m pip install --upgrade pip setuptools wheel
-          python -m pip install .
+          uv export --format requirements-txt --no-emit-project > requirements.txt
 
       - name: Run pip-audit
         uses: pypa/[email protected]
         with:
-          virtual-environment: /tmp/pip-audit-env
+          inputs: requirements.txt

.github/workflows/publish.yml

@@ -12,16 +12,12 @@ jobs:
     steps:
       - uses: actions/checkout@v6
 
-      - name: Set up Python
-        uses: actions/setup-python@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
         with:
-          python-version: '3.x'
-
+          activate-environment: true
       - name: Build distributions
-        run: |
-          python -m pip install --upgrade pip
-          python -m pip install build
-          python -m build
+        run: uv build
       - name: Upload distributions
         uses: actions/upload-artifact@v5
         with:

.github/workflows/test.yml

@@ -28,16 +28,15 @@ jobs:
         python: ${{ (github.event_name == 'pull_request' && fromJSON('["3.8", "3.12"]')) || fromJSON('["3.8", "3.9", "3.10", "3.11", "3.12"]') }}
     steps:
       - uses: actions/checkout@v6
-      - name: Set up Python ${{ matrix.python }}
-        uses: actions/setup-python@v6
+      - name: Install uv and Python ${{ matrix.python }}
+        uses: astral-sh/setup-uv@v7
         with:
           python-version: ${{ matrix.python }}
-          cache: "pip"
-          cache-dependency-path: setup.py
+          activate-environment: true
 
       - name: Install dependencies
         run: |
-          pip install ".[test]"
+          uv sync --group test
 
       - name: Setup node
         uses: actions/setup-node@v6
@@ -101,12 +100,13 @@ jobs:
 
     steps:
       - uses: actions/checkout@v6
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v6
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@v7
         with:
-          python-version: 3.8
+          python-version: "3.8"
+          activate-environment: true
 
-      - run: pip install coverage[toml]
+      - run: uv pip install coverage[toml]
 
       - name: download coverage data
         uses: actions/download-artifact@v6

CONTRIBUTING.md

@@ -47,6 +47,16 @@ A code walkthrough is available [here](https://www.youtube.com/watch?v=EUl3UlYSl
 
 Instructions for installing a development version of Slither can be found in our [wiki](https://github.com/crytic/slither/wiki/Developer-installation).
 
+For development setup, we use [uv](https://github.com/astral-sh/uv):
+
+```bash
+# Install uv if you haven't already
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Setup development environment
+make dev  # Creates venv and installs all dependencies
+```
+
 To run the unit tests, you need to clone this repository and run `make test`. Run a specific test with `make test TESTS=$test_name`. The names of tests can be obtained with `pytest tests --collect-only`.
 
 ### Linters
@@ -111,9 +121,9 @@ For each new detector, at least one regression tests must be present.
 
 ### Synchronization with crytic-compile
 
-By default, `slither` follows either the latest version of crytic-compile in pip, or `crytic-compile@master` (look for dependencies in [`setup.py`](./setup.py). If crytic-compile development comes with breaking changes, the process to update `slither` is:
+By default, `slither` follows either the latest version of crytic-compile in pip, or `crytic-compile@master` (look for dependencies in [`pyproject.toml`](./pyproject.toml). If crytic-compile development comes with breaking changes, the process to update `slither` is:
 
-- Update `slither/setup.py` to point to the related crytic-compile's branch
+- Update `slither/pyproject.toml` to point to the related crytic-compile's branch
 - Create a PR in `slither` and ensure it passes the CI
 - Once the development branch is merged in `crytic-compile@master`, ensure `slither` follows the `master` branch
 

Makefile

@@ -49,10 +49,9 @@ run: $(VENV)/pyvenv.cfg
 	@. $(VENV_BIN)/activate && slither $(ARGS)
 
 $(VENV)/pyvenv.cfg: pyproject.toml
-	# Create our Python 3 virtual environment
-	python3 -m venv env
-	$(VENV_BIN)/python -m pip install --upgrade pip
-	$(VENV_BIN)/python -m pip install -e .[$(SLITHER_EXTRA)]
+	# Create virtual environment and install dependencies using uv
+	uv venv $(VENV)
+	uv sync --python $(VENV_BIN)/python --group $(SLITHER_EXTRA)
 
 .PHONY: lint
 lint: $(VENV)/pyvenv.cfg
@@ -81,7 +80,7 @@ doc: $(VENV)/pyvenv.cfg
 .PHONY: package
 package: $(VENV)/pyvenv.cfg
 	. $(VENV_BIN)/activate && \
-		python3 -m build
+		uv build
 
 .PHONY: edit
 edit:

README.md

@@ -17,8 +17,9 @@
 * [Features](#features)
 * [Usage](#usage)
 * [How to install](#how-to-install)
+  * [Using uv (Recommended)](#using-uv-recommended)
   * [Using Pip](#using-pip)
-  * [Using Git](#using-git)
+  * [Using Git](#using-git-development)
   * [Using Docker](#using-docker)
   * [Integration](#integration)
 * [Detectors](#detectors)
@@ -70,13 +71,34 @@ slither tests/uninitialized.sol
 > Slither requires Python 3.8+.
 If you're **not** going to use one of the [supported compilation frameworks](https://github.com/crytic/crytic-compile), you need [solc](https://github.com/ethereum/solidity/), the Solidity compiler; we recommend using [solc-select](https://github.com/crytic/solc-select) to conveniently switch between solc versions.
 
+### Using uv (Recommended)
+
+[uv](https://github.com/astral-sh/uv) is a fast Python package manager that's 10-100x faster than pip.
+
+```console
+# Install uv if you haven't already
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Install slither as a tool
+uv tool install slither-analyzer
+
+# Or run slither without installation
+uvx slither-analyzer <target>
+```
+
+To upgrade:
+
+```console
+uv tool upgrade slither-analyzer
+```
+
 ### Using Pip
 
 ```console
 python3 -m pip install slither-analyzer
 ```
 
-#### How to upgrade
+To upgrade:
 
 ```console
 python3 -m pip install --upgrade slither-analyzer
@@ -88,14 +110,19 @@ python3 -m pip install --upgrade slither-analyzer
 brew install slither-analyzer
 ```
 
-### Using Git
+### Using Git (Development)
 
 ```bash
 git clone https://github.com/crytic/slither.git && cd slither
-python3 -m pip install .
+
+# Install as editable for development
+uv tool install -e .
+
+# Or use uv run for testing without installation
+uv run slither <target>
 ```
 
-We recommend using a Python virtual environment, as detailed in the [Developer Installation Instructions](https://github.com/crytic/slither/wiki/Developer-installation), if you prefer to install Slither via git.
+The `-e` flag installs in editable mode, meaning changes to the source code are immediately reflected without reinstalling.
 
 ### Using Docker