stidapi 1.4.2__tar.gz → 1.4.3__tar.gz

{stidapi-1.4.2 → stidapi-1.4.3}/PKG-INFO

@@ -1,24 +1,22 @@
 Metadata-Version: 2.4
 Name: stidapi
-Version: 1.4.2
+Version: 1.4.3
 Summary: Python client for connecting to Equinor STIDapi
-License: Proprietary
 Author: Åsmund Våge Fannemel
-Author-email: asmf@equinor.com
-Requires-Python: >=3.10,<4.0
-Classifier: License :: Other/Proprietary License
+Author-email: Åsmund Våge Fannemel <asmf@equinor.com>
+License-Expression: LicenseRef-Proprietary
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: eq-api-connector (>=1.1.0,<2.0.0)
+Requires-Dist: eq-api-connector>=1.1.0,<2
+Requires-Python: >=3.10, <4
 Project-URL: repository, https://github.com/equinor/STIDapi-python
 Description-Content-Type: text/markdown
 
-# STIDapi-python [![SNYK dependency check](https://github.com/equinor/STIDapi-python/actions/workflows/snyk.yml/badge.svg)](https://github.com/equinor/STIDapi-python/actions/workflows/snyk.yml)
-
+# STIDapi-python
 A simple wrapper package to interface Equinor [STIDapi](https://stidapi.equinor.com/) using python and get plant, system, tag and doc data.
 
 
@@ -46,14 +44,13 @@ Install package from pypi using `pip install stidapi`
 
 ## Developing / testing
 
-Poetry is preferred for developers. Install with required packages for testing and coverage:  
-`poetry install`
+Dependency manager uv is preferred for developers. Install with required packages for testing and coverage:  
+`uv sync`
 
-Call `poetry run pytest` to run tests.
+Call `uv run pytest` to run tests.
 
-To generate coverage report run `poetry run pytest --cov=stidapi tests/ --cov-report=xml`
+To generate coverage report run `uv run pytest --cov=stidapi tests/ --cov-report=xml`
 
 To compare coverage with master branch run
-`poetry run diff-cover coverage.xml --compare-branch master`
-
+`uv run diff-cover coverage.xml --compare-branch master`
 

{stidapi-1.4.2 → stidapi-1.4.3}/README.md

@@ -1,5 +1,4 @@
-# STIDapi-python [![SNYK dependency check](https://github.com/equinor/STIDapi-python/actions/workflows/snyk.yml/badge.svg)](https://github.com/equinor/STIDapi-python/actions/workflows/snyk.yml)
-
+# STIDapi-python
 A simple wrapper package to interface Equinor [STIDapi](https://stidapi.equinor.com/) using python and get plant, system, tag and doc data.
 
 
@@ -27,13 +26,13 @@ Install package from pypi using `pip install stidapi`
 
 ## Developing / testing
 
-Poetry is preferred for developers. Install with required packages for testing and coverage:  
-`poetry install`
+Dependency manager uv is preferred for developers. Install with required packages for testing and coverage:  
+`uv sync`
 
-Call `poetry run pytest` to run tests.
+Call `uv run pytest` to run tests.
 
-To generate coverage report run `poetry run pytest --cov=stidapi tests/ --cov-report=xml`
+To generate coverage report run `uv run pytest --cov=stidapi tests/ --cov-report=xml`
 
 To compare coverage with master branch run
-`poetry run diff-cover coverage.xml --compare-branch master`
+`uv run diff-cover coverage.xml --compare-branch master`
 

stidapi-1.4.3/pyproject.toml

@@ -0,0 +1,35 @@
+[project]
+name = "stidapi"
+version = "1.4.3"
+description = "Python client for connecting to Equinor STIDapi"
+requires-python = ">=3.10,<4"
+readme = "README.md"
+license = "LicenseRef-Proprietary"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = ["eq-api-connector>=1.1.0,<2"]
+
+[[project.authors]]
+name = "Åsmund Våge Fannemel"
+email = "asmf@equinor.com"
+
+[project.urls]
+repository = "https://github.com/equinor/STIDapi-python"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.0,<10",
+    "pytest-cov>=7.0.0,<8",
+    "black>=26.3.0,<27",
+    "diff-cover>=10.2.0,<11",
+]
+
+[build-system]
+requires = ["uv_build>=0.11.16,<0.13.0"]
+build-backend = "uv_build"

stidapi-1.4.3/pyproject.toml.orig

@@ -0,0 +1,32 @@
+[project]
+name = "stidapi"
+version = "1.4.3"
+description = "Python client for connecting to Equinor STIDapi"
+authors = [{ name = "Åsmund Våge Fannemel", email = "asmf@equinor.com" }]
+requires-python = ">=3.10,<4"
+readme = "README.md"
+license = "LicenseRef-Proprietary"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = ["eq-api-connector>=1.1.0,<2"]
+
+[project.urls]
+repository = "https://github.com/equinor/STIDapi-python"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.0,<10",
+    "pytest-cov>=7.0.0,<8",
+    "black>=26.3.0,<27",
+    "diff-cover>=10.2.0,<11",
+]
+
+[build-system]
+requires = ["uv_build>=0.11.16,<0.13.0"]
+build-backend = "uv_build"

