fix: include dependencies in site-packages - issue #169 (#170)

AngRodrigues · rabii-chaarani · commit 4441eafbeab8 · 2025-01-20T14:09:55.000+09:30
* added custom builds to conda and pip to include dependencies.txt file
* DependencyChecker class now working as expected
diff --git a/.github/workflows/conda.yml b/.github/workflows/conda.yml
@@ -11,7 +11,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ${{ fromJSON(vars.BUILD_OS)}}
-        python-version: ${{ fromJSON(vars.PYTHON_VERSIONS)}}
+        python-version: ${{ fromJSON(vars.PYTHON_VERSIONS) }}
     steps:
       - uses: conda-incubator/setup-miniconda@v3
         with:
@@ -27,10 +27,14 @@ jobs:
           ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_TOKEN  }}
         shell: bash -l {0}
         run: |
+          conda config --env --add channels conda-forge 
+          conda config --env --add channels loop3d
+          conda config --env --set channel_priority strict
           conda install -c conda-forge conda-build scikit-build-core numpy anaconda-client conda-libmamba-solver -y
-          conda build -c conda-forge -c loop3d --output-folder conda conda  --python ${{matrix.python-version}}
+          conda config --set solver libmamba
+          conda build --output-folder conda conda  --python ${{matrix.python-version}}
           anaconda upload --label main conda/*/*.tar.bz2
-
+          
       - name: upload artifacts
         uses: actions/upload-artifact@v4
         with:
diff --git a/.github/workflows/linting_and_testing.yml b/.github/workflows/linting_and_testing.yml
@@ -18,7 +18,8 @@ jobs:
       - uses: stefanzweifel/git-auto-commit-action@v5
         with:
           commit_message: "style: style fixes by ruff and autoformatting by black"
-
+ 
+          
   testing:
     name: Testing
     runs-on: ubuntu-24.04
diff --git a/.github/workflows/pypi.yml b/.github/workflows/pypi.yml
@@ -6,7 +6,7 @@ jobs:
 
   sdist:
     name: Build sdist
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
@@ -23,7 +23,7 @@ jobs:
 
   publish:
     name: Publish wheels to pypi
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
     permissions:
       # IMPORTANT: this permission is mandatory for trusted publishing
       id-token: write
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,8 +1,3 @@
-include LICENSE
-include README.md 
-
 include map2loop/_datasets/clut_files/*.csv
 include map2loop/_datasets/config_files/*.json
-include map2loop/_datasets/geodata_files/hamersley/*
-
-recursive-include tests *.py
+include map2loop/_datasets/geodata_files/hamersley/*
diff --git a/conda/bld.bat b/conda/bld.bat
@@ -0,0 +1,5 @@
+mkdir %SP_DIR%\map2loop
+copy %RECIPE_DIR%\..\LICENSE %SP_DIR%\map2loop\
+copy %RECIPE_DIR%\..\README.md %SP_DIR%\map2loop\
+copy %RECIPE_DIR%\..\dependencies.txt %SP_DIR%\map2loop\
+%PYTHON% -m pip install . --no-deps
diff --git a/conda/build.sh b/conda/build.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+mkdir -p $SP_DIR/map2loop
+cp $RECIPE_DIR/../dependencies.txt $SP_DIR/map2loop/
+cp $RECIPE_DIR/../LICENSE $SP_DIR/map2loop/
+cp $RECIPE_DIR/../README.md $SP_DIR/map2loop/
+$PYTHON -m pip install . --no-deps
diff --git a/conda/conda-build.py b/conda/conda-build.py
diff --git a/conda/conda_build_config.yaml b/conda/conda_build_config.yaml
diff --git a/conda/meta.yaml b/conda/meta.yaml
@@ -20,17 +20,16 @@ requirements:
   run:
     - loopprojectfile ==0.2.2
     - gdal
-    - map2model
-    - beartype
-    - python
     - numpy
-    - pandas
+    - scipy
     - geopandas
     - shapely
-    - tqdm
     - networkx
     - owslib
-
+    - map2model
+    - beartype
+    - pytest
+    - scikit-learn
 
 about:
   home: "https://github.com/Loop3D/map2loop"
diff --git a/dependencies.txt b/dependencies.txt
@@ -1,4 +1,3 @@
-
 numpy
 scipy
 geopandas
diff --git a/map2loop/__init__.py b/map2loop/__init__.py
@@ -30,7 +30,7 @@ class DependencyChecker:
 
     def __init__(self, package_name, dependency_file="dependencies.txt"):
         self.package_name = package_name
-        self.dependency_file = pathlib.Path(__file__).parent.parent / dependency_file
+        self.dependency_file = pathlib.Path(__file__).parent / dependency_file
         self.required_version = self.get_required_version()
         self.installed_version = self.get_installed_version()
 
@@ -93,7 +93,7 @@ def check_version(self):
 
 
 def check_all_dependencies(dependency_file="dependencies.txt"):
-    dependencies_path = pathlib.Path(__file__).parent.parent / dependency_file
+    dependencies_path = pathlib.Path(__file__).parent / dependency_file
     try:
         with dependencies_path.open("r") as file:
             for line in file:
@@ -108,6 +108,7 @@ def check_all_dependencies(dependency_file="dependencies.txt"):
 
                     checker = DependencyChecker(package_name, dependency_file=dependency_file)
                     checker.check_version()
+                    
     except FileNotFoundError:
         warnings.warn(
             f"{dependency_file} not found. No dependencies checked for map2loop.",
diff --git a/pyproject.toml b/pyproject.toml
@@ -38,7 +38,11 @@ version = { attr = "map2loop.version.__version__" }
 [tool.setuptools.packages.find]
 include = ['map2loop', 'map2loop.*']
 
-
+[tool.setuptools.package-data]
+map2loop = [
+    "dependencies.txt",
+    "_datasets/geodata_files/hamersley/*"
+]
 
 [tool.black]
 line-length = 100
diff --git a/setup.py b/setup.py
@@ -1,28 +1,49 @@
-"""See pyproject.toml for project metadata."""
+from setuptools.command.sdist import sdist as _sdist
+import shutil
+from setuptools import setup, find_packages
+from pathlib import Path
 
-import os
-from setuptools import setup
-
-package_root = os.path.abspath(os.path.dirname(__file__))
+# Resolve the absolute path to the directory containing this file:
+package_root = Path(__file__).resolve().parent
 
 # Get the version from the version.py file
 version = {}
-with open(os.path.join(package_root, "map2loop/version.py")) as fp:
+version_file = package_root / "map2loop" / "version.py"
+with version_file.open() as fp:
     exec(fp.read(), version)
-version = version["__version__"]
 
 # Read dependencies from dependencies.txt
-requirements_file = os.path.join(package_root, "dependencies.txt")
-with open(requirements_file, 'r') as f:
+requirements_file = package_root / "dependencies.txt"
+with requirements_file.open("r") as f:
     install_requires = [line.strip() for line in f if line.strip()]
 
+
+class CustomSDist(_sdist):
+
+    def make_release_tree(self, base_dir, files):
+        # 1) Let the normal sdist process run first.
+        super().make_release_tree(base_dir, files)
+        map2loop_dir = Path(base_dir) / "map2loop"
+
+        # 2) Specify which files to move from the root to map2loop/.
+        top_level_files = ["dependencies.txt", "LICENSE", "README.md"]
+
+        for filename in top_level_files:
+            src = Path(base_dir) / filename
+            dst = map2loop_dir / filename
+
+            # If the source file exists in base_dir, move it to map2loop/.
+            if src.exists():
+                shutil.copy(str(src), str(dst))
+
 setup(
     name="map2loop",
-    install_requires=install_requires,
-    version=version,
+    install_requires=install_requires,        
+    packages=find_packages(exclude=["tests", "tests.*"]),
+    package_data={"": ['dependencies.txt']},
+    include_package_data=True,
     license="MIT",
-    package_data={
-        # Include test files:
-        '': ['tests/*.py'],
+    cmdclass={
+        "sdist": CustomSDist,
     },
-)
+)

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`numpy`
`3`	`2`	`scipy`
`4`	`3`	`geopandas`