openproteo 1.0.2__tar.gz

openproteo-1.0.2/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: openproteo
+Version: 1.0.2
+Summary: Open proteomics: one install for the OpenProteo vendor reader stack (Thermo, Bruker, Waters)
+Author-email: Nathan Riley <git@nathanriley.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/Sigilweaver/OpenProteo
+Project-URL: Documentation, https://github.com/Sigilweaver/OpenProteo
+Project-URL: Source, https://github.com/Sigilweaver/OpenProteo
+Project-URL: Issues, https://github.com/Sigilweaver/OpenProteo/issues
+Keywords: mass-spectrometry,proteomics,raw,thermo,bruker,waters,tdf,mzml
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: openproteo-io
+Provides-Extra: thermo
+Requires-Dist: opentfraw; extra == "thermo"
+Provides-Extra: bruker
+Requires-Dist: opentimstdf; extra == "bruker"
+Provides-Extra: waters
+Requires-Dist: openwraw; extra == "waters"
+Provides-Extra: all
+Requires-Dist: opentfraw; extra == "all"
+Requires-Dist: opentimstdf; extra == "all"
+Requires-Dist: openwraw; extra == "all"
+
+# openproteo
+
+`openproteo` is a thin Python metapackage that bundles the OpenProteo vendor reader stack:
+
+| Vendor | Format         | Underlying package |
+|--------|----------------|--------------------|
+| Thermo | `.raw` file    | `opentfraw`        |
+| Bruker | `.d/` bundle   | `opentimstdf`      |
+| Waters | `.raw/` dir    | `openwraw`         |
+
+## Install
+
+Install just what you need:
+
+```bash
+pip install openproteo[thermo]
+pip install openproteo[bruker]
+pip install openproteo[waters]
+```
+
+Or install every supported vendor reader:
+
+```bash
+pip install openproteo[all]
+```
+
+## Usage
+
+```python
+import openproteo
+
+kind = openproteo.detect("/data/sample.raw")     # "thermo" | "bruker" | "waters" | None
+run  = openproteo.open_run("/data/sample.raw")    # vendor-specific reader object
+```
+
+`open_run` raises `ImportError` if the matching vendor extra is not installed and
+`ValueError` if the format cannot be detected.
+
+## License
+
+Apache-2.0. See [`LICENSE`](../LICENSE).

openproteo-1.0.2/README.md

@@ -0,0 +1,41 @@
+# openproteo
+
+`openproteo` is a thin Python metapackage that bundles the OpenProteo vendor reader stack:
+
+| Vendor | Format         | Underlying package |
+|--------|----------------|--------------------|
+| Thermo | `.raw` file    | `opentfraw`        |
+| Bruker | `.d/` bundle   | `opentimstdf`      |
+| Waters | `.raw/` dir    | `openwraw`         |
+
+## Install
+
+Install just what you need:
+
+```bash
+pip install openproteo[thermo]
+pip install openproteo[bruker]
+pip install openproteo[waters]
+```
+
+Or install every supported vendor reader:
+
+```bash
+pip install openproteo[all]
+```
+
+## Usage
+
+```python
+import openproteo
+
+kind = openproteo.detect("/data/sample.raw")     # "thermo" | "bruker" | "waters" | None
+run  = openproteo.open_run("/data/sample.raw")    # vendor-specific reader object
+```
+
+`open_run` raises `ImportError` if the matching vendor extra is not installed and
+`ValueError` if the format cannot be detected.
+
+## License
+
+Apache-2.0. See [`LICENSE`](../LICENSE).

openproteo-1.0.2/openproteo/__init__.py

