article-introduction-generator 0.1.0__py3-none-any.whl

article_introduction_generator/__init__.py

@@ -0,0 +1 @@
+#!/usr/bin/python3

article_introduction_generator/about.py

@@ -0,0 +1,12 @@
+# about.py
+
+__version__ = "0.1.0"
+__package__ = "article_introduction_generator"
+__program_name__ = "article-introduction-generator"
+__author__ = "Fernando Pujaico Rivera" 
+__email__  = "fernando.pujaico.rivera@gmail.com"
+__description__ = "Program to generate an introduction from a JSON File"
+__url_source__  = "https://github.com/trucomanx/ArticleIntroductionGenerator"
+__url_doc__  = "https://github.com/trucomanx/ArticleIntroductionGenerator/tree/main/doc"
+__url_funding__ = "https://trucomanx.github.io/en/funding.html"
+__url_bugs__    = "https://github.com/trucomanx/ArticleIntroductionGenerator/issues"

article_introduction_generator/desktop.py

@@ -0,0 +1,103 @@
+import os
+import article_introduction_generator.about as about
+import subprocess
+
+
+def update_desktop_database(desktop_path):
+    applications_dir = os.path.expanduser(desktop_path)
+    try:
+        subprocess.run(
+            ["update-desktop-database", applications_dir],
+            check=True
+        )
+        print("Shortcut database updated successfully.")
+    except subprocess.CalledProcessError as e:
+        print(f"Error updating the database: {e}")
+    except FileNotFoundError:
+        print("The command 'update-desktop-database' was not found. Verify that the package 'desktop-file-utils' is installed.")
+
+def create_desktop_file(desktop_path, overwrite=False, program_name=None):
+    base_dir_path = os.path.dirname(os.path.abspath(__file__))
+    icon_path = os.path.join(base_dir_path, 'icons', 'logo.png')
+
+    if program_name is None:
+        __program_name = about.__program_name__
+    else:
+        __program_name = program_name
+
+    script_path = os.path.expanduser(f"~/.local/bin/{__program_name}")
+
+    desktop_entry = f"""[Desktop Entry]
+Name={__program_name}
+Comment={about.__description__}
+Exec={script_path}
+Terminal=false
+Type=Application
+Icon={icon_path}
+StartupNotify=true
+Categories=Education;ResearchTools;
+Keywords=organizer;python;
+Encoding=UTF-8
+StartupWMClass={about.__package__}
+"""
+    path = os.path.expanduser(os.path.join(desktop_path,f"{__program_name}.desktop"))
+    
+    if not os.path.exists(path) or overwrite == True: 
+        os.makedirs(os.path.dirname(path), exist_ok=True)
+        with open(path, "w") as f:
+            f.write(desktop_entry)
+        os.chmod(path, 0o755)
+        print(f"File {__program_name}.desktop created in {path}.")
+        update_desktop_database(desktop_path)
+    
+def create_desktop_directory(   directory_name = "ResearchTools",
+                                long_name = "Scientific research",
+                                comment = "Tools for Writing and Research Support",
+                                icon = "accessories-text-editor", 
+                                overwrite = False):
+    
+    desktop_entry = f"""[Desktop Entry]
+Version=1.0
+Type=Directory
+Name={long_name}
+Comment={comment}
+Icon={icon}
+"""
+    path = os.path.expanduser(f"~/.local/share/desktop-directories/{directory_name}.directory")
+    
+    if not os.path.exists(path) or overwrite == True:  # Evita sobrescrever
+        os.makedirs(os.path.dirname(path), exist_ok=True)
+        with open(path, "w") as f:
+            f.write(desktop_entry)
+        os.chmod(path, 0o755)
+        print(f"File {path} created.")
+    
+def create_desktop_menu(directory_name = "ResearchTools",
+                        basename = "research-tools",
+                        overwrite = False):
+    
+    desktop_entry = f"""<!-- ~/.config/menus/applications-merged/{basename}.menu -->
+<Menu>
+    <Name>Applications</Name>
+    <Menu>
+        <Name>{directory_name}</Name>
+        <Directory>{directory_name}.directory</Directory>
+        <Include>
+            <Category>{directory_name}</Category>
+        </Include>
+    </Menu>
+</Menu>
+"""
+    path = os.path.expanduser(f"~/.config/menus/applications-merged/{basename}.menu")
+    
+    if not os.path.exists(path) or overwrite == True:  # Evita sobrescrever
+        os.makedirs(os.path.dirname(path), exist_ok=True)
+        with open(path, "w") as f:
+            f.write(desktop_entry)
+        print(f"File {path} created.")
+
+if __name__ == '__main__':
+    create_desktop_menu()
+    create_desktop_directory()
+    create_desktop_file()
+

article_introduction_generator/modules/__init__.py

@@ -0,0 +1 @@
+#!/usr/bin/python3

article_introduction_generator/modules/configure.py