{stidapi-1.4.2 → stidapi-1.4.3/src}/stidapi/doc.py

@@ -1,3 +1,4 @@
+import os
 from typing import Any, Dict, List, Optional
 from urllib.parse import urljoin
 import stidapi.utils as u
@@ -54,6 +55,40 @@ class File:
         """Get object type."""
         return getattr(self, "objectType", "")
 
+    def download_file(
+        self, destination: Optional[str] = None, overwrite: bool = False
+    ) -> str:
+        """Download this file from STID.
+
+        Args:
+            destination: Optional local path for the downloaded file.
+            overwrite: Allow an existing destination file to be replaced.
+
+        Returns:
+            Path returned by the API connector after downloading the file.
+
+        Raises:
+            ValueError: If no download URL or file name is available.
+        """
+        download_url = getattr(self, "url", "")
+        if not download_url:
+            file_id = getattr(self, "id", None)
+            if file_id is None or not self.inst_code:
+                raise ValueError(
+                    f"No download endpoint found for file {self.file_name}"
+                )
+            download_url = urljoin(u.get_api_url(), f"{self.inst_code}/file/{file_id}")
+
+        output_name = destination or self.file_name
+        if destination and os.path.isdir(destination):
+            output_name = os.path.join(destination, self.file_name)
+        if not output_name:
+            raise ValueError("A destination is required when the file has no name")
+        if os.path.exists(output_name) and not overwrite:
+            raise FileExistsError(f"Destination already exists: {output_name}")
+
+        return u.get_api_client().get_file(download_url, output_name)
+
     def __str__(self) -> str:
         return f"InstCode: {self.inst_code}, FileName: {self.file_name}, Description: {self.description}, ObjectType: {self.object_type}"
 