@@ -0,0 +1,114 @@
+"""OpenProteo: open proteomics vendor reader stack.
+
+This metapackage is the single pip install surface for the stack. The
+base install always brings ``openproteo_io`` (the Rust-backed reader
+that converts vendor inputs to mzML / Arrow); the per-vendor extras
+layer on direct Python bindings for each native vendor package:
+
+* ``opentfraw``   - Thermo `.raw` files
+* ``opentimstdf`` - Bruker timsTOF `.d/` bundles
+* ``openwraw``    - Waters MassLynx `.raw/` directories
+
+Install the umbrella::
+
+    pip install openproteo            # openproteo_io only
+    pip install openproteo[thermo]    # + opentfraw
+    pip install openproteo[bruker]    # + opentimstdf
+    pip install openproteo[waters]    # + openwraw
+    pip install openproteo[all]       # + all vendor extensions
+
+Top-level helpers fall into two layers:
+
+* ``detect_format``, ``to_mzml``, ``iter_spectra`` are re-exports from
+  ``openproteo_io`` - the vendor-agnostic reader.
+* ``detect``, ``open_run`` use only structural checks and dispatch to
+  the vendor extension that matches the input path (requires the
+  corresponding extra).
+"""
+
+from __future__ import annotations
+
+import os
+from importlib.metadata import PackageNotFoundError, version as _pkg_version
+from pathlib import Path
+from typing import Optional
+
+try:
+    __version__ = _pkg_version("openproteo")
+except PackageNotFoundError:  # pragma: no cover - source checkout fallback
+    __version__ = "0.0.0+unknown"
+
+# Re-export the openproteo_io reader surface so callers can write
+# ``from openproteo import to_mzml, iter_spectra, detect_format``.
+try:
+    from openproteo_io import (  # type: ignore[import-not-found]
+        Spectrum,
+        iter_spectra,
+        to_mzml,
+    )
+    from openproteo_io import detect as detect_format  # type: ignore[import-not-found]
+except ImportError:  # pragma: no cover - openproteo_io is a hard dep
+    Spectrum = None  # type: ignore[assignment]
+    detect_format = None  # type: ignore[assignment]
+    iter_spectra = None  # type: ignore[assignment]
+    to_mzml = None  # type: ignore[assignment]
+
+__all__ = [
+    "__version__",
+    "VENDORS",
+    "Spectrum",
+    "detect",
+    "detect_format",
+    "iter_spectra",
+    "open_run",
+    "to_mzml",
+]
+
+VENDORS = ("thermo", "bruker", "waters")
+
+
+def detect(path: str | os.PathLike[str]) -> Optional[str]:
+    """Return ``"thermo"``, ``"bruker"``, ``"waters"`` or ``None`` for *path*.
+
+    The check is purely structural (extension + sentinel files); no vendor
+    reader needs to be importable.
+    """
+    p = Path(path)
+    if not p.exists():
+        return None
+    if p.is_file() and p.suffix.lower() == ".raw":
+        return "thermo"
+    if p.is_dir():
+        suffix = p.suffix.lower()
+        if suffix == ".d" and (p / "analysis.tdf").is_file():
+            return "bruker"
+        if suffix == ".raw" and any(
+            (p / name).exists()
+            for name in ("_FUNCTNS.INF", "_extern.inf", "_HEADER.TXT")
+        ):
+            return "waters"
+    return None
+
+
+def open_run(path: str | os.PathLike[str]):
+    """Detect *path*, import the matching vendor package, and open the run.
+
+    Raises ``ImportError`` if the matching vendor extra is not installed and
+    ``ValueError`` if the format cannot be detected.
+    """
+    kind = detect(path)
+    if kind is None:
+        raise ValueError(f"no supported vendor format detected at {path}")
+    if kind == "thermo":
+        import opentfraw  # type: ignore[import-not-found]
+
+        return opentfraw.RawFile(str(path))
+    if kind == "bruker":
+        import opentimstdf  # type: ignore[import-not-found]
+
+        return opentimstdf.Reader(str(path))
+    if kind == "waters":
+        import openwraw  # type: ignore[import-not-found]
+
+        return openwraw.RawReader(str(path))
+    raise ValueError(f"unhandled vendor kind: {kind}")

openproteo-1.0.2/openproteo.egg-info/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: openproteo
+Version: 1.0.2
+Summary: Open proteomics: one install for the OpenProteo vendor reader stack (Thermo, Bruker, Waters)
+Author-email: Nathan Riley <git@nathanriley.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/Sigilweaver/OpenProteo
+Project-URL: Documentation, https://github.com/Sigilweaver/OpenProteo
+Project-URL: Source, https://github.com/Sigilweaver/OpenProteo
+Project-URL: Issues, https://github.com/Sigilweaver/OpenProteo/issues
+Keywords: mass-spectrometry,proteomics,raw,thermo,bruker,waters,tdf,mzml
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: openproteo-io
+Provides-Extra: thermo
+Requires-Dist: opentfraw; extra == "thermo"
+Provides-Extra: bruker
+Requires-Dist: opentimstdf; extra == "bruker"
+Provides-Extra: waters
+Requires-Dist: openwraw; extra == "waters"
+Provides-Extra: all
+Requires-Dist: opentfraw; extra == "all"
+Requires-Dist: opentimstdf; extra == "all"
+Requires-Dist: openwraw; extra == "all"
+
+# openproteo
+
+`openproteo` is a thin Python metapackage that bundles the OpenProteo vendor reader stack:
+
+| Vendor | Format         | Underlying package |
+|--------|----------------|--------------------|
+| Thermo | `.raw` file    | `opentfraw`        |
+| Bruker | `.d/` bundle   | `opentimstdf`      |
+| Waters | `.raw/` dir    | `openwraw`         |
+
+## Install
+
+Install just what you need:
+
+```bash
+pip install openproteo[thermo]
+pip install openproteo[bruker]
+pip install openproteo[waters]
+```
+
+Or install every supported vendor reader:
+
+```bash
+pip install openproteo[all]
+```
+
+## Usage
+
+```python
+import openproteo
+
+kind = openproteo.detect("/data/sample.raw")     # "thermo" | "bruker" | "waters" | None
+run  = openproteo.open_run("/data/sample.raw")    # vendor-specific reader object
+```
+
+`open_run` raises `ImportError` if the matching vendor extra is not installed and
+`ValueError` if the format cannot be detected.
+
+## License
+
+Apache-2.0. See [`LICENSE`](../LICENSE).

