✨ vuegen pkg - package can be imported

- relative import except in main script (will be renamed __main__ and added as an entry point)

Author: enryH

README.md

@@ -34,16 +34,24 @@ Also, the class diagram for the project is presented below to illustrate the arc
 </p>
 
 ## Installation
-......
+
+You can install the package for development from this repository by running the following command:
+
+```bash
+pip install -e path/to/vuegen # specify location 
+pip install -e . # in case you pwd is in the vuegen directory
+```
 
 ## Execution
-``` shell
+
+```bash
 python vuegen/main.py --config report_config_micw2graph.yaml --report_type streamlit 
 ```
+
 The current report types are streamlit, html, pdf, docx, odt, revealjs, pptx, and jupyter.
 
 ## Contact
 If you have comments or suggestions about this project, you can [open an issue][issues] in this repository.
 
 [issues]: https://github.com/Multiomics-Analytics-Group/vuegen/issues/new
-[streamlit]: https://streamlit.io/ 
+[streamlit]: https://streamlit.io/ 

pyproject.toml

@@ -1,10 +1,11 @@
 [tool.poetry]
-name = "report-generator"
+name = "vuegen"
 version = "0.1.0"
 description = "Module to generate automatic web interface reports with visualizations"
 authors = ["MoNA group"]
 license = "MIT"
 readme = "README.md"
+repository = "https://github.com/Multiomics-Analytics-Group/vuegen"
 
 [tool.poetry.dependencies]
 python = ">=3.9,<3.9.7 || >3.9.7,<4.0"

vuegen/__init__.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__ = version("vuegen")

vuegen/config_manager.py

@@ -1,5 +1,6 @@
-import report as r
-from utils import get_logger, assert_enum_value
+from . import report as r
+from .utils import assert_enum_value, get_logger
+
 
 class ConfigManager:
     """
@@ -260,4 +261,4 @@ def _create_chatbot_component(self, component_data: dict) -> r.ChatBot:
             caption = component_data.get('caption'),
             headers = component_data.get('headers'),
             params = component_data.get('params')
-        )
+        )

vuegen/main.py

@@ -1,5 +1,5 @@
-import report_generator
-from utils import get_logger, load_yaml_config, get_args
+from vuegen import report_generator
+from vuegen.utils import get_args, get_logger, load_yaml_config
 
 if __name__ == '__main__':
     # Parse command-line arguments

vuegen/quarto_reportview.py

@@ -1,10 +1,13 @@
 import os
 import subprocess
-import report as r
 from typing import List
+
 import networkx as nx
 import pandas as pd
-from utils import create_folder, is_url
+
+from . import report as r
+from .utils import create_folder, is_url
+
 
 class QuartoReportView(r.ReportView):
     """

vuegen/report.py

@@ -1,17 +1,19 @@
+import json
+import logging
 import os
 from abc import ABC, abstractmethod
 from dataclasses import dataclass, field
-from typing import ClassVar
 from enum import StrEnum, auto
-from typing import List, Optional
+from typing import ClassVar, List, Optional
+
+import matplotlib.pyplot as plt
 import networkx as nx
 import pandas as pd
-import logging
 import requests
-import json
-import matplotlib.pyplot as plt
 from pyvis.network import Network
-from utils import cyjs_to_networkx, pyvishtml_to_networkx, fetch_file_stream
+
+from .utils import cyjs_to_networkx, fetch_file_stream, pyvishtml_to_networkx
+
 
 class ReportType(StrEnum):
     STREAMLIT = auto()

vuegen/report_generator.py

@@ -1,10 +1,12 @@
-from streamlit_reportview import StreamlitReportView
-from quarto_reportview import QuartoReportView
-from config_manager import ConfigManager
-from utils import assert_enum_value
-from report import ReportType
 import logging
 
+from .config_manager import ConfigManager
+from .quarto_reportview import QuartoReportView
+from .report import ReportType
+from .streamlit_reportview import StreamlitReportView
+from .utils import assert_enum_value
+
+
 def get_report(config: dict, report_type: str, logger: logging.Logger) -> None:
     """
     Generate and run a report based on the specified engine.
@@ -45,4 +47,4 @@ def get_report(config: dict, report_type: str, logger: logging.Logger) -> None:
             report_type=report_type
         )
         quarto_report.generate_report()
-        quarto_report.run_report()
+        quarto_report.run_report()

vuegen/streamlit_reportview.py

@@ -1,9 +1,12 @@
-import report as r
 import os
 import subprocess
 from typing import List
+
 import pandas as pd
-from utils import create_folder, is_url
+
+from . import report as r
+from .utils import create_folder, is_url
+
 
 class StreamlitReportView(r.WebAppReportView):
     """
@@ -658,4 +661,4 @@ def _generate_component_imports(self, component: r.Component) -> List[str]:
             component_imports.extend(components_imports['chatbot'])
 
         # Return the list of import statements
-        return component_imports     
+        return component_imports