@@ -108,6 +143,27 @@ class Revision:
         """
         return [File(x) for x in self._data.get("files", [])]
 
+    def download_files(
+        self, destination: Optional[str] = None, overwrite: bool = False
+    ) -> List[str]:
+        """Download all files in this revision.
+
+        Args:
+            destination: Optional destination directory for the downloaded files.
+            overwrite: Allow existing destination files to be replaced.
+
+        Returns:
+            Paths returned by the API connector for each downloaded file.
+        """
+        if destination is None:
+            destination = os.path.join(os.getcwd(), self.rev_no)
+        os.makedirs(destination, exist_ok=True)
+
+        return [
+            file.download_file(destination, overwrite=overwrite)
+            for file in self.get_files()
+        ]
+
     def __str__(self) -> str:
         return f"RevNo: {self.rev_no}, RevStatus: {self.rev_status}, RevDate: {self.rev_date}"
 
@@ -164,6 +220,7 @@ class Doc:
             raise ValueError("doc_no must be a non-empty string")
 
         self._data: Dict[str, Any] = {}
+        self._full_data_loaded = data is None or "currentRevision" in data
 
         if data is not None:
             self._data = data
@@ -187,19 +244,32 @@ class Doc:
         """Get document number."""
         return self._data.get("docNo", "")
 
+    def _ensure_full_data(self) -> None:
+        """Reload document data once when initialized from a partial reference."""
+        if self._full_data_loaded:
+            return
+
+        fetched_data = Doc.get(self.inst_code, self.no)
+        if isinstance(fetched_data, dict):
+            self._data = fetched_data
+        self._full_data_loaded = True
+
     @property
     def category(self) -> str:
         """Get document category description."""
+        self._ensure_full_data()
         return self._data.get("docCategoryDescription", "")
 
     @property
     def discipline(self) -> str:
         """Get discipline code description."""
+        self._ensure_full_data()
         return self._data.get("disciplineCodeDescription", "")
 
     @property
     def type(self) -> str:
         """Get document type description."""
+        self._ensure_full_data()
         return self._data.get("docTypeDescription", "")
 
     @property
@@ -207,13 +277,35 @@ class Doc:
         """Get document title."""
         return self._data.get("docTitle", "")
 
-    def get_current_revision(self) -> Revision:
+    @property
+    def current_revision(self) -> Revision:
         """Get the current revision of this document.
 
         Returns:
             Revision object for the current revision.
         """
-        return Revision(self._data.get("currentRevision", {}))
+        self._ensure_full_data()
+        current_revision = self._data.get("currentRevision")
+
+        if isinstance(current_revision, dict) and current_revision:
+            return Revision(current_revision)
+
+        project_revisions = [
+            revision
+            for revision in self._data.get("projectRevisions", [])
+            if isinstance(revision, dict)
+        ]
+        marked_current = next(
+            (revision for revision in project_revisions if revision.get("isCurrent")),
+            None,
+        )
+        return Revision(
+            marked_current or (project_revisions[0] if project_revisions else {})
+        )
+
+    def get_current_revision(self) -> Revision:
+        """Backward-compatible alias for current_revision."""
+        return self.current_revision
 
     def get_files(self) -> List[File]:
         """Get files from the current revision.
@@ -221,7 +313,29 @@ class Doc:
         Returns:
             List of File objects from the current revision.
         """
-        return self.get_current_revision().get_files()
+        return self.current_revision.get_files()
+
+    def download_files(
+        self,
+        revision: Revision,
+        destination: Optional[str] = None,
+        overwrite: bool = False,
+    ) -> List[str]:
+        """Download all files from a specific revision.
+
+        Args:
+            revision: Revision whose files should be downloaded.
+            destination: Optional destination directory. Defaults to a
+                document/revision directory in the current working directory.
+            overwrite: Allow existing destination files to be replaced.
+
+        Returns:
+            Paths returned by the API connector for each downloaded file.
+        """
+        if destination is None:
+            destination = os.path.join(os.getcwd(), self.no, revision.rev_no)
+        os.makedirs(destination, exist_ok=True)
+        return revision.download_files(destination, overwrite=overwrite)
 
     def __str__(self) -> str:
         return f"InstCode: {self.inst_code}, No: {self.no}, Title: {self.title}"

stidapi-1.4.2/pyproject.toml

@@ -1,24 +0,0 @@
-[tool.poetry]
-name = "stidapi"
-version = "1.4.2"
-description = "Python client for connecting to Equinor STIDapi"
-authors = ["Åsmund Våge Fannemel <asmf@equinor.com>"]
-license = "Proprietary"
-readme = "README.md"
-
-[tool.poetry.urls]
-"repository" = "https://github.com/equinor/STIDapi-python"
-
-[tool.poetry.dependencies]
-python = "^3.10"
-eq-api-connector = "^1.1.0"
-
-[tool.poetry.group.dev.dependencies]
-pytest = "^9.0.0"
-pytest-cov = "^7.0.0"
-black = "^25.10.0"
-diff-cover = "^10.2.0"
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"