Modernize project structure (#1074)

* Improve the project structure.
* Handle application version with the project.toml file
* Update build pipeline
* Update development documentation.
* Update packaging code to get version from pyproject.toml file.

Author: pdelboca

.github/workflows/general.yaml

@@ -153,7 +153,7 @@ jobs:
       - name: Compile installer
         shell: bash  # Force bash shell for VERSION command
         run: |
-          VERSION=$(uv run python -c "import ode; print(ode.__version__)")
+          VERSION=$(uv run python -c "from importlib.metadata import version; print(version('opendataeditor'))")
           makensis -DAPP_VERSION="$VERSION" ./packaging/windows/installer.nsi
       - name: Upload artifact
         uses: actions/upload-artifact@v4
@@ -188,7 +188,7 @@ jobs:
           uv sync
       - name: Build the deb package
         run: |
-          VERSION=$(uv run python -c "import ode; print(ode.__version__)")
+          VERSION=$(uv run python -c "from importlib.metadata import version; print(version('opendataeditor'))")
           uv run build.py build --onefile --name "opendataeditor-$VERSION.AppImage"
       - name: Archive build artifacts
         uses: actions/upload-artifact@v4

build.py

@@ -52,7 +52,7 @@ def build_application():
     print("Creating executable file for Open Data Editor")
 
     params = [
-        "ode/main.py",
+        "src/ode/main.py",
         "--windowed",  # Required for Windows install to not open a console.
         "--collect-all",
         "frictionless",  # Frictionless depends on data files

create-deb.sh

@@ -39,7 +39,7 @@ find tmp/usr/share -type f -exec chmod 644 -- {} +
 chmod +x tmp/opt/opendataeditor/opendataeditor
 
 # Create the deb package
-VERSION=$(uv run python -c "import ode; print(ode.__version__)")
+VERSION=$(uv run python -c "from importlib.metadata import version; print(version('opendataeditor'))")
 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

create-dmg.sh

@@ -72,7 +72,7 @@ sleep 5
 rm -f *.dmg
 
 # Create the dmg file
-VERSION=$(uv run python -c "import ode; print(ode.__version__)")
+VERSION=$(uv run python -c "from importlib.metadata import version; print(version('opendataeditor'))")
 FILENAME=opendataeditor-macos-$VERSION.dmg
 [ -e $FILENAME ] && rm $FILENAME
 

docs/source/contributing/development.md

@@ -14,6 +14,16 @@ dependencies = [
     "xlwt>=1.3.0",
 ]
 
+[project.scripts]
+ode = "ode.main:main"
+
+[build-system]
+requires = ["uv_build>=0.9.10,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "ode"
+
 [tool.ruff]
 line-length = 140