Feature/1 - Running The Scripts

dist/clean_env_before_mining.py

@@ -37,8 +37,8 @@ def clean_directory_content(script_dir: str, directory: str) -> None:
         shutil.rmtree(directory_path)
 
 
-if __name__ == "__main__":
-    print("Data mining for Living Documentation started")
+def clean_environment():
+    print("Cleaning of env for Living Documentation started")
 
     # Get the directory of the current script
     script_dir = os.path.dirname(os.path.abspath(__file__))
@@ -50,4 +50,10 @@ def clean_directory_content(script_dir: str, directory: str) -> None:
     # Clean the output directory
     clean_directory_content(script_dir, MARKDOWN_PAGE_DIRECTORY)
 
-    print("Data mining for Living Documentation ended")
+    print("Cleaning of env for Living Documentation ended")
+
+
+if __name__ == "__main__":
+    clean_environment()
+    # TODO - move dir variables definition to the controlling script - add them to the env_vars
+    #  - to able to provide them to all rest scripts #Issue: https://github.com/AbsaOSS/living-doc-generator/issues/4

dist/controller.py

@@ -2,7 +2,7 @@
 import subprocess
 import argparse
 import sys
-import re
+from clean_env_before_mining import clean_environment
 
 
 def extract_args():
@@ -48,24 +48,20 @@ def main():
     print("Extracting arguments from command line.")
     env_vars = extract_args()
 
-    # Clean environment before mining
     print("Data mining for Living Documentation")
-    run_script('clean_env_before_mining.py', env_vars)
+
+    clean_environment()
 
     # Data mine GitHub features from repository
-    print("Downloading issues from GitHub")
     run_script('github_query_issues.py', env_vars)
 
     # Data mine GitHub project's state
-    print("Downloading project's state")
     run_script('github_query_project_state.py', env_vars)
 
     # Consolidate all feature data together
-    print("Consolidating mined feature data")
     run_script('consolidate_feature_data.py', env_vars)
 
     # Generate markdown pages
-    print("Converting features to markdown pages")
     run_script('convert_features_to_pages.py', env_vars)
 
 

src/clean_env_before_mining.py

@@ -37,7 +37,7 @@ def clean_directory_content(script_dir: str, directory: str) -> None:
         shutil.rmtree(directory_path)
 
 
-def clean_environment(env_vars):
+def clean_environment():
     print("Cleaning of env for Living Documentation started")
 
     # Get the directory of the current script
@@ -54,8 +54,6 @@ def clean_environment(env_vars):
 
 
 if __name__ == "__main__":
-    import sys
-    env_vars = sys.argv[1:]
-    clean_environment(env_vars)
+    clean_environment()
     # TODO - move dir variables definition to the controlling script - add them to the env_vars
     #  - to able to provide them to all rest scripts #Issue: https://github.com/AbsaOSS/living-doc-generator/issues/4

src/controller.py

@@ -50,7 +50,7 @@ def main():
 
     print("Data mining for Living Documentation")
 
-    clean_environment(env_vars)
+    clean_environment()
 
     # Data mine GitHub features from repository
     run_script('github_query_issues.py', env_vars)