@@ -0,0 +1,59 @@
+import os
+import json
+
+def verify_default_config(path,default_content={}):
+    """
+    Cria o arquivo JSON no caminho especificado com conteúdo padrão,
+    criando diretórios intermediários se necessário.
+    """
+
+    # Se o arquivo não existir, cria com o conteúdo padrão
+    if not os.path.exists(path):
+        # Garante que os diretórios existam
+        os.makedirs(os.path.dirname(path), exist_ok=True)
+        with open(path, 'w', encoding='utf-8') as f:
+            json.dump(default_content, f, ensure_ascii=False, indent=4)
+
+
+def merge_defaults(config, defaults):
+    """
+    Adiciona valores de defaults que não existam em config.
+    Funciona recursivamente para dicionários aninhados.
+    """
+    for key, value in defaults.items():
+        if key not in config:
+            config[key] = value
+        elif isinstance(value, dict) and isinstance(config[key], dict):
+            merge_defaults(config[key], value)
+    return config
+
+# Lê o JSON no início do programa
+def load_config(config_path, default_content=None):
+    """
+    Carrega o JSON de configuração e preenche com valores padrão se necessário.
+    """
+    config = {}
+    if os.path.exists(config_path):
+        with open(config_path, 'r', encoding='utf-8') as f:
+            try:
+                config = json.load(f)
+            except json.JSONDecodeError:
+                print("Erro ao ler config, usando defaults")
+                config = {}
+
+    if default_content:
+        config = merge_defaults(config, default_content)
+
+    return config
+
+def save_config(path,content):
+    """
+    Cria o arquivo JSON no caminho especificado com conteúdo padrão,
+    criando diretórios intermediários se necessário.
+    """
+
+    # Garante que os diretórios existam
+    os.makedirs(os.path.dirname(path), exist_ok=True)
+    with open(path, 'w', encoding='utf-8') as f:
+        json.dump(content, f, ensure_ascii=False, indent=4)
+

article_introduction_generator/modules/consult.py

@@ -0,0 +1,72 @@
+
+import json
+from deep_consultation.core import consult_with_deepchat
+
+    
+SYSTEM_PROMPT = """
+You are an expert scientific writer specialized in Q1 Computer Science journals
+(e.g., IEEE TPAMI, CVPR, ICCV, NeurIPS, Elsevier Pattern Recognition).
+
+Your task is to generate the INTRODUCTION section of a research paper.
+
+Strict rules:
+1. You must rely exclusively on the information provided in the user input JSON.
+2. You must NOT invent citations, methods, datasets, claims, or results.
+3. All mentions of prior work must be grounded in the provided
+   related_work.references entries.
+4. The introduction must seamlessly integrate background, state of the art,
+   critical analysis, and motivation.
+5. The tone must match a top-tier Q1 journal: formal, precise, and concise.
+6. No bullet points. No section headers. Only well-structured academic paragraphs.
+7. Do NOT describe the JSON or its structure in the output.
+8. Follow all instructions contained in the "writing_guidelines" field if present.
+9. Do not use exactly the same text sent in JSON, try to use your own words to avoid plagiarism problems.
+
+You must write as a human researcher, not as an assistant.
+
+"""
+
+USER_PROMPT = """
+Using the JSON below, write the complete INTRODUCTION section of the paper.
+
+Structural requirements:
+- Paragraph 1: General context of the topic. 
+  Broad research domain overview and importance
+  (use research_problem.research_domain_overview).
+- Paragraph 2: Specific problem within the topic that the text focuses on.
+  Narrow down to the specific problem and practical challenges
+  (use research_problem.specific_problem and practical_challenges).
+- Paragraphs 3–4: Integrated state of the art discussion.
+  Organize cited works according to their introduction_paragraph_role
+  (foundational → early_state_of_art → recent_advances).
+  Highlight limitations where relevant.
+  Use LaTeX-style bibliographic formatting for citations in the bibliography.
+- Paragraph 5: Synthesize common trends and open problems using
+  related_work.human_curated_synthesis.
+- Final paragraph: Proposed solution of paper. 
+  Explicitly state the research gap and position the paper’s
+  contributions as a response to this gap.
+
+Use the author_intended_summary to guide emphasis and narrative flow.
+Integrate the contributions naturally into the motivation, not as a list.
+
+Here is the JSON input:
+
+"""
+
+def consultation_in_depth(system_data, json_data):
+
+    json_data_string = json.dumps(
+        json_data,
+        ensure_ascii=False,  # mantém acentos
+        indent=2              # deixa bonito e legível
+    )
+    
+    msg = USER_PROMPT + "```json\n" + json_data_string + "\n```"
+    
+    OUT=consult_with_deepchat(  system_data["base_url"],
+                                system_data["api_key"],
+                                system_data["model"],
+                                msg,
+                                SYSTEM_PROMPT)
+    return OUT

article_introduction_generator/modules/wabout.py