openproteo-1.0.2/openproteo.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+./openproteo/__init__.py
+openproteo/__init__.py
+openproteo.egg-info/PKG-INFO
+openproteo.egg-info/SOURCES.txt
+openproteo.egg-info/dependency_links.txt
+openproteo.egg-info/requires.txt
+openproteo.egg-info/top_level.txt
+tests/test_metapackage.py

openproteo-1.0.2/openproteo.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

openproteo-1.0.2/openproteo.egg-info/requires.txt

@@ -0,0 +1,15 @@
+openproteo-io
+
+[all]
+opentfraw
+opentimstdf
+openwraw
+
+[bruker]
+opentimstdf
+
+[thermo]
+opentfraw
+
+[waters]
+openwraw

openproteo-1.0.2/openproteo.egg-info/top_level.txt

@@ -0,0 +1 @@
+openproteo

openproteo-1.0.2/pyproject.toml

@@ -0,0 +1,49 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "openproteo"
+version = "1.0.2"
+description = "Open proteomics: one install for the OpenProteo vendor reader stack (Thermo, Bruker, Waters)"
+readme = "README.md"
+license = { text = "Apache-2.0" }
+authors = [{ name = "Nathan Riley", email = "git@nathanriley.com" }]
+requires-python = ">=3.9"
+keywords = [
+    "mass-spectrometry",
+    "proteomics",
+    "raw",
+    "thermo",
+    "bruker",
+    "waters",
+    "tdf",
+    "mzml",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Rust",
+    "Topic :: Scientific/Engineering :: Bio-Informatics",
+]
+dependencies = ["openproteo-io"]
+
+[project.optional-dependencies]
+# The base install always brings openproteo-io (the vendor-agnostic Rust
+# reader). Each extra layers on a per-vendor native binding; the `all`
+# extra installs every supported vendor.
+thermo = ["opentfraw"]
+bruker = ["opentimstdf"]
+waters = ["openwraw"]
+all = ["opentfraw", "opentimstdf", "openwraw"]
+
+[project.urls]
+Homepage = "https://github.com/Sigilweaver/OpenProteo"
+Documentation = "https://github.com/Sigilweaver/OpenProteo"
+Source = "https://github.com/Sigilweaver/OpenProteo"
+Issues = "https://github.com/Sigilweaver/OpenProteo/issues"
+
+[tool.setuptools]
+packages = ["openproteo"]
+package-dir = { "" = "." }

openproteo-1.0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

openproteo-1.0.2/tests/test_metapackage.py

