Improvements to support Windows (#21)

* chore: Added Windows tests -- do they run?
chore: Corrected code to support Windows.

* fix: Attempting to correct the Windows runner workflow.

* fix: Correcting Windows path separator for selecting tests.

* fix: Further correcting pytest path separator for Windows.

* fix: Added the `pywin32` package if platform is Windows.

* fix: Using ~ to obtain the user home path on Windows too.

* chore: Upgraded packages.

* chore: Removing `pytest` on Windows because the runner is on Windows server, which is unlikely to be the end-user platform.

* debug: Hugging Face model tag extraction has a problem: #20 (comment)

* fix: Partly correcting the Windows related problems in #20

* copilot: Removing unnecessary commented out code.

Co-authored-by: Copilot <[email protected]>
Signed-off-by: Anirban Basu <[email protected]>

* copilot: Simplifying windows platform condition for package.

Co-authored-by: Copilot <[email protected]>
Signed-off-by: Anirban Basu <[email protected]>

* fix: Correcting half-right CoPilot edits for removing unnecessary commented out code.

---------

Signed-off-by: Anirban Basu <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: anirbanbasu

.github/workflows/uv-pytest.yml

@@ -15,9 +15,8 @@ name: pytest
 
 jobs:
   uv-pytest:
-    name: python
+    name: python-on-nix
     runs-on: ubuntu-latest
-    # runs-on: self-hosted
 
     steps:
       - uses: actions/checkout@v4
@@ -32,5 +31,4 @@ jobs:
         run: uv sync --all-groups
 
       - name: Run tests using pytest
-      # Disable model_download tests on non self-hosted runners for now.
         run: uv run --group test pytest -v tests/

pyproject.toml

@@ -38,6 +38,7 @@ dependencies = [
     "ollama>=0.6.0",
     "psutil>=7.0.0",
     "typer>=0.16.0",
+    "pywin32>=311 ; sys_platform == 'win32'",
 ]
 
 [tool.coverage.run]

src/ollama_downloader/__init__.py

@@ -25,7 +25,9 @@ class EnvVar:
 
     OD_UA_NAME_VER = env.str("OD_UA_NAME_VER", default="ollama-downloader/0.1.1")
 
-    OD_SETTINGS_FILE = env.str("OD_SETTINGS_FILE", default="conf/settings.json")
+    OD_SETTINGS_FILE = env.str(
+        "OD_SETTINGS_FILE", default=os.path.join("conf", "settings.json")
+    )
 
 
 logging.basicConfig(

src/ollama_downloader/cli.py

@@ -4,6 +4,7 @@
 import sys
 from types import FrameType
 from typing import Optional
+from httpx import HTTPStatusError
 from typing_extensions import Annotated
 import typer
 from rich import print as print
@@ -329,7 +330,9 @@ async def run_list_models(
             else:
                 print(f"Model identifiers: ({len(result)}): {result}")
         except Exception as e:
-            logger.error(f"Error in listing models. {e}")
+            logger.error(
+                f"Error in listing models. {e}{'\n' + e.response.text if isinstance(e, HTTPStatusError) else ''}"
+            )
         finally:
             self._cleanup()
 
@@ -342,7 +345,9 @@ async def run_list_tags(self, model_identifier: str):
             result = await self._list_tags(model_identifier=model_identifier)
             print(f"Model tags: ({len(result)}): {result}")
         except Exception as e:
-            logger.error(f"Error in listing model tags. {e}")
+            logger.error(
+                f"Error in listing model tags. {e}{'\n' + e.response.text if isinstance(e, HTTPStatusError) else ''}"
+            )
         finally:
             self._cleanup()
 
@@ -354,7 +359,9 @@ async def run_model_download(self, model_tag: str):
             self._initialize()
             await self._model_download(model_tag=model_tag)
         except Exception as e:
-            logger.error(f"Error in downloading model. {e}")
+            logger.error(
+                f"Error in downloading model. {e}{'\n' + e.response.text if isinstance(e, HTTPStatusError) else ''}"
+            )
         finally:
             self._cleanup()
 
@@ -376,7 +383,9 @@ async def run_hf_list_models(
             else:
                 print(f"Model identifiers: ({len(result)}): {result}")
         except Exception as e:
-            logger.error(f"Error in listing models. {e}")
+            logger.error(
+                f"Error in listing models. {e}{'\n' + e.response.text if isinstance(e, HTTPStatusError) else ''}"
+            )
         finally:
             self._cleanup()
 
@@ -391,7 +400,9 @@ async def run_hf_list_tags(self, model_identifier: str):
             result = await self._hf_list_tags(model_identifier=model_identifier)
             print(f"Model tags: ({len(result)}): {result}")
         except Exception as e:
-            logger.error(f"Error in listing model tags. {e}")
+            logger.error(
+                f"Error in listing model tags. {e}{'\n' + e.response.text if isinstance(e, HTTPStatusError) else ''}"
+            )
         finally:
             self._cleanup()
 
@@ -403,7 +414,9 @@ async def run_hf_model_download(self, user_repo_quant: str):
             self._initialize()
             await self._hf_model_download(user_repo_quant=user_repo_quant)
         except Exception as e:
-            logger.error(f"Error in downloading Hugging Face model. {e}")
+            logger.error(
+                f"Error in downloading Hugging Face model. {e}{'\n' + e.response.text if isinstance(e, HTTPStatusError) else ''}"
+            )
         finally:
             self._cleanup()
 

src/ollama_downloader/data/data_models.py

@@ -45,7 +45,12 @@ class OllamaLibrary(BaseModel):
     models_path: Annotated[
         str, AfterValidator(CustomValidators.validate_path_as_dir)
     ] = Field(
-        default="~/.ollama/models",
+        # Windows environment variables: https://learn.microsoft.com/en-us/windows/deployment/usmt/usmt-recognized-environment-variables
+        default=os.path.join(
+            "~",
+            ".ollama",
+            "models",
+        ),
         description="Path to the Ollama models on the filesystem. This should be a directory where model BLOBs and manifest metadata are stored.",
     )
     registry_base_url: Annotated[str, AfterValidator(CustomValidators.validate_url)] = (

src/ollama_downloader/downloader/hf_model_downloader.py

@@ -21,19 +21,12 @@
 class HuggingFaceModelDownloader(ModelDownloader):
     def __init__(self):
         super().__init__()
-        # if not self.settings.ollama_library.verify_ssl:
-        #     logger.warning(
-        #         "Disabling SSL verification for HTTP requests. This is not recommended for production use."
-        #     )
-        #     session = requests.Session()
-        #     session.verify = False
-        #     configure_http_backend(backend_factory=lambda: session)
 
     def download_model(self, model_identifier: str) -> bool:
         # Validate the response as an ImageManifest but don't enforce strict validation
         (user, model_repo), quant = (
             model_identifier.split(":")[0].split("/"),
-            model_identifier.split(":")[1],
+            model_identifier.split(":")[1] if ":" in model_identifier else "latest",
         )
         print(
             f"Downloading Hugging Face model {model_repo} from {user} with {quant} quantisation"

src/ollama_downloader/downloader/model_downloader.py

@@ -139,22 +139,25 @@ def _make_manifest_url(
         Returns:
             httpx.URL: The constructed manifest URL.
         """
+        model, tag = (
+            model_identifier.split(":")
+            if ":" in model_identifier
+            else (model_identifier, "latest")
+        )
         match model_source:
             case ModelSource.OLLAMA:
-                model, tag = (
-                    model_identifier.split(":")
-                    if ":" in model_identifier
-                    else (model_identifier, "latest")
-                )
                 logger.debug(f"Constructing manifest URL for {model}:{tag}")
                 return httpx.URL(self.settings.ollama_library.registry_base_url).join(
                     f"{model}/manifests/{tag}"
                 )
             case ModelSource.HUGGINGFACE:
                 logger.debug(f"Constructing manifest URL for {model_identifier}")
-                return httpx.URL(
-                    f"{ModelDownloader.HF_BASE_URL}{model_identifier.replace(':', '/manifests/')}"
+                hf_model_identifier = (
+                    model_identifier.replace(":", "/manifests/")
+                    if ":" in model_identifier
+                    else f"{model_identifier}/manifests/{tag}"
                 )
+                return httpx.URL(f"{ModelDownloader.HF_BASE_URL}{hf_model_identifier}")
             case _:
                 raise ValueError(f"Unsupported model source: {model_source}")
 

src/ollama_downloader/sysinfo.py

@@ -1,11 +1,16 @@
-import grp
 import logging
 import os
 import re
 from typing import ClassVar
 import platform
 import psutil
 
+try:
+    import grp  # Unix, macOS and Linux only
+except ImportError:
+    # Windows does not have the grp module
+    grp = None  # type: ignore[assignment]
+
 from ollama import Client as OllamaClient
 
 logger = logging.getLogger(__name__)
@@ -118,7 +123,9 @@ def get_process_owner(self) -> tuple[str, int, str, int] | None:
                 username = proc.username()
                 uid = proc.uids().real if hasattr(proc, "uids") else -1
                 gid = proc.gids().real if hasattr(proc, "gids") else -1
-                groupname = grp.getgrgid(gid).gr_name if gid != -1 else ""
+                groupname = (
+                    grp.getgrgid(gid).gr_name if grp is not None and gid != -1 else ""
+                )
                 self.process_owner = (username, uid, groupname, gid)
                 logger.debug(
                     f"Owner of process {proc.name()} ({self.process_id}, {proc.status()}): {self.process_owner}"

tests_on_windows.txt

@@ -0,0 +1,9 @@
+tests/test_data_models.py
+tests/test_typer.py::TestTyperCalls::test_version
+tests/test_typer.py::TestTyperCalls::test_show_config
+tests/test_typer.py::TestTyperCalls::test_list_models
+tests/test_typer.py::TestTyperCalls::test_list_tags
+tests/test_typer.py::TestTyperCalls::test_model_download
+tests/test_typer.py::TestTyperCalls::test_hf_list_models
+tests/test_typer.py::TestTyperCalls::test_hf_list_tags
+tests/test_typer.py::TestTyperCalls::test_hf_model_download