Merge pull request #8 from Golem-Base/rvdp/uv

feat: migrate to uv

Author: r-vdp

.envrc

@@ -1 +1 @@
-use flake
+use flake . --builders ""

.github/workflows/example.yml

@@ -1,3 +1,5 @@
+name: Python Golem Base SDK CI
+
 on:
   push:
     branches:
@@ -8,53 +10,58 @@ on:
   workflow_dispatch:
 
 jobs:
-  run-python-example:
+  ci:
     runs-on: ubuntu-latest
 
-    #services:
-    #  gb-op-geth:
-    #    image: "quay.io/golemnetwork/gb-op-geth:latest"
-    #    ports:
-    #      - 8545:8545
-    #    options: |
-
     steps:
-      - name: Run a gb-op-geth container
-        run: >
-          docker run -d -p 8545:8545 -e GITHUB_ACTIONS=true -e CI=true
-          quay.io/golemnetwork/gb-op-geth:latest --dev --http --http.api
-          'eth,web3,net,debug,golembase' --verbosity 3 --http.addr '0.0.0.0' --http.port 8545
-          --http.corsdomain '*' --http.vhosts '*' --ws --ws.addr '0.0.0.0' --ws.port 8545
-
       - name: Check out the SDK repo
         uses: actions/checkout@v4
 
+      - name: Install Nix
+        uses: cachix/install-nix-action@v31
+
+      - name: Build the SDK
+        run: >
+          nix build .#golem-base-sdk --no-write-lock-file
+
+      - name: Build the SDK dist
+        run: >
+          nix build .#golem-base-sdk.dist --no-write-lock-file
+
+      - name: Build the example SDK app
+        run: >
+          nix build .#golem-base-sdk-example --no-write-lock-file --reference-lock-file
+          ../flake.lock
+        working-directory: ./example
+
       - name: Check out the gb-op-geth repo
         uses: actions/checkout@v4
         with:
           repository: Golem-Base/golembase-op-geth
           path: gb-op-geth
 
-      - name: Install Nix
-        uses: cachix/install-nix-action@v31
-
       - name: Set up Go
         uses: actions/setup-go@v5
         with:
           go-version-file: "gb-op-geth/go.mod"
           cache-dependency-path: |
             gb-op-geth/go.sum
 
+      - name: Run a gb-op-geth container
+        run: >
+          docker run -d -p 8545:8545 -e GITHUB_ACTIONS=true -e CI=true
+          quay.io/golemnetwork/gb-op-geth:latest --dev --http --http.api
+          'eth,web3,net,debug,golembase' --verbosity 3 --http.addr '0.0.0.0' --http.port 8545
+          --http.corsdomain '*' --http.vhosts '*' --ws --ws.addr '0.0.0.0' --ws.port 8545
+
       - name: Create and fund an account
         run: |
           go run ./cmd/golembase account create
           go run ./cmd/golembase account fund
         working-directory: ./gb-op-geth
 
-      - name: Build the example SDK app
-        run: nix build .#golem-base-sdk-example --no-write-lock-file
-        working-directory: ./example
-
       - name: Run the example SDK app
-        run: ./result/bin/main --instance local
+        run: >
+          nix develop --no-write-lock-file --reference-lock-file ../flake.lock --command
+          ./result/bin/main --instance local
         working-directory: ./example

example/.envrc

@@ -1 +1 @@
-use flake
+use flake . --reference-lock-file ../flake.lock --no-write-lock-file --builders ""

example/.uv-links

@@ -0,0 +1 @@
+/nix/store/8s2f649jy6gdc831xj5pcvrgnscffncb-uv-links

example/flake.nix