@@ -0,0 +1,108 @@
+from PyQt5.QtWidgets import QDialog, QLabel, QPushButton, QVBoxLayout
+from PyQt5.QtGui import QPixmap
+from PyQt5.QtCore import Qt
+                            
+class AboutWindow(QDialog):
+    """About dialog window"""
+    def __init__(self, data, logo_path, parent=None):
+        super().__init__(parent)
+        self.setWindowTitle("About")
+        self.setMinimumSize(500, 300)
+        
+        # Create layout
+        layout = QVBoxLayout(self)
+        
+        # Logo
+        logo_label = QLabel()
+        pixmap = QPixmap(logo_path)
+        pixmap = pixmap.scaled(100, 100, Qt.KeepAspectRatio, Qt.SmoothTransformation)
+        logo_label.setPixmap(pixmap)
+        logo_label.setAlignment(Qt.AlignCenter)
+        layout.addWidget(logo_label)
+        
+        # Description
+        description_label = QLabel(f"<b>{data['description']}</b>")
+        description_label.setWordWrap(True)
+        description_label.setTextInteractionFlags(Qt.TextSelectableByMouse)
+        layout.addWidget(description_label)
+        
+        # Add separator
+        separator = QLabel()
+        separator.setFrameShape(QLabel.HLine)
+        separator.setFrameShadow(QLabel.Sunken)
+        layout.addWidget(separator)
+        
+        # Package info
+        package_label = QLabel(f"Package: {data['package']}")
+        package_label.setTextInteractionFlags(Qt.TextSelectableByMouse)
+        package_label.setAlignment(Qt.AlignLeft)
+        layout.addWidget(package_label)
+        
+        # Program info
+        program_label = QLabel(f"Program: {data['program_name']}")
+        program_label.setTextInteractionFlags(Qt.TextSelectableByMouse)
+        program_label.setAlignment(Qt.AlignLeft)
+        layout.addWidget(program_label)
+        
+        # Version info
+        version_label = QLabel(f"Version: {data['version']}")
+        version_label.setTextInteractionFlags(Qt.TextSelectableByMouse)
+        version_label.setAlignment(Qt.AlignLeft)
+        layout.addWidget(version_label)
+        
+        # Author info
+        author_label = QLabel(f"Author: {data['author']}")
+        author_label.setTextInteractionFlags(Qt.TextSelectableByMouse)
+        author_label.setAlignment(Qt.AlignLeft)
+        layout.addWidget(author_label)
+        
+        # Email info
+        email_label = QLabel(f"Email: <a href=\"mailto:{data['email']}\">{data['email']}</a>")
+        email_label.setTextInteractionFlags(Qt.TextSelectableByMouse| Qt.LinksAccessibleByMouse)
+        email_label.setOpenExternalLinks(True)
+        email_label.setAlignment(Qt.AlignLeft)
+        layout.addWidget(email_label)
+        
+        # Add another separator
+        separator2 = QLabel()
+        separator2.setFrameShape(QLabel.HLine)
+        separator2.setFrameShadow(QLabel.Sunken)
+        layout.addWidget(separator2)
+        
+        # Source URL
+        source_label = QLabel(f"Source: <a href=\"{data['url_source']}\">{data['url_source']}</a>")
+        source_label.setTextInteractionFlags(Qt.TextSelectableByMouse| Qt.LinksAccessibleByMouse)
+        source_label.setOpenExternalLinks(True)
+        source_label.setAlignment(Qt.AlignLeft)
+        layout.addWidget(source_label)
+        
+        # Doc URL
+        doc_label = QLabel(f"Documentation: <a href=\"{data['url_doc']}\">{data['url_doc']}</a>")
+        doc_label.setTextInteractionFlags(Qt.TextSelectableByMouse| Qt.LinksAccessibleByMouse)
+        doc_label.setOpenExternalLinks(True)
+        doc_label.setAlignment(Qt.AlignLeft)
+        layout.addWidget(doc_label)
+        
+        # Funding URL
+        funding_label = QLabel(f"Funding: <a href=\"{data['url_funding']}\">{data['url_funding']}</a>")
+        funding_label.setTextInteractionFlags(Qt.TextSelectableByMouse| Qt.LinksAccessibleByMouse)
+        funding_label.setOpenExternalLinks(True)
+        funding_label.setAlignment(Qt.AlignLeft)
+        layout.addWidget(funding_label)
+        
+        # Bugs URL
+        bugs_label = QLabel(f"Bugs: <a href=\"{data['url_bugs']}\">{data['url_bugs']}</a>")
+        bugs_label.setTextInteractionFlags(Qt.TextSelectableByMouse| Qt.LinksAccessibleByMouse)
+        bugs_label.setOpenExternalLinks(True)
+        bugs_label.setAlignment(Qt.AlignLeft)
+        layout.addWidget(bugs_label)
+        
+        # OK Button
+        ok_button = QPushButton("OK")
+        ok_button.clicked.connect(self.accept)
+        layout.addWidget(ok_button)
+
+def show_about_window(data, logo_path):
+    dialog = AboutWindow(data, logo_path)
+    dialog.exec_()
+