pyeasyphd 0.3.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

pyeasyphd/scripts/run_article_md.py

@@ -10,7 +10,7 @@ def run_article_md_daily_notes(
     bib_path_or_file: str,
     path_conferences_journals_json: str,
     options: dict
-):
+) -> None:
     """
     Run article markdown daily notes processing pipeline.
 
@@ -21,7 +21,13 @@ def run_article_md_daily_notes(
         bib_path_or_file (str): Path to bibliography file or directory
         path_conferences_journals_json (str): Path to conferences and journals JSON files directory
         options (dict): Additional options to override default settings
+
+    Returns:
+        None
     """
+    path_input_file = os.path.expandvars(os.path.expanduser(path_input_file))
+    path_output_file = os.path.expandvars(os.path.expanduser(path_output_file))
+
     # Initialize default options with detailed descriptions
     _options = {
         "full_json_c": os.path.expanduser(os.path.join(path_conferences_journals_json, "conferences.json")),
@@ -97,3 +103,5 @@ def run_article_md_daily_notes(
     })
 
     PyRunBibMdTex(path_output_file, ".md", "paper", _options).run_files(file_list, "", "current")
+
+    return None

pyeasyphd/scripts/run_article_tex.py

@@ -0,0 +1,119 @@
+import os
+
+from pyadvtools import GitAutoCommitter
+
+from pyeasyphd.tools import PyRunBibMdTex
+
+
+def run_article_tex_submit(
+    path_input_file: str,
+    input_file_names: list[str],
+    path_output_file: str,
+    bib_path_or_file: str,
+    path_conferences_journals_json: str,
+    options: dict
+) -> None:
+    """
+    Process academic article files (TeX, and bibliography) with automated Git version control.
+
+    This function handles the conversion and processing of academic article files including TeX documents, and
+    bibliography management with automatic Git commit and push capabilities.
+
+    Note: The raw figures and TeX source files must be located in the data/raw subdirectory of the input path.
+
+    Args:
+        path_input_file (str): Path to input files directory
+        input_file_names (list[str]): List of input file names
+        path_output_file (str): Path to output directory
+        bib_path_or_file (str): Path to bibliography file or directory
+        path_conferences_journals_json (str): Path to conferences and journals JSON files directory
+        options (dict): Additional options to override default settings
+
+    Returns:
+        None
+    """
+    path_input_file = os.path.expandvars(os.path.expanduser(path_input_file))
+    path_output_file = os.path.expandvars(os.path.expanduser(path_output_file))
+
+    # Initialize default options with detailed descriptions
+    _options = {
+        "full_json_c": os.path.expanduser(os.path.join(path_conferences_journals_json, "conferences.json")),
+        "full_json_j": os.path.expanduser(os.path.join(path_conferences_journals_json, "journals.json")),
+
+        # figure options
+        "includegraphics_figs_directory": os.path.join(path_input_file, "data", "raw"),
+        "shutil_includegraphics_figs": True,
+        "includegraphics_figs_in_relative_path": True,
+        "figure_folder_name": "figs",  # "" or "figs" or "main"
+
+        # bib options
+        "abbr_index_article_for_abbr": 1,  # 0, 1, 2
+        "abbr_index_inproceedings_for_abbr": 0,  # 0, 1, 2
+        "add_link_to_fields_for_abbr": None,  # None, or ["title", "journal", "booktitle"]
+        "maximum_authors_for_abbr": 0,  # 0, 1, 2, ...
+        "add_index_to_entries": False,
+        "bib_for_abbr_name": "abbr.bib",
+        "bib_for_zotero_name": "zotero.bib",
+        "bib_for_save_name": "save.bib",
+        "display_google_connected_scite": ["google", "connected", "scite"],
+
+        "bib_folder_name": "bibs",  # "" or "bib" or "bibs" or "main"
+        "delete_original_bib_in_output_folder": False,
+        "bib_path_or_file": os.path.expanduser(bib_path_or_file),
+
+        # tex options
+        "handly_preamble": True,
+        "final_output_main_tex_name": "main.tex",
+        "run_latex": False,
+        "delete_run_latex_cache": False,
+
+        "input_texs_directory": os.path.join(path_input_file, "data", "raw"),
+        "shutil_input_texs": True,
+        "input_texs_in_relative_path": True,
+        "tex_folder_name": "texs",  # "" or "tex" or "texs" or "main"
+        "delete_original_tex_in_output_folder": True,
+        "generate_tex": True,
+
+        # md options
+        "add_url_for_basic_dict": True,  # default is True
+        "add_anchor_for_basic_dict": False,  # default is False
+        "add_anchor_for_beauty_dict": False,  # default is False
+        "add_anchor_for_complex_dict": False,  # default is False
+
+        "final_output_main_md_name": "main.md",
+        "delete_temp_generate_md": True,
+        "add_reference_in_md": True,
+        "add_bib_in_md": False,
+        "replace_cite_to_fullcite_in_md": True,
+        "replace_by_basic_beauty_complex_in_md": "basic",
+        "display_basic_beauty_complex_references_in_md": "beauty",
+        "add_anchor_in_md": False,  # default is False
+
+        "md_folder_name": "mds",  # "" or "md" or "main"
+        "delete_original_md_in_output_folder": False,  # default is False
+
+        # html options
+        "generate_html": False,
+    }
+
+    # Update with user-provided options
+    _options.update(options)
+
+    committer = GitAutoCommitter(path_output_file)
+
+    if not committer.auto_check(remote="origin", branch="master"):
+        print("Remote != Local, please manually pull")
+
+    else:
+        # Create full file paths from input file names
+        file_list = [os.path.join(path_input_file, f) for f in input_file_names]
+
+        PyRunBibMdTex(path_output_file, ".tex", "paper", _options).run_files(file_list, "", "current")
+
+        if committer.has_changes():
+            # Auto commit
+            committer.auto_commit()
+            # Auto push
+            committer.auto_push(remote="origin", branch="master")
+
+    return None

