Simplified method signature to save_results, as download context is already understood.

Author: garethpwright1

README.md

@@ -95,8 +95,7 @@ source venv/bin/activate
 
 ### Basic Usage
 
-The following examples will download Article PDFs to a 'downloads' directory,
-relative to your current working directory, and name the files `<doi>`.pdf. Run all code in your [Virtual Environment](#install).
+The following examples will download Article PDFs to a 'downloads' directory, and name the files `<doi>`.pdf. All file & directory paths are relative to your current working directory (pwd). Run all code in your [Virtual Environment](#install).
 
 **Instantiate client**
 ```python
@@ -121,6 +120,11 @@ tdm.download_pdfs(["10.1111/jtsb.12390", "10.1111/jlse.12141"])
 tdm.download_pdfs("dois.txt")
 ```
 
+**Save download results to file (default: results.csv)**
+```python
+tdm.save_results()
+```
+
 **More examples**
 
 See more [examples](examples/).

examples/example3.py

@@ -32,4 +32,4 @@
 tdm.download_pdfs("oa-dois.txt")
 
 # Save the download results to a CSV file: 'results.csv'
-tdm.save_download_results()
+tdm.save_results()

src/wiley_tdm/tdm_client.py

@@ -105,7 +105,7 @@ def __init__(
         # Public attributes (set via public properties)
         self.download_dir = download_dir
         self.api_rate_limit = TDMClient.API_RATE_LIMIT
-        self.download_results_errors_only: bool = False
+        self.only_record_errors: bool = False
         self.skip_existing_files: bool = True
 
         # Private attributes
@@ -114,7 +114,7 @@ def __init__(
         self._api_token: str
         self._api_headers: dict[str, str] = {}
         self._api_session: requests.Session
-        self._download_results: List[DownloadResult] = []
+        self._results: List[DownloadResult] = []
 
         self._validate_api_token(api_token)
         self._create_api_session()
@@ -260,9 +260,57 @@ def download_pdf(self, doi: str) -> DownloadResult:
             duration = time.perf_counter() - start_time
             result.duration = duration
 
-        self._add_download_result(result)
+        self._add_result(result)
         return result
 
+    def download_pdfs(
+        self,
+        dois: Union[List[str], StrPath],
+        on_result: Optional[Callable[[DownloadResult], None]] = None,
+    ) -> List[DownloadResult]:
+        """Download multiple PDFs from either a list of DOIs or a file containing DOIs.
+
+        Args:
+            dois: Either a list of DOI strings or a path to a file containing DOIs (one per line)
+            on_result: Optional callback function called after each download
+        Relative paths are resolved from the current working directory
+
+        Returns:
+            List[DownloadResult]: List of download results
+
+        Raises:
+            FileNotFoundError: If dois is a file path that doesn't exist
+            ValueError: If dois list is empty
+        """
+        # Check if `dois` is a string or Path (matches StrPath type alias)
+        if isinstance(dois, (str, Path)):
+            dois_list: List[str] = FileUtils.read_lines_from_file(dois)
+            self.logger.info("Found %d DOIs in %s", len(dois_list), dois)
+        # Explicitly check that `dois` is a list of strings
+        elif isinstance(dois, list):
+            dois_list: List[str] = dois
+        else:
+            raise TypeError("Invalid type for `dois`. Expected List[str] or StrPath.")
+
+        if not dois_list:
+            raise ValueError("DOIs list cannot be empty")
+
+        unique_dois: List[str] = DOIUtils.dedupe(dois_list)
+        results: List[DownloadResult] = []
+
+        for doi in unique_dois:
+            result = self.download_pdf(doi)
+            if result:
+                results.append(result)
+                if on_result:
+                    on_result(result)
+                if result.status != DownloadStatus.EXISTING_FILE:
+                    self.logger.debug(
+                        "Rate limiting: sleeping for %s seconds", self.api_rate_limit
+                    )
+                    time.sleep(self.api_rate_limit)
+        return results
+
     def _download_pdf(self, doi: str) -> DownloadResult:
         """Download an article PDF given its DOI.
 
@@ -358,54 +406,7 @@ def _save_pdf(self, response: requests.Response, doi: str) -> DownloadResult:
         except IOError as e:
             return DownloadResult(doi, DownloadStatus.STORAGE_ERROR, str(e), pdf_path)
 
-    def download_pdfs(
-        self,
-        dois: Union[List[str], StrPath],
-        on_result: Optional[Callable[[DownloadResult], None]] = None,
-    ) -> List[DownloadResult]:
-        """Download multiple PDFs from either a list of DOIs or a file containing DOIs.
-
-        Args:
-            dois: Either a list of DOI strings or a path to a file containing DOIs (one per line)
-            on_result: Optional callback function called after each download
-
-        Returns:
-            List[DownloadResult]: List of download results
-
-        Raises:
-            FileNotFoundError: If dois is a file path that doesn't exist
-            ValueError: If dois list is empty
-        """
-        # Check if `dois` is a string or Path (matches StrPath type alias)
-        if isinstance(dois, (str, Path)):
-            dois_list: List[str] = FileUtils.read_lines_from_file(dois)
-            self.logger.info("Found %d DOIs in %s", len(dois_list), dois)
-        # Explicitly check that `dois` is a list of strings
-        elif isinstance(dois, list):
-            dois_list: List[str] = dois
-        else:
-            raise TypeError("Invalid type for `dois`. Expected List[str] or StrPath.")
-
-        if not dois_list:
-            raise ValueError("DOIs list cannot be empty")
-
-        unique_dois: List[str] = DOIUtils.dedupe(dois_list)
-        results: List[DownloadResult] = []
-
-        for doi in unique_dois:
-            result = self.download_pdf(doi)
-            if result:
-                results.append(result)
-                if on_result:
-                    on_result(result)
-                if result.status != DownloadStatus.EXISTING_FILE:
-                    self.logger.debug(
-                        "Rate limiting: sleeping for %s seconds", self.api_rate_limit
-                    )
-                    time.sleep(self.api_rate_limit)
-        return results
-
-    def _add_download_result(self, result: DownloadResult) -> None:
+    def _add_result(self, result: DownloadResult) -> None:
         """Record download result.
 
         Args:
@@ -415,37 +416,35 @@ def _add_download_result(self, result: DownloadResult) -> None:
         message = f"DOI: {result.doi} - {result.status}"
 
         if result.status in (DownloadStatus.SUCCESS, DownloadStatus.EXISTING_FILE):
-            if self.download_results_errors_only:
+            if self.only_record_errors:
                 return
             self.logger.info(message)
         else:
             self.logger.error(message)
 
-        self._download_results.append(result)
+        self._results.append(result)
 
     @property
-    def download_results(self) -> List[DownloadResult]:
+    def results(self) -> List[DownloadResult]:
         """Get the current download results.
 
         Returns:
             List[DownloadResult]: List of all download attempts and their results
         """
-        return (
-            self._download_results.copy()
-        )  # Return copy to prevent external modification
+        return self._results.copy()  # Return copy to prevent external modification
 
-    def save_download_results(self, csv_path: StrPath = RESULTS_FILE) -> None:
+    def save_results(self, csv_path: StrPath = RESULTS_FILE) -> None:
         """Save download results to CSV file. Defaults to 'results.csv'
 
         Args:
             csv_path: Path where CSV file will be saved. Can be either:
                 - A string path
                 - A PathLike object (recommended)
-                Relative paths are resolved from the current working directory.
+                Relative paths are resolved from the current working directory
         Returns:
             None
 
         Raises:
             OSError: If the file cannot be written due to permissions or other OS issues
         """
-        TDMReporting.save_download_results(self._download_results, csv_path)
+        TDMReporting.save_results(self._results, csv_path)

src/wiley_tdm/tdm_reporting.py

@@ -26,14 +26,15 @@ class TDMReporting:
     ]
 
     @staticmethod
-    def save_download_results(results: List[DownloadResult], csv_path: StrPath) -> None:
+    def save_results(results: List[DownloadResult], csv_path: StrPath) -> None:
         """Save download results to CSV file.
 
         Args:
             results: List of download results to save
             csv_path: Path to the CSV file. Can be either:
                 - A PathLike object (recommend): Path("downloads") / "results.csv"
                 - A string: "downloads/results.csv" Will be converted to Path internally
+            Relative paths are resolved from the current working directory
 
         Note:
             Recommend using Path objects for platform-independent path handling.

tests/test_tdm_client.py

@@ -101,7 +101,7 @@ def test_multiple_downloads(tdm):
     """Test multiple PDF downloads."""
     results = tdm.download_pdfs(OA_DOIS)
     assert len(results) == len(OA_DOIS)
-    assert len(tdm.download_results) == len(results)
+    assert len(tdm.results) == len(results)
 
     for result in results:
         assert_successful_download(result, result.doi)
@@ -112,21 +112,21 @@ def test_multiple_downloads_from_file(tdm):
 
     results = tdm.download_pdfs(DOIS_FILE)
     assert len(results) == DOIS_FILE_COUNT
-    assert len(tdm.download_results) == len(results)
+    assert len(tdm.results) == len(results)
 
     for result in results:
         assert_successful_download(result, result.doi)
 
 
-def test_save_download_results(tdm, tmp_path):
+def test_save_results(tdm, tmp_path):
     """Test saving download results to CSV file."""
     # First generate some download results
     result = tdm.download_pdf(OA_DOI)
     assert_successful_download(result, OA_DOI)
 
     # Save results to temporary CSV file
     csv_path = tmp_path / "results.csv"
-    tdm.save_download_results(str(csv_path))
+    tdm.save_results(str(csv_path))
 
     # Verify file exists and contains data
     assert csv_path.exists()

tests/test_tdm_reporting.py

@@ -47,12 +47,12 @@ def results_fixture():
     ]
 
 
-def test_save_download_results(tmp_path, results):
+def test_save_results(tmp_path, results):
     """Test saving results to CSV with all fields."""
 
     csv_path = tmp_path / TEST_CSV
 
-    TDMReporting.save_download_results(results, csv_path)
+    TDMReporting.save_results(results, csv_path)
 
     assert csv_path.exists()
 
@@ -87,6 +87,6 @@ def test_save_empty_results(tmp_path):
     """Test handling of empty results list."""
 
     csv_path = tmp_path / TEST_CSV
-    TDMReporting.save_download_results([], str(csv_path))
+    TDMReporting.save_results([], str(csv_path))
 
     assert not csv_path.exists()