@@ -0,0 +1,155 @@
+"""Smoke tests for the `openproteo` metapackage.
+
+These tests do not require any vendor corpus. They exercise:
+
+* metadata (`__version__`, `__all__`),
+* structural `detect()` against synthesized directories/files,
+* `open_run()` error paths,
+* presence of the `openproteo_io` re-exports (when installed).
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import openproteo
+import pytest
+
+
+def test_version_string():
+    assert isinstance(openproteo.__version__, str)
+    assert openproteo.__version__.count(".") >= 1
+
+
+def test_vendors_tuple():
+    assert openproteo.VENDORS == ("thermo", "bruker", "waters")
+
+
+def test_detect_thermo_file(tmp_path: Path):
+    f = tmp_path / "sample.raw"
+    f.write_bytes(b"")
+    assert openproteo.detect(f) == "thermo"
+
+
+def test_detect_bruker_d(tmp_path: Path):
+    d = tmp_path / "sample.d"
+    d.mkdir()
+    (d / "analysis.tdf").write_bytes(b"")
+    assert openproteo.detect(d) == "bruker"
+
+
+def test_detect_waters_raw(tmp_path: Path):
+    d = tmp_path / "sample.raw"
+    d.mkdir()
+    (d / "_HEADER.TXT").write_bytes(b"")
+    assert openproteo.detect(d) == "waters"
+
+
+def test_detect_unknown_returns_none(tmp_path: Path):
+    p = tmp_path / "something.txt"
+    p.write_bytes(b"hello")
+    assert openproteo.detect(p) is None
+
+
+def test_detect_missing_path_returns_none(tmp_path: Path):
+    assert openproteo.detect(tmp_path / "does-not-exist") is None
+
+
+def test_open_run_unknown_raises(tmp_path: Path):
+    p = tmp_path / "nope.txt"
+    p.write_bytes(b"")
+    with pytest.raises(ValueError):
+        openproteo.open_run(p)
+
+
+def test_openproteo_io_reexports_present():
+    # The base install pulls openproteo_io; the re-exports should be
+    # importable callables. If openproteo_io is genuinely missing the
+    # module falls back to None and we skip.
+    if openproteo.to_mzml is None:
+        pytest.skip("openproteo_io not importable in this environment")
+    assert callable(openproteo.to_mzml)
+    assert callable(openproteo.iter_spectra)
+    assert callable(openproteo.detect_format)
+
+
+def test_version_matches_installed_metadata():
+    """Catch ``__version__`` drift from ``pyproject.toml`` early."""
+    from importlib.metadata import PackageNotFoundError, version
+
+    try:
+        installed = version("openproteo")
+    except PackageNotFoundError:
+        pytest.skip("openproteo not installed (running from source)")
+    assert openproteo.__version__ == installed
+
+
+def test_open_run_thermo_dispatch(monkeypatch, tmp_path: Path):
+    """``open_run`` on a thermo file imports opentfraw and calls ``RawFile``."""
+    import sys
+    import types
+
+    f = tmp_path / "sample.raw"
+    f.write_bytes(b"")
+    calls: list[str] = []
+
+    fake = types.ModuleType("opentfraw")
+    fake.RawFile = lambda p: calls.append(("thermo", p)) or "thermo-handle"  # type: ignore[attr-defined]
+    monkeypatch.setitem(sys.modules, "opentfraw", fake)
+
+    assert openproteo.open_run(f) == "thermo-handle"
+    assert calls == [("thermo", str(f))]
+
+
+def test_open_run_bruker_dispatch(monkeypatch, tmp_path: Path):
+    import sys
+    import types
+
+    d = tmp_path / "sample.d"
+    d.mkdir()
+    (d / "analysis.tdf").write_bytes(b"")
+    calls: list[str] = []
+
+    fake = types.ModuleType("opentimstdf")
+    fake.Reader = lambda p: calls.append(("bruker", p)) or "bruker-handle"  # type: ignore[attr-defined]
+    monkeypatch.setitem(sys.modules, "opentimstdf", fake)
+
+    assert openproteo.open_run(d) == "bruker-handle"
+    assert calls == [("bruker", str(d))]
+
+
+def test_open_run_waters_dispatch(monkeypatch, tmp_path: Path):
+    import sys
+    import types
+
+    d = tmp_path / "sample.raw"
+    d.mkdir()
+    (d / "_HEADER.TXT").write_bytes(b"")
+    calls: list[str] = []
+
+    fake = types.ModuleType("openwraw")
+    fake.RawReader = lambda p: calls.append(("waters", p)) or "waters-handle"  # type: ignore[attr-defined]
+    monkeypatch.setitem(sys.modules, "openwraw", fake)
+
+    assert openproteo.open_run(d) == "waters-handle"
+    assert calls == [("waters", str(d))]
+
+
+def test_vendors_is_immutable_tuple():
+    assert isinstance(openproteo.VENDORS, tuple)
+    with pytest.raises((TypeError, AttributeError)):
+        openproteo.VENDORS[0] = "nope"  # type: ignore[index]
+
+
+def test_public_api_surface():
+    expected = {
+        "__version__",
+        "VENDORS",
+        "Spectrum",
+        "detect",
+        "detect_format",
+        "iter_spectra",
+        "open_run",
+        "to_mzml",
+    }
+    assert set(openproteo.__all__) == expected