moducomp 0.7.18__py3-none-any.whl → 0.7.23__py3-none-any.whl

moducomp/__init__.py

@@ -2,7 +2,7 @@
 moducomp: metabolic module completeness and complementarity for microbiomes.
 """
 
-__version__ = "0.7.18"
+__version__ = "0.7.23"
 __author__ = "Juan C. Villada"
 __email__ = "jvillada@lbl.gov"
 __title__ = "moducomp"

moducomp/moducomp.py

@@ -418,18 +418,208 @@ def _set_configured_eggnog_dir(path: Path, logger: Optional[logging.Logger] = No
     _save_config(data, logger)
 
 
-def _find_eggnog_downloader() -> Optional[str]:
-    for name in ("download_eggnog_data.py", "download_eggnog_data"):
-        path = shutil.which(name)
+def _get_eggnog_db_version(logger: Optional[logging.Logger] = None) -> str:
+    try:
+        from eggnogmapper.version import __DB_VERSION__
+    except Exception as exc:
+        if logger:
+            logger.error("eggNOG-mapper is required for setup: %s", exc)
+        raise typer.Exit(1)
+    if not __DB_VERSION__:
+        if logger:
+            logger.error("eggNOG-mapper did not report a database version.")
+        raise typer.Exit(1)
+    return __DB_VERSION__
+
+
+def _select_download_tool() -> Tuple[str, str]:
+    for tool in ("aria2c", "wget", "curl"):
+        path = shutil.which(tool)
         if path:
-            try:
-                wrapper_text = Path(path).read_text(encoding="utf-8", errors="ignore")
-            except OSError:
-                wrapper_text = ""
-            if "moducomp.moducomp" in wrapper_text:
+            return tool, path
+    raise FileNotFoundError("No download tool found (aria2c, wget, or curl).")
+
+
+def _run_download_cmd(
+    cmd: List[str],
+    logger: Optional[logging.Logger] = None,
+    verbose: bool = True,
+    description: str = "Command",
+) -> None:
+    if logger:
+        logger.info("%s: %s", description, " ".join(shlex.quote(arg) for arg in cmd))
+    try:
+        if verbose:
+            subprocess.run(cmd, check=True)
+        else:
+            subprocess.run(cmd, check=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
+    except subprocess.CalledProcessError as exc:
+        if logger:
+            logger.error("Download command failed with exit code %s.", exc.returncode)
+        raise typer.Exit(exc.returncode)
+
+
+def _download_file(
+    url: str,
+    dest: Path,
+    logger: Optional[logging.Logger] = None,
+    verbose: bool = True,
+) -> None:
+    try:
+        tool, tool_path = _select_download_tool()
+    except FileNotFoundError as exc:
+        if logger:
+            logger.error("%s", exc)
+        raise typer.Exit(1)
+    dest.parent.mkdir(parents=True, exist_ok=True)
+
+    if tool == "aria2c":
+        cmd = [
+            tool_path,
+            "--console-log-level=warn",
+            "--dir",
+            str(dest.parent),
+            "--out",
+            dest.name,
+            "--allow-overwrite=true",
+            "--auto-file-renaming=false",
+            "--continue=true",
+            "--file-allocation=none",
+            "--max-tries=0",
+            "--retry-wait=30",
+            "--timeout=60",
+            "--summary-interval=60",
+            "-x",
+            "8",
+            "-s",
+            "8",
+            "-k",
+            "1M",
+            url,
+        ]
+        if not verbose:
+            cmd.insert(1, "--quiet")
+    elif tool == "wget":
+        cmd = [
+            tool_path,
+            "--continue",
+            "--tries=0",
+            "--retry-connrefused",
+            "--waitretry=30",
+            "--read-timeout=30",
+            "--timeout=30",
+            "--progress=dot:giga",
+            "-O",
+            str(dest),
+            url,
+        ]
+        if not verbose:
+            cmd.insert(1, "--quiet")
+    else:
+        cmd = [
+            tool_path,
+            "--location",
+            "--continue-at",
+            "-",
+            "--retry",
+            "9999",
+            "--retry-delay",
+            "30",
+            "--retry-all-errors",
+            "--connect-timeout",
+            "30",
+            "--max-time",
+            "0",
+            "-o",
+            str(dest),
+            url,
+        ]
+        if not verbose:
+            cmd.insert(1, "--silent")
+            cmd.insert(2, "--show-error")
+
+    _run_download_cmd(cmd, logger=logger, verbose=verbose, description="Download command")
+
+
+def _extract_archive(
+    archive_path: Path,
+    target_dir: Path,
+    mode: str,
+    logger: Optional[logging.Logger] = None,
+    verbose: bool = True,
+) -> None:
+    if mode == "gunzip":
+        cmd = ["gunzip", "-f", str(archive_path)]
+        _run_download_cmd(cmd, logger=logger, verbose=verbose, description="Decompression command")
+        return
+
+    if mode == "tar":
+        cmd = ["tar", "-zxf", str(archive_path), "-C", str(target_dir)]
+        _run_download_cmd(cmd, logger=logger, verbose=verbose, description="Extraction command")
+        try:
+            archive_path.unlink()
+        except OSError:
+            if logger:
+                logger.warning("Could not remove archive %s after extraction.", archive_path)
+        return
+
+    if logger:
+        logger.error("Unknown archive extraction mode: %s", mode)
+    raise typer.Exit(1)
+
+
+def _download_eggnog_core_data(
+    target_dir: Path,
+    force: bool,
+    yes: bool,
+    logger: Optional[logging.Logger] = None,
+    verbose: bool = True,
+) -> None:
+    db_version = _get_eggnog_db_version(logger)
+    base_url = f"http://eggnog5.embl.de/download/emapperdb-{db_version}"
+    downloads = [
+        ("eggnog.db.gz", "eggnog.db", "gunzip"),
+        ("eggnog.taxa.tar.gz", "eggnog.taxa.db", "tar"),
+        ("eggnog_proteins.dmnd.gz", "eggnog_proteins.dmnd", "gunzip"),
+    ]
+
+    for archive_name, output_name, mode in downloads:
+        archive_path = target_dir / archive_name
+        output_path = target_dir / output_name
+
+        if force:
+            for path in (archive_path, output_path):
+                if path.exists():
+                    try:
+                        path.unlink()
+                    except OSError:
+                        if logger:
+                            logger.warning("Failed to remove %s before re-download.", path)
+
+        if output_path.exists():
+            if logger:
+                logger.info("eggNOG data file already present: %s", output_path)
+            continue
+
+        if not yes:
+            prompt = f"Download {archive_name} to {target_dir}?"
+            if not typer.confirm(prompt):
+                if logger:
+                    logger.warning("Skipped download of %s by user choice.", archive_name)
                 continue
-            return path
-    return None
+
+        url = f"{base_url}/{archive_name}"
+        if not archive_path.exists():
+            if logger:
+                logger.info("Downloading %s from %s", archive_name, url)
+            _download_file(url, archive_path, logger=logger, verbose=verbose)
+
+        _extract_archive(archive_path, target_dir, mode, logger=logger, verbose=verbose)
+
+        if not output_path.exists():
+            if logger:
+                logger.error("Expected eggNOG file missing after extraction: %s", output_path)
+            raise typer.Exit(1)
 
 def run_subprocess_with_logging(
     cmd: List[str],
@@ -3847,7 +4037,7 @@ def setup(
         help="Stream downloader output to the console.",
     ),
 ) -> None:
-    """Download eggNOG-mapper data (via download_eggnog_data.py) and persist the location for future runs."""
+    """Download eggNOG-mapper core data and persist the location for future runs."""
     target_dir = Path(eggnog_data_dir).expanduser().resolve() if eggnog_data_dir else default_eggnog_data_dir()
     target_dir = target_dir.expanduser().resolve()
 
@@ -3863,29 +4053,8 @@ def setup(
     if _has_eggnog_core_files(target_dir) and not force:
         logger.info("eggNOG data already present; skipping download.")
     else:
-        downloader = _find_eggnog_downloader()
-        if downloader is None:
-            message = (
-                "download_eggnog_data.py not found in PATH. "
-                "Ensure eggnog-mapper is installed."
-            )
-            emit_error(message, logger)
-            raise typer.Exit(1)
-
-        cmd = [downloader, "--data_dir", str(target_dir)]
-        if yes:
-            cmd.append("-y")
-        if force:
-            cmd.append("-f")
-        if not verbose:
-            cmd.append("-q")
-
-        logger.info("Running eggNOG-mapper downloader: %s", " ".join(shlex.quote(arg) for arg in cmd))
-        try:
-            subprocess.run(cmd, check=True)
-        except subprocess.CalledProcessError as exc:
-            emit_error(f"eggNOG-mapper downloader failed with exit code {exc.returncode}", logger)
-            raise typer.Exit(exc.returncode)
+        logger.info("Downloading eggNOG-mapper core databases.")
+        _download_eggnog_core_data(target_dir, force, yes, logger=logger, verbose=verbose)
 
     if not _has_eggnog_core_files(target_dir):
         emit_error(

{moducomp-0.7.18.dist-info → moducomp-0.7.23.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: moducomp
-Version: 0.7.18
+Version: 0.7.23
 Summary: moducomp: metabolic module completeness and complementarity for microbiomes.
 Keywords: bioinformatics,microbiome,metabolic,kegg,genomics
 Author-email: "Juan C. Villada" <jvillada@lbl.gov>
@@ -60,7 +60,7 @@ pixi global install \
 
 ## Setup data (required)
 
-`moducomp` needs the eggNOG-mapper database to run. Use `moducomp setup` to download the data with eggNOG-mapper's official downloader and record the location for future runs. For upstream details, see the eggNOG-mapper setup guide: [eggNOG-mapper database setup](https://github.com/eggnogdb/eggnog-mapper/wiki/eggNOG-mapper-v2.1.5-to-v2.1.13#user-content-Setup).
+`moducomp` needs the eggNOG-mapper database to run. Use `moducomp setup` to download the data using ModuComp's built-in downloader (with resume/retry) and record the location for future runs. For upstream details, see the eggNOG-mapper setup guide: [eggNOG-mapper database setup](https://github.com/eggnogdb/eggnog-mapper/wiki/eggNOG-mapper-v2.1.5-to-v2.1.13#user-content-Setup).
 
 ```bash
 moducomp setup
@@ -386,3 +386,9 @@ Genome identifiers are stored as `taxon_oid`. In pipeline mode, ModuComp expects
 ## Citation
 Villada, JC. & Schulz, F. (2025). Assessment of metabolic module completeness of genomes and metabolic complementarity in microbiomes with `moducomp` . `moducomp` (v0.5.1) Zenodo. https://doi.org/10.5281/zenodo.16116092
 
+## Tool Citations
+If you use ModuComp in a study, please also cite the wrapped tools and data sources:
+
+- eggNOG-mapper: Cantalapiedra CP et al. (2021). “eggNOG-mapper v2: Functional Annotation, Orthology Assignments, and Domain Prediction at the Metagenomic Scale.” Molecular Biology and Evolution. DOI: 10.1093/molbev/msab293. GitHub: https://github.com/eggnogdb/eggnog-mapper
+- KEGG Pathways Completeness Tool (KPCT): GitHub: https://github.com/EBI-Metagenomics/kegg-pathways-completeness-tool. KEGG source: Kanehisa M, Goto S. (2000). “KEGG: Kyoto Encyclopedia of Genes and Genomes.” Nucleic Acids Research. DOI: 10.1093/nar/28.1.27
+

{moducomp-0.7.18.dist-info → moducomp-0.7.23.dist-info}/RECORD

@@ -1,11 +1,11 @@
-moducomp/__init__.py,sha256=QckhvOCk6fBvyH6EpjdAN3ZM6ruukir0bhosib1U8Xc,659
+moducomp/__init__.py,sha256=nJN89FGBpZiExcHKGNdOz3gtzXtd8VK5u6Nkbrfd1bQ,659
 moducomp/__main__.py,sha256=1O2pv6IGjUgqnbqsiMLtVqjxWQpRtZUjp8LDljZ1bsI,185
-moducomp/moducomp.py,sha256=hzvbqpBfk0AXYz6EKpwhAd_rNXkhTEgdpPK8nn4qxhM,179059
+moducomp/moducomp.py,sha256=dL3BurI7dahfuoJVPrIbbu-pYz0lpsR_PTmQ1lcUnXM,184074
 moducomp/data/test_genomes/IMG2562617132.faa,sha256=gZPh-08pMRdAWJRr3__TbnU1F68CdkDb3gxtpaCLTTc,356863
 moducomp/data/test_genomes/IMG2568526683.faa,sha256=PxFJwe-68UGw7il1hGlNhZt4-2WzzxXxGE1GTskDnow,343109
 moducomp/data/test_genomes/IMG2740892217.faa,sha256=WsId4sIPxENbqF6tYFouAgDCy6T0SXNY6TywxBNe-3E,548954
-moducomp-0.7.18.dist-info/entry_points.txt,sha256=RSz22pcRnRKHRpABJKRjClInK25iiHNpbTB1Kj5D3m4,50
-moducomp-0.7.18.dist-info/licenses/LICENSE.txt,sha256=pt0cfIq9Wop21KDZYyQgP0M1YWYvKG0PomA5cUDC4TI,1536
-moducomp-0.7.18.dist-info/WHEEL,sha256=_2ozNFCLWc93bK4WKHCO-eDUENDlo-dgc9cU3qokYO4,82
-moducomp-0.7.18.dist-info/METADATA,sha256=6YLcTn2BiP6VNBKpk5vo1iigK4O9pW-KVhlprjWNHlY,21642
-moducomp-0.7.18.dist-info/RECORD,,
+moducomp-0.7.23.dist-info/entry_points.txt,sha256=RSz22pcRnRKHRpABJKRjClInK25iiHNpbTB1Kj5D3m4,50
+moducomp-0.7.23.dist-info/licenses/LICENSE.txt,sha256=pt0cfIq9Wop21KDZYyQgP0M1YWYvKG0PomA5cUDC4TI,1536
+moducomp-0.7.23.dist-info/WHEEL,sha256=_2ozNFCLWc93bK4WKHCO-eDUENDlo-dgc9cU3qokYO4,82
+moducomp-0.7.23.dist-info/METADATA,sha256=YiH9_ZC3ZRLg7xGD2upFh1svy4gSAEqb1VDR5fmdeDc,22304
+moducomp-0.7.23.dist-info/RECORD,,