Add uv for package manager (#1071)

* Add uv for package management
* Replace Makefile for Python script (Macos support)
* Add uv to documentation.
* Update github actions to use uv

Author: pdelboca

.github/workflows/general.yaml

@@ -21,7 +21,7 @@ jobs:
     - name: Install uv
       uses: astral-sh/setup-uv@v5
       with:
-        version: "0.6.14"
+        version: "0.9.9"
     - name: Set up Python 3.13
       uses: actions/setup-python@v3
       with:
@@ -39,7 +39,7 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v5
         with:
-          version: "0.6.14"
+          version: "0.9.9"
       - name: Set up Python 3.13
         uses: actions/setup-python@v3
         with:
@@ -48,29 +48,30 @@ jobs:
         uses: tlambert03/setup-qt-libs@v1
       - name: Install python requirements
         run: |
-          uv pip install -r requirements.txt
-          uv pip install -r dev-requirements.txt
+          uv sync
       - name: Check pep8
         run: |
-            uvx ruff check
+          uvx ruff check
       - name: Run tests
         run: |
-            pytest
+          uv run pytest
   macos-packaging:
     if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/')
     needs: tests
     runs-on: macos-13
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.9.9"
       - name: Set up Python 3.13
         uses: actions/setup-python@v3
         with:
           python-version: "3.13"
       - name: Install Dependencies
         run: |
-          pip3 install -r requirements.txt
-          pip3 install pyinstaller==6.11.1
+          uv sync
           brew install create-dmg
       - name: Build and notarize the dmg file
         env:
@@ -94,8 +95,11 @@ jobs:
     needs: tests
     runs-on: ubuntu-22.04
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.9.9"
       - name: Set up Python 3.13
         uses: actions/setup-python@v3
         with:
@@ -111,11 +115,9 @@ jobs:
           # Fix PyInstaller warnings of Qt Dependencies missing
           sudo apt-get install synaptic
           sudo apt-get install libxcb-icccm4 libxcb-image0-dev libxcb-keysyms1 libxcb-render-util0 libxcb-xkb1 libxcb-xinerama0 libxkbcommon-x11-0 libxcb-cursor0 libxcb-shape0-dev
-
       - name: Install Dependencies
         run: |
-          pip3 install -r requirements.txt
-          pip3 install pyinstaller==6.11.1
+          uv sync
       - name: Build the deb package
         run: |
           chmod +x create-deb.sh
@@ -132,24 +134,26 @@ jobs:
     needs: tests
     runs-on: windows-2022
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.9.9"
       - name: Set up Python 3.13
         uses: actions/setup-python@v3
         with:
           python-version: "3.13"
       - name: Install Dependencies
         run: |
-          pip3 install -r requirements.txt
-          pip3 install pyinstaller==6.11.1
+          uv sync
       - name: Install NSIS
         run: choco install nsis
       - name: Build with PyInstaller
-        run: python build.py
+        run: uv run build.py build
       - name: Compile installer
         shell: bash  # Force bash shell for VERSION command
         run: |
-          VERSION=$(python -c "import ode; print(ode.__version__)")
+          VERSION=$(uv run python -c "import ode; print(ode.__version__)")
           makensis -DAPP_VERSION="$VERSION" ./packaging/windows/installer.nsi
       - name: Upload artifact
         uses: actions/upload-artifact@v4
@@ -163,8 +167,11 @@ jobs:
     needs: tests
     runs-on: ubuntu-22.04
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.9.9"
       - name: Set up Python 3.13
         uses: actions/setup-python@v3
         with:
@@ -178,12 +185,11 @@ jobs:
           sudo apt-get install libxcb-icccm4 libxcb-image0-dev libxcb-keysyms1 libxcb-render-util0 libxcb-xkb1 libxcb-xinerama0 libxkbcommon-x11-0
       - name: Install Dependencies
         run: |
-          pip3 install -r requirements.txt
-          pip3 install pyinstaller==6.11.1
+          uv sync
       - name: Build the deb package
         run: |
           VERSION=$(python -c "import ode; print(ode.__version__)")
-          python build.py --onefile --name "opendataeditor-$VERSION.AppImage"
+          uv run build.py --onefile --name "opendataeditor-$VERSION.AppImage"
       - name: Archive build artifacts
         uses: actions/upload-artifact@v4
         with:

.python-version

@@ -0,0 +1 @@
+3.13

Makefile

@@ -19,24 +19,25 @@ The Open Data Editor (ODE) is a **no-code application** to **explore, validate a
 
 
 # Useful links
-
-🔵 [Open Data Editor Concept Note](https://opendataeditor.okfn.org/ode-concept-note.pdf)
+🔵 [Development guide](https://opendataeditor.okfn.org/contributing/development/)
 
 🔵 [Open Data Editor User Guide and Project Documentation](https://opendataeditor.okfn.org/)
 
 🔵 [Frictionless Framework](https://framework.frictionlessdata.io/)
 
 🔵 [Frictionless Data](https://frictionlessdata.io/)
 
-🔵 [Contributing Guide](https://opendataeditor.okfn.org/contributing/development/)
+🔵 [Contributing Guidelines](https://opendataeditor.okfn.org/contributing/contribution-guidelines)
 
-🔵 [Technical Architecture](https://opendataeditor.okfn.org/contributing/architecture/)
+🔵 [Open Data Editor Concept Note](https://opendataeditor.okfn.org/ode-concept-note.pdf)
 
 🔵 For all contributions: [Code of conduct](https://frictionlessdata.io/code-of-conduct/)
 
 # How to download the ODE
 
-Go to the latest [RELEASE](https://github.com/okfn/opendataeditor/releases/latest)
+You can download the latest version from the [ODE website](https://okfn.org/en/projects/open-data-editor/)
+
+For previous releases, you can download them from Github [RELEASE](https://github.com/okfn/opendataeditor/releases)
 * For **Windows**:Download the most recent **EXE** file.
 * For **MacOS**:Download the most recent **DMG** file.
 * For **Linux**:Download the most recent **AppImage** or **DEB** file.

README.md

@@ -1,30 +1,67 @@
-import PyInstaller.__main__
 import os
 import platform
+import PyInstaller.__main__
+import subprocess
 import sys
 
+
+def run(cmd: list[str], cwd: str = "."):
+    """Run a subprocess command."""
+    subprocess.run(cmd, check=True, cwd=cwd)
+
+
+def docs():
+    """Build the documentation and run a local server."""
+    run(["make", "html"], cwd="docs")
+    run(["python", "-m", "http.server", "-d", "build/html"], cwd="docs")
+
+
+def update_translations():
+    """Generate/update .ts files from the source code."""
+    run(["pyside6-lupdate", "-extensions", "py", "-recursive", "ode", "-ts", "ode/assets/translations/de.ts", "-target-language", "de_DE"])
+    run(["pyside6-lupdate", "-extensions", "py", "-recursive", "ode", "-ts", "ode/assets/translations/es.ts", "-target-language", "es_ES"])
+    run(["pyside6-lupdate", "-extensions", "py", "-recursive", "ode", "-ts", "ode/assets/translations/fr.ts", "-target-language", "fr_FR"])
+    run(["pyside6-lupdate", "-extensions", "py", "-recursive", "ode", "-ts", "ode/assets/translations/pt.ts", "-target-language", "pt_PT"])
+    run(["pyside6-lupdate", "-extensions", "py", "-recursive", "ode", "-ts", "ode/assets/translations/it.ts", "-target-language", "it_IT"])
+
+
+def compile_translations():
+    """Compile .ts to .qm files."""
+    run(["pyside6-lrelease", "ode/assets/translations/de.ts", "-qm", "ode/assets/translations/de.qm"])
+    run(["pyside6-lrelease", "ode/assets/translations/es.ts", "-qm", "ode/assets/translations/es.qm"])
+    run(["pyside6-lrelease", "ode/assets/translations/fr.ts", "-qm", "ode/assets/translations/fr.qm"])
+    run(["pyside6-lrelease", "ode/assets/translations/pt.ts", "-qm", "ode/assets/translations/pt.qm"])
+    run(["pyside6-lrelease", "ode/assets/translations/it.ts", "-qm", "ode/assets/translations/it.qm"])
+
+
 def build_application():
     """Build an executable file for the Application."""
     system = platform.system()
+
+    # Linux Defaults
+    icon_path = "packaging/linux/icon.svg"
+    app_name = "opendataeditor"
+
     if system == "Darwin":  # macOS
         icon_path = "packaging/macos/icon.icns"
         app_name = "OpenDataEditor"
     elif system == "Windows":
         icon_path = "packaging/windows/icon.ico"
         app_name = "opendataeditor"
-    elif system == "Linux":
-        icon_path = "packaging/linux/icon.svg"
-        app_name = "opendataeditor"
 
     print("Creating executable file for Open Data Editor")
 
     params = [
         "ode/main.py",
         "--windowed",  # Required for Windows install to not open a console.
-        "--collect-all", "frictionless",  # Frictionless depends on data files
-        "--collect-all", "ode",  # Collect all assets from Open Data Editor
-        "--collect-all", "llama_cpp",  # Collect all assets from llama_cpp
-        "--collect-all", "numpy",  # Collect all assets from numpy (llama_cpp dependency)
+        "--collect-all",
+        "frictionless",  # Frictionless depends on data files
+        "--collect-all",
+        "ode",  # Collect all assets from Open Data Editor
+        "--collect-all",
+        "llama_cpp",  # Collect all assets from llama_cpp
+        "--collect-all",
+        "numpy",  # Collect all assets from numpy (llama_cpp dependency)
         "--log-level",
         "WARN",
         "--name",
@@ -43,16 +80,36 @@ def build_application():
         # is installed which might not be the case for all of our users.
         params.extend(["--add-binary", "C:\\Windows\\system32\\vcomp140.dll:."])
 
-    cli_args =  sys.argv[1:]
-    if cli_args:
-        params.extend(cli_args)
-
     PyInstaller.__main__.run(params)
 
     # Clean the spec file generated by PyInstaller
     if os.path.exists(f"{app_name}.spec"):
         os.remove(f"{app_name}.spec")
 
 
+def main():
+    if len(sys.argv) < 2:
+        print("Usage:")
+        print("  python build.py update-translations")
+        print("  python build.py compile-translations")
+        print("  python build.py build")
+        print("  python build.py docs")
+        sys.exit(1)
+
+    command = sys.argv[1].lower()
+
+    if command == "update-translations":
+        update_translations()
+    elif command == "compile-translations":
+        compile_translations()
+    elif command == "build":
+        build_application()
+    elif command == "docs":
+        docs()
+    else:
+        print(f"Unknown command: {command}")
+        sys.exit(1)
+
+
 if __name__ == "__main__":
-    build_application()
+    main()

build.py

@@ -22,7 +22,7 @@ mkdir -p tmp/usr/share/icons/hicolor/scalable/apps
 # Build the project
 [ -e build ] && rm -r build
 [ -e dist ] && rm -r dist
-python build.py
+uv run build.py build
 
 # Copy files
 cp -r dist/opendataeditor tmp/opt/opendataeditor
@@ -39,7 +39,7 @@ find tmp/usr/share -type f -exec chmod 644 -- {} +
 chmod +x tmp/opt/opendataeditor/opendataeditor
 
 # Create the deb package
-VERSION=$(python -c "import ode; print(ode.__version__)")
+VERSION=$(uv run python -c "import ode; print(ode.__version__)")
 FILENAME=opendataeditor-linux-$VERSION.deb
 [ -e dist/$FILENAME ] && rm dist/$FILENAME
 fpm -C tmp -s dir -t deb -n "opendataeditor" -v $VERSION  -p dist/$FILENAME