@@ -1,18 +1,40 @@
 {
   inputs = {
-    golem-base-sdk.url = "git+file:..";
+    nixpkgs.url = "https://channels.nixos.org/nixos-unstable/nixexprs.tar.xz";
 
     devshell = {
       url = "github:numtide/devshell";
       inputs = {
-        nixpkgs.follows = "golem-base-sdk/nixpkgs";
+        nixpkgs.follows = "nixpkgs";
       };
     };
 
     blueprint = {
       url = "github:numtide/blueprint";
       inputs = {
-        nixpkgs.follows = "golem-base-sdk/nixpkgs";
+        nixpkgs.follows = "nixpkgs";
+      };
+    };
+
+    pyproject-nix = {
+      url = "github:pyproject-nix/pyproject.nix";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+
+    uv2nix = {
+      url = "github:pyproject-nix/uv2nix";
+      inputs = {
+        pyproject-nix.follows = "pyproject-nix";
+        nixpkgs.follows = "nixpkgs";
+      };
+    };
+
+    pyproject-build-systems = {
+      url = "github:pyproject-nix/build-system-pkgs";
+      inputs = {
+        pyproject-nix.follows = "pyproject-nix";
+        uv2nix.follows = "uv2nix";
+        nixpkgs.follows = "nixpkgs";
       };
     };
   };

example/golem_base_sdk_example/__init__.py

@@ -217,6 +217,26 @@ async def run_example(instance: str) -> None:  # noqa: PLR0915
         )
 
         await watch_logs_handle.unsubscribe()
+
+        logger.info("""\n
+        *********************************************
+        * Creating an entity to test unsubscribe... *
+        *********************************************
+        """)
+
+        create_receipt = await client.create_entities(
+            [GolemBaseCreate(b"hello", 60, [Annotation("app", "demo")], [])]
+        )
+        entity_key = create_receipt[0].entity_key
+        logger.info("receipt: %s", create_receipt)
+        logger.info("entity count: %s", await client.get_entity_count())
+
+        logger.info("created entity with key %s", entity_key)
+        logger.info("storage value: %s", await client.get_storage_value(entity_key))
+        metadata = await client.get_entity_metadata(entity_key)
+        logger.info("entity metadata: %s", metadata)
+
+        await client.delete_entities([GolemBaseDelete(entity_key)])
     else:
         logger.warning("Could not connect to the API...")
 

example/nix/devshell.nix

@@ -1,11 +1,43 @@
-{ pkgs, perSystem, ... }:
+{
+  pkgs,
+  perSystem,
+  ...
+}:
+
+let
+  inherit (perSystem.self.golem-base-sdk-example.passthru) virtualenvDev;
+in
 
 perSystem.devshell.mkShell {
   packages = [
-    (pkgs.python3.withPackages (ps: [
-      ps.anyio
-      ps.pyxdg
-      perSystem.golem-base-sdk.golem-base-sdk
-    ]))
+    virtualenvDev
+    pkgs.uv
+  ];
+
+  env = [
+    {
+      # Don't create venv using uv
+      name = "UV_NO_SYNC";
+      value = "1";
+    }
+    {
+      # Force uv to use Python interpreter from venv
+      name = "UV_PYTHON";
+      value = "${virtualenvDev}/bin/python";
+    }
+    {
+      # Prevent uv from downloading managed Python's
+      name = "UV_PYTHON_DOWNLOADS";
+      value = "never";
+    }
   ];
+
+  devshell.startup.uv2nix.text =
+    # bash
+    ''
+      # Undo dependency propagation by nixpkgs.
+      unset PYTHONPATH
+      # Get repository root using git. This is expanded at runtime by the editable `.pth` machinery.
+      export REPO_ROOT=$(git rev-parse --show-toplevel)
+    '';
 }

example/nix/packages/golem-base-sdk-example.nix

@@ -1,78 +1,83 @@
 {
   pkgs,
-  pname,
-  perSystem,
+  inputs,
   ...
 }:
 
 let
   inherit (pkgs) lib;
 
-  types-pyxdg =
-    let
-      pname = "types-pyxdg";
-      version = "0.28.0.20240106";
-    in
-    pkgs.python3Packages.buildPythonPackage {
-      inherit pname version;
-      format = "pyproject";
+  # We need an actual path here, because of the editable install used below
+  src = ../..;
 
-      src = pkgs.fetchPypi {
-        inherit pname version;
-        hash = "sha256-UF/GOG2MCl0KkUzrK3bo4tvQsRAhK1s5Xb6xyUg+24g=";
-      };
-
-      nativeBuildInputs = [ pkgs.python3Packages.setuptools ];
-    };
+  workspace = inputs.uv2nix.lib.workspace.loadWorkspace {
+    workspaceRoot = src;
+  };
 
-in
+  overlay = workspace.mkPyprojectOverlay {
+    sourcePreference = "wheel";
+  };
 
-pkgs.python3Packages.buildPythonPackage {
-  inherit pname;
-  version = "0.0.1";
+  pythonSet =
+    (pkgs.callPackage inputs.pyproject-nix.build.packages {
+      python = pkgs.python312;
+    }).overrideScope
+      (
+        lib.composeManyExtensions [
+          inputs.pyproject-build-systems.overlays.default
+          overlay
+        ]
+      );
 
-  format = "pyproject";
+  inherit (pkgs.callPackages inputs.pyproject-nix.build.util { }) mkApplication;
 
-  src = lib.fileset.toSource {
-    root = ../..;
-    fileset = lib.fileset.unions (
-      map (lib.path.append ../..) [
-        "pyproject.toml"
-        "golem_base_sdk_example"
-        "README.md"
-      ]
-    );
+  editableOverlay = workspace.mkEditablePyprojectOverlay {
+    # This env var needs to be set to the root of the repo in the shell that runs the
+    # application, otherwise python will not import golem_base_sdk from the right place
+    root = "$REPO_ROOT/example";
+    # Only enable editable for this package
+    members = [ "golem-base-sdk" ];
   };
 
-  nativeBuildInputs = [
-    pkgs.python3Packages.flit-core
-  ];
+  editablePythonSet = pythonSet.overrideScope (
+    lib.composeManyExtensions [
+      editableOverlay
 
-  buildInputs = [
-    types-pyxdg
-  ];
+      # Apply fixups for building an editable package of your workspace packages
+      (final: prev: {
+        golem-base-sdk = prev.golem-base-sdk.overrideAttrs (old: {
+          # We need the editables build system added here
+          nativeBuildInputs =
+            old.nativeBuildInputs
+            ++ final.resolveBuildSystem {
+              editables = [ ];
+            };
+        });
+      })
+    ]
+  );
 
-  propagatedBuildInputs = [
-    pkgs.python3Packages.anyio
-    pkgs.python3Packages.pyxdg
-    perSystem.golem-base-sdk.golem-base-sdk
-  ];
+  virtualenv = editablePythonSet.mkVirtualEnv "golem-base-sdk-example-env" workspace.deps.default;
+  virtualenvDev = editablePythonSet.mkVirtualEnv "golem-base-sdk-example-env" workspace.deps.all;
+in
 
-  nativeCheckInputs = [
-    pkgs.mypy
-    pkgs.pylint
-    pkgs.ruff
-  ];
+mkApplication {
+  venv = virtualenv;
+  package = pythonSet.golem-base-sdk-example.overrideAttrs (prevAttrs: {
+    nativeCheckInputs = [
+      pkgs.mypy
+      pkgs.ruff
+    ];
 
-  checkPhase = ''
-    mypy golem_base_sdk_example
-    ruff check --no-cache golem_base_sdk_example
-  '';
+    doCheck = true;
 
-  meta = with lib; {
-    homepage = "";
-    description = "";
-    license = licenses.gpl3Only;
-    platforms = platforms.linux ++ platforms.darwin;
-  };
+    checkPhase = ''
+      mypy golem_base_sdk_example
+      ruff check --no-cache golem_base_sdk_example
+    '';
+
+    passthru = (prevAttrs.passthru or { }) // {
+      inherit virtualenv virtualenvDev;
+    };
+  });
 }