{pyeasyphd-0.3.0.dist-info → pyeasyphd-0.3.1.dist-info}/METADATA

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

{pyeasyphd-0.3.0.dist-info → pyeasyphd-0.3.1.dist-info}/RECORD

@@ -25,7 +25,8 @@ pyeasyphd/main/python_run_tex.py,sha256=9Syu8qRjPXN3gEabfRUWxwTFBm_izIcB4yFhsz3Q
 pyeasyphd/pyeasyphd.py,sha256=OAwbwq2rSXLSk2AoTAF8hmlOMRSRfvDn1Uqk-zkuqH8,3470
 pyeasyphd/pyeasyphd.sublime-settings,sha256=KcXx3DjyVf8UfnB4FP4u-jaTQU3Cuj24OvxGCZvXAsw,3135
 pyeasyphd/pyeasyphd.sublime-syntax,sha256=pXylbA-tye-K5dCTjEJLFVRqtY1T7AgWZ4laxo-dnaE,73
-pyeasyphd/scripts/run_article_md.py,sha256=RXDgyc3METP_ln7IUaNDmLfu0XlZkYqm0UIdsyO16zo,3916
+pyeasyphd/scripts/run_article_md.py,sha256=ZjdO03YRDokSqo-Rffby-1p6_P35N4amERKHe4yS6_0,4127
+pyeasyphd/scripts/run_article_tex.py,sha256=TuTEQk7y-Ykos3a_mlEJzyFnT9RKsAYjGXnwHJa5cjY,4672
 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
@@ -39,7 +40,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.0.dist-info/METADATA,sha256=AqB1HjkmWMGsAHYvnnpFK2XBnJBITN7W4T6L-JH3hFE,985
-pyeasyphd-0.3.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-pyeasyphd-0.3.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-pyeasyphd-0.3.0.dist-info/RECORD,,
+pyeasyphd-0.3.1.dist-info/METADATA,sha256=IzA1enwzXYoYBIa46ERPZk5euKztZV50k8oMMOOA3bU,985
+pyeasyphd-0.3.1.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+pyeasyphd-0.3.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+pyeasyphd-0.3.1.dist-info/RECORD,,