pyeasyphd 0.3.19__py3-none-any.whl → 0.3.21__py3-none-any.whl

pyeasyphd/scripts/run_compare.py

@@ -11,6 +11,24 @@ def run_compare_bib_with_local(
     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
@@ -32,6 +50,22 @@ def run_compare_bib_with_zotero(
     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

pyeasyphd/scripts/run_format.py

@@ -11,6 +11,22 @@ def run_format_bib_to_save_by_entry_type(
     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)
 
@@ -27,6 +43,23 @@ def run_format_bib_to_abbr_zotero_save(
     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)
 

pyeasyphd/scripts/run_search.py

@@ -1,5 +1,5 @@
 import os
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 
 from pyadvtools import transform_to_data_list
 from pybibtexer.tools import compare_bibs_with_zotero
@@ -58,6 +58,7 @@ def run_search_for_files(
     path_spidered_bibs: str,
     path_spidering_bibs: str,
     path_conf_j_jsons: str,
+    options: Optional[dict] = None
 ) -> None:
     """
     Run search and save results to files with custom keywords.
@@ -70,6 +71,9 @@ def run_search_for_files(
         path_spidering_bibs: Path to spidering bibliography files
         path_conf_j_jsons: Path to conferences/journals JSON files
     """
+    if options is None:
+        options = {}
+
     # Expand and normalize file paths
     path_main_output = expand_path(path_main_output)
     path_spidered_bibs, path_spidering_bibs, path_conf_j_jsons = expand_paths(
@@ -77,7 +81,7 @@ def run_search_for_files(
     )
 
     # Configure search options
-    options = {
+    options_ = {
         **build_base_options(
             include_publisher_list=[],
             include_abbr_list=[],
@@ -92,8 +96,9 @@ def run_search_for_files(
             keywords_list_list=keywords_list_list,
         ),
     }
+    options_.update(options)
     # Execute searches across different bibliography sources
-    _execute_searches(options, path_main_output, path_spidered_bibs, path_spidering_bibs)
+    _execute_searches(options_, path_main_output, path_spidered_bibs, path_spidering_bibs)
 
 
 def _execute_searches(

{pyeasyphd-0.3.19.dist-info → pyeasyphd-0.3.21.dist-info}/METADATA

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

{pyeasyphd-0.3.19.dist-info → pyeasyphd-0.3.21.dist-info}/RECORD

@@ -29,10 +29,10 @@ pyeasyphd/scripts/_base.py,sha256=Vm-CehgDng38jACb9KBzKkbyJuc_e5UjG06nIMi_l0o,23
 pyeasyphd/scripts/run_article_md.py,sha256=3jUPa5eWTtfOzBtwzl6ly1OAWfAR8v-uzwqXcj7aa8M,4263
 pyeasyphd/scripts/run_article_tex.py,sha256=VJNXyRagM5a-iz_6pb54yb7lQfTOWxYY_lK4eU6jp5Y,3825
 pyeasyphd/scripts/run_beamer_tex.py,sha256=GpUVSXINHkgJFIQe_k9qWElTxLmAVFNLJhvivjIdinI,3362
-pyeasyphd/scripts/run_compare.py,sha256=uXqA5l4erCryuWx7eCz8b1H9Ed7CcPQYhb9Arxu6qJU,1385
-pyeasyphd/scripts/run_format.py,sha256=zysDqQrSrmqZzt2wUd5lmnl9upbMa_grNg0mdfHhBaM,1163
+pyeasyphd/scripts/run_compare.py,sha256=6UfsAjy9giKTIhvgW2gRbfETkc29_KSV4KyMi1ubN04,3237
+pyeasyphd/scripts/run_format.py,sha256=P1h--AKWblRhbdf1IDmLuu54mbFBFwgGxpGpdLEpZI4,2972
 pyeasyphd/scripts/run_generate.py,sha256=i8J3X3zn2QMuKUshu3FGpaq4kPw_P7TVXU46Wy_mZ8s,8549
-pyeasyphd/scripts/run_search.py,sha256=YcOfBxcfuHfoEXLi6VVsfzHo72EMqSBRGb1eI1I8KOk,7848
+pyeasyphd/scripts/run_search.py,sha256=rnepJpdwakpPFaS65XU_MuC-kQHsF94fwP5rGpVO3-o,7970
 pyeasyphd/tools/__init__.py,sha256=u1MZu_JjVac3HhEmcSTwroS83UVu0W5Vspy3Wu_-GH8,496
 pyeasyphd/tools/generate/generate_from_bibs.py,sha256=Dp1MyADwIRb9qFTFOkMPJLaeeh7NBjuiSLBN7smP2eo,7640
 pyeasyphd/tools/generate/generate_html.py,sha256=JzUEqgTVCaFzd4hXTYUEf0cVSO1QRe0nVUS72W6oyyU,5349
@@ -46,7 +46,7 @@ pyeasyphd/tools/search/search_keywords.py,sha256=YCurXuoYeU1ftve0cb8Hcn_g2FXCXf7
 pyeasyphd/tools/search/search_writers.py,sha256=Dz6D8m17R7x8NT7_PCjwmzlq29AfUz-N6sjyCguDTo4,15702
 pyeasyphd/tools/search/utils.py,sha256=bo7xtIZu31dQvjol1lwyWq1t6ldbw28oondwK8VbAqk,7562
 pyeasyphd/utils/utils.py,sha256=kWxzzgNwz77K9Q7j-RKTaoPpxqiVLVtaBMMhLuEenwE,3128
-pyeasyphd-0.3.19.dist-info/METADATA,sha256=a-YJcq_SaX6tqtasSP8QucXU0PMX-u7HmxB098PVaDw,986
-pyeasyphd-0.3.19.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-pyeasyphd-0.3.19.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-pyeasyphd-0.3.19.dist-info/RECORD,,
+pyeasyphd-0.3.21.dist-info/METADATA,sha256=Nq1g4eU7si9QZwtMbjMnjITS_Mk58OVRJYCDsWfvrbA,986
+pyeasyphd-0.3.21.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+pyeasyphd-0.3.21.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+pyeasyphd-0.3.21.dist-info/RECORD,,