pyeasyphd 0.3.19__tar.gz → 0.3.20__tar.gz

{pyeasyphd-0.3.19 → pyeasyphd-0.3.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyeasyphd
-Version: 0.3.19
+Version: 0.3.20
 Summary: pyeasyphd
 License: GPL-3.0-or-later
 License-File: LICENSE

pyeasyphd-0.3.20/pyeasyphd/scripts/run_compare.py

@@ -0,0 +1,79 @@
+from pybibtexer.tools import compare_bibs_with_local, compare_bibs_with_zotero
+
+from ._base import build_base_options, expand_paths
+
+
+def run_compare_bib_with_local(
+    options: dict,
+    need_compare_bib: str,
+    path_output: str,
+    path_spidered_bibs: str,
+    path_spidering_bibs: str,
+    path_conf_j_jsons: str,
+) -> None:
+    """
+    Compare a target bibliography file with local bibliography collections and generate comparison results.
+
+    This function performs a comprehensive comparison between a specified bibliography file and
+    existing local bibliography collections. Results are saved to the specified output directory.
+
+    Args:
+        options: Configuration dictionary for comparison behavior settings
+            compare_each_entry_with_all_local_bibs: Whether to compare each entry with all local bib files
+        need_compare_bib: Path to the target bibliography file that needs to be compared
+        path_output: Output directory path where comparison results will be saved
+        path_spidered_bibs: Directory path containing pre-collected/spidered bibliography files
+        path_spidering_bibs: Directory path containing actively spidered bibliography files
+        path_conf_j_jsons: Path to conference/journal configuration JSON files
+
+    Returns:
+        None: Results are written to files in the specified output directory
+    """
+    # Expand and normalize file paths
+    need_compare_bib, path_output, path_spidered_bibs, path_spidering_bibs = expand_paths(
+        need_compare_bib, path_output, path_spidered_bibs, path_spidering_bibs
+    )
+
+    # Update options
+    options_ = build_base_options([], [], ["arXiv"], [], path_conf_j_jsons)
+    options_["include_early_access"] = True
+    options_.update(options)
+
+    # Compare
+    compare_bibs_with_local(need_compare_bib, path_spidered_bibs, path_spidering_bibs, path_output, options_)
+
+
+def run_compare_bib_with_zotero(
+    options: dict,
+    need_compare_bib: str,
+    zotero_bib: str,
+    path_output: str,
+    path_conf_j_jsons: str,
+) -> None:
+    """
+    Compare a target bibliography file with Zotero bibliography data and generate comparison results.
+
+    This function performs comparison between a specified bibliography file and Zotero bibliography data,
+    identifying matches, differences, and potential conflicts between the two sources.
+
+    Args:
+        options: Configuration dictionary for comparison behavior settings
+        need_compare_bib: Path to the target bibliography file that needs to be compared
+        zotero_bib: Path to the Zotero bibliography file or export data
+        path_output: Output directory path where comparison results will be saved
+        path_conf_j_jsons: Path to conference/journal configuration JSON files
+
+    Returns:
+        None: Results are written to files in the specified output directory
+    """
+    # Expand and normalize file paths
+    need_compare_bib, zotero_bib, path_output = expand_paths(
+        need_compare_bib, zotero_bib, path_output
+    )
+
+    # Update options
+    options_ = build_base_options([], [], ["arXiv"], [], path_conf_j_jsons)
+    options_.update(options)
+
+    # Compare
+    compare_bibs_with_zotero(zotero_bib, need_compare_bib, path_output, options_)

pyeasyphd-0.3.20/pyeasyphd/scripts/run_format.py

@@ -0,0 +1,70 @@
+from pathlib import Path
+
+from pybibtexer.tools import format_bib_to_abbr_zotero_save_modes, format_bib_to_save_mode_by_entry_type
+
+from ._base import build_base_options, expand_paths
+
+
+def run_format_bib_to_save_by_entry_type(
+    options: dict,
+    need_format_bib: str,
+    path_output: str,
+    path_conf_j_jsons: str,
+) -> None:
+    """
+    Format a bibliography file by organizing entries according to their entry types and save the results.
+
+    This function processes a bibliography file and reorganizes the entries based on their
+    bibliographic entry types (e.g., article, conference, book, etc.), creating separate
+    organized output files for better management and categorization.
+
+    Args:
+        options: Configuration dictionary for formatting behavior settings
+        need_format_bib: Path to the bibliography file that needs to be formatted
+        path_output: Output directory path where formatted bibliography files will be saved
+        path_conf_j_jsons: Path to conference/journal configuration JSON files
+
+    Returns:
+        None: Formatted bibliography files are saved to the specified output directory
+    """
+    # Expand and normalize file paths
+    need_format_bib, path_output = expand_paths(need_format_bib, path_output)
+
+    # Update options
+    options_ = build_base_options([], [], [], [], path_conf_j_jsons)
+    options_.update(options)
+
+    format_bib_to_save_mode_by_entry_type(Path(need_format_bib).stem, path_output, need_format_bib, options=options_)
+
+
+def run_format_bib_to_abbr_zotero_save(
+    options: dict,
+    need_format_bib: str,
+    path_output: str,
+    path_conf_j_jsons: str,
+) -> None:
+    """
+    Format a bibliography file into three different modes: abbreviated, Zotero-compatible, and cleaned source.
+
+    This function processes a bibliography file and generates three formatted versions:
+    1. Abbreviated version: Journal/conference names are abbreviated according to standard rules
+    2. Zotero-compatible version: Formatted specifically for Zotero reference management software
+    3. Source preservation version: Maintains original content with consistent formatting and organization
+
+    Args:
+        options: Configuration dictionary for formatting behavior settings
+        need_format_bib: Path to the bibliography file that needs to be formatted
+        path_output: Output directory path where the three formatted bibliography files will be saved
+        path_conf_j_jsons: Path to conference/journal configuration JSON files for abbreviation rules
+
+    Returns:
+        None: Three formatted bibliography files are saved to the specified output directory
+    """
+    # Expand and normalize file paths
+    need_format_bib, path_output = expand_paths(need_format_bib, path_output)
+
+    # Update options
+    options_ = build_base_options([], [], [], [], path_conf_j_jsons)
+    options_.update(options)
+
+    format_bib_to_abbr_zotero_save_modes(need_format_bib, path_output, options=options_)

{pyeasyphd-0.3.19 → pyeasyphd-0.3.20}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyeasyphd"
-version = "0.3.19"
+version = "0.3.20"
 description = "pyeasyphd"
 license = "GPL-3.0-or-later"
 authors = ["NextAI <nextartifintell@gmail.com>"]

pyeasyphd-0.3.19/pyeasyphd/scripts/run_compare.py

@@ -1,45 +0,0 @@
-from pybibtexer.tools import compare_bibs_with_local, compare_bibs_with_zotero
-
-from ._base import build_base_options, expand_paths
-
-
-def run_compare_bib_with_local(
-    options: dict,
-    need_compare_bib: str,
-    path_output: str,
-    path_spidered_bibs: str,
-    path_spidering_bibs: str,
-    path_conf_j_jsons: str,
-) -> None:
-    # Expand and normalize file paths
-    need_compare_bib, path_output, path_spidered_bibs, path_spidering_bibs = expand_paths(
-        need_compare_bib, path_output, path_spidered_bibs, path_spidering_bibs
-    )
-
-    # Update options
-    options_ = build_base_options([], [], ["arXiv"], [], path_conf_j_jsons)
-    options_["include_early_access"] = True
-    options_.update(options)
-
-    # Compare
-    compare_bibs_with_local(need_compare_bib, path_spidered_bibs, path_spidering_bibs, path_output, options_)
-
-
-def run_compare_bib_with_zotero(
-    options: dict,
-    need_compare_bib: str,
-    zotero_bib: str,
-    path_output: str,
-    path_conf_j_jsons: str,
-) -> None:
-    # Expand and normalize file paths
-    need_compare_bib, zotero_bib, path_output = expand_paths(
-        need_compare_bib, zotero_bib, path_output
-    )
-
-    # Update options
-    options_ = build_base_options([], [], ["arXiv"], [], path_conf_j_jsons)
-    options_.update(options)
-
-    # Compare
-    compare_bibs_with_zotero(zotero_bib, need_compare_bib, path_output, options_)

pyeasyphd-0.3.19/pyeasyphd/scripts/run_format.py

@@ -1,37 +0,0 @@
-from pathlib import Path
-
-from pybibtexer.tools import format_bib_to_abbr_zotero_save_modes, format_bib_to_save_mode_by_entry_type
-
-from ._base import build_base_options, expand_paths
-
-
-def run_format_bib_to_save_by_entry_type(
-    options: dict,
-    need_format_bib: str,
-    path_output: str,
-    path_conf_j_jsons: str,
-) -> None:
-    # Expand and normalize file paths
-    need_format_bib, path_output = expand_paths(need_format_bib, path_output)
-
-    # Update options
-    options_ = build_base_options([], [], [], [], path_conf_j_jsons)
-    options_.update(options)
-
-    format_bib_to_save_mode_by_entry_type(Path(need_format_bib).stem, path_output, need_format_bib, options=options_)
-
-
-def run_format_bib_to_abbr_zotero_save(
-    options: dict,
-    need_format_bib: str,
-    path_output: str,
-    path_conf_j_jsons: str,
-) -> None:
-    # Expand and normalize file paths
-    need_format_bib, path_output = expand_paths(need_format_bib, path_output)
-
-    # Update options
-    options_ = build_base_options([], [], [], [], path_conf_j_jsons)
-    options_.update(options)
-
-    format_bib_to_abbr_zotero_save_modes(need_format_bib, path_output, options=options_)