lupin-danquin 0.0.1.dev1__tar.gz → 0.0.1.dev2__tar.gz

{lupin-danquin-0.0.1.dev1 → lupin-danquin-0.0.1.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lupin-danquin
-Version: 0.0.1.dev1
+Version: 0.0.1.dev2
 Summary: Testing - Documentation
 License: MIT License
 Keywords: documentation,testing

lupin-danquin-0.0.1.dev2/lupin_danquin/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1.dev2"

lupin-danquin-0.0.1.dev2/lupin_danquin/__main__.py

@@ -0,0 +1,5 @@
+from lupin_danquin import run
+
+
+if __name__ == "__main__":
+    run.cli()

lupin-danquin-0.0.1.dev2/lupin_danquin/core/tools/utils.py

@@ -0,0 +1,69 @@
+from typing import List
+import logging
+import os
+import re
+import sys
+
+
+def must_get_string_value_from_env_var(var_name: str):
+    """Get a string value from an environment variable.
+    Args:
+        var_name (str): The name of the environment variable.
+    Returns:
+        str: The value of the environment variable.
+    Logs:
+        Error: If the environment {var_name} variable is not set.
+        sys.exit(1)
+    """
+    if not os.getenv(var_name):
+        logging.error(f"Environment variable {var_name} is not set.")
+        sys.exit(1)
+    return os.getenv(var_name)
+
+
+def configure_logging():
+    logging.basicConfig(
+        format="%(asctime)s %(levelname)s: %(message)s", level=logging.INFO
+    )
+
+
+def die(msg: str) -> None:
+    logging.error(msg)
+    sys.exit(1)
+
+
+def info(msg: str) -> None:
+    logging.info(msg)
+
+
+def get_version():
+    """get version from setup.cfg file and
+    update __version__ in lupin_danquin.__init__.py
+    """
+    with open("setup.cfg", "r", encoding="utf-8") as f:
+        setup_cfg = f.read()
+    print(setup_cfg)
+    _version = re.search(
+        r"(^version = )(\d{1,2}\.\d{1,2}\.\d{1,2})(\.[a-z]{1,})?(\d{1,2})?",
+        setup_cfg,
+        re.MULTILINE,
+    )
+    version = ""
+    for group in _version.group(2, 3, 4):
+        if group is not None:
+            version = version + str(group)
+    content = f'__version__ = "{version}"\n'
+
+    with open("lupin_danquin/__init__.py", "w", encoding="utf-8") as outfile:
+        outfile.write(content)
+    return version
+
+
+def convert_application_name_to_list(application_name: str) -> List:
+    """Convert application name to list.
+    Args:
+        application_name (str): The name of the application.
+    Returns:
+        list: The list of the application name.
+    """
+    return [app.strip() for app in application_name.split(",") if app.strip()]

lupin-danquin-0.0.1.dev2/lupin_danquin/core/val3_doc_generator/val3_doc_generator.py

@@ -0,0 +1,94 @@
+from typing import Any, Dict, List
+import codecs
+import os
+
+from jinja2 import (
+    Environment,
+    FileSystemLoader,
+    select_autoescape,
+    Template,
+    TemplateNotFound,
+    TemplateError,
+    TemplateRuntimeError,
+)
+
+from lupin_danquin.core.application import Application
+from lupin_danquin.core.tools.utils import die, info
+
+
+class Val3Documentation:
+    USR_APP_DIR = "usrapp"
+
+    def _find_usrapp_dir(self) -> str:
+        """Find the usrapp directory"""
+        for dirpath, dirnames, filenames in os.walk(os.getcwd()):
+            if self.USR_APP_DIR in dirnames:
+                return os.path.join(dirpath, self.USR_APP_DIR)
+        die(msg=f"'{self.USR_APP_DIR}' directory not found")
+
+    def _get_informations_from_applications(
+        self, application_names: List
+    ) -> List[Dict[str, Any]]:
+        """Get all informations from applications"""
+
+        apps_information = []
+        base_program_path = self._find_usrapp_dir() + os.sep
+        print(f"base_program_path: {base_program_path}")
+        for application_name in application_names:
+            program_path = base_program_path + application_name
+            apps_information.append(
+                Application(
+                    program_path, application_name
+                ).get_all_information_from_app()
+            )
+        return apps_information
+
+    def _read_begining_of_file(self) -> str:
+        with codecs.open(
+            "lupin_danquin/assets/BeginingOfFile.md", encoding="utf-8"
+        ) as f:
+            result = f.read()
+        return result
+
+    def _read_end_of_file(self) -> str:
+        with codecs.open("lupin_danquin/assets/EndOfFile.md", encoding="utf-8") as f:
+            result = f.read()
+        return result
+
+    def _get_local_template(self) -> Template:
+        try:
+            # Create jinja2 environment
+            env = Environment(
+                loader=FileSystemLoader("lupin_danquin/templates"),
+                autoescape=select_autoescape(),
+                trim_blocks=True,
+                lstrip_blocks=True,
+            )
+            # Charge template
+            template = env.get_template("val3_documentation_md.j2")
+            return template
+        except TemplateNotFound:
+            die(
+                msg="Template 'lupin_danquin/templates/val3_documentation_md.j2 not found"
+            )
+
+    def generate_markdown(self, applications_list: List) -> None:
+        """Generate the documentation"""
+        info(msg="Get informations from VAL3 applications")
+        context = {
+            "begining_of_file": self._read_begining_of_file(),
+            "end_of_file": self._read_end_of_file(),
+            "applications": self._get_informations_from_applications(applications_list),
+        }
+
+        template = self._get_local_template()
+        try:
+            content = template.render(context)
+        except (TemplateError, TemplateRuntimeError) as e:
+            die(msg=f"Error rendering Jinja2 template: {e}")
+
+        with codecs.open(
+            "lupin_danquin/val3_documentation.md", "w", encoding="utf-8"
+        ) as f:
+            f.write(content)
+        info(msg="Documentation generated")

lupin-danquin-0.0.1.dev2/lupin_danquin/run.py

@@ -0,0 +1,48 @@
+from typing import Optional
+
+from dotenv import load_dotenv
+import typer
+
+from lupin_danquin.core.tools.utils import (
+    configure_logging,
+    convert_application_name_to_list,
+    must_get_string_value_from_env_var,
+)
+from lupin_danquin.core.val3_doc_generator.val3_doc_generator import Val3Documentation
+from lupin_danquin.__init__ import __version__
+
+
+load_dotenv()
+
+
+cli = typer.Typer()
+
+
+@cli.command(help="Print version")
+def version():
+    print(f"Version: {__version__}")
+
+
+@cli.command()
+def val_docs(
+    application_names: Optional[str] = typer.Argument(
+        ...,
+        help="Name of applications to be documented. Ex: 'app1,app2,app3'",
+        envvar="VAL3_APPLICATIONS",
+    )
+):
+    """
+    Generate documentation from VAL3 applications in usrapp directory.
+    You can specify the applications to be documented in the 'danq val-docs' command
+    or by setting the VAL3_APPLICATIONS environment variable.
+    :param application_names: Name of applications to be documented. Ex: app1,app2,app3
+    :type application_names: str
+
+    :example: danq val_docs "App1,App2"
+    """
+    if not application_names:
+        application_names = must_get_string_value_from_env_var("VAL3_APPLICATIONS")
+
+    configure_logging()
+    applications_list = convert_application_name_to_list(application_names)
+    Val3Documentation().generate_markdown(applications_list=applications_list)

{lupin-danquin-0.0.1.dev1 → lupin-danquin-0.0.1.dev2}/lupin_danquin.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lupin-danquin
-Version: 0.0.1.dev1
+Version: 0.0.1.dev2
 Summary: Testing - Documentation
 License: MIT License
 Keywords: documentation,testing

{lupin-danquin-0.0.1.dev1 → lupin-danquin-0.0.1.dev2}/lupin_danquin.egg-info/SOURCES.txt

@@ -3,17 +3,18 @@ README.md
 setup.cfg
 setup.py
 lupin_danquin/__init__.py
+lupin_danquin/__main__.py
 lupin_danquin/check_coding_rules.py
-lupin_danquin/documentation_extraction.py
+lupin_danquin/run.py
 lupin_danquin.egg-info/PKG-INFO
 lupin_danquin.egg-info/SOURCES.txt
 lupin_danquin.egg-info/dependency_links.txt
+lupin_danquin.egg-info/entry_points.txt
 lupin_danquin.egg-info/not-zip-safe
 lupin_danquin.egg-info/requires.txt
 lupin_danquin.egg-info/top_level.txt
 lupin_danquin/core/__init__.py
 lupin_danquin/core/application.py
-lupin_danquin/core/external_resources.py
 lupin_danquin/core/global_variable.py
 lupin_danquin/core/line_ended.py
 lupin_danquin/core/local_variable.py

lupin-danquin-0.0.1.dev2/lupin_danquin.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+danq = lupin_danquin.run:cli

{lupin-danquin-0.0.1.dev1 → lupin-danquin-0.0.1.dev2}/lupin_danquin.egg-info/requires.txt

@@ -1,5 +1,5 @@
-typer[all]==0.7.0
-python-dotenv==1.0.0
+typer[all]==0.6.1
+python-dotenv==0.21.0
 Jinja2==3.1.2
 
 [test]

{lupin-danquin-0.0.1.dev1 → lupin-danquin-0.0.1.dev2}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = lupin-danquin
-version = 0.0.1.dev1
+version = 0.0.1.dev2
 description = Testing - Documentation
 long_description = Test VAL3 code and generate documentation from it
 keywords = documentation, testing
@@ -19,10 +19,14 @@ include_package_data = True
 packages = find:
 python_requires = >=3.10
 install_requires = 
-	typer[all]==0.7.0
-	python-dotenv==1.0.0
+	typer[all]==0.6.1
+	python-dotenv==0.21.0
 	Jinja2==3.1.2
 
+[options.entry_points]
+console_scripts = 
+	danq = lupin_danquin.run:cli
+
 [options.extras_require]
 test = 
 	pytest==7.2.2

lupin-danquin-0.0.1.dev1/lupin_danquin/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.0.1.dev1"

lupin-danquin-0.0.1.dev1/lupin_danquin/core/external_resources.py

@@ -1,18 +0,0 @@
-import codecs
-import os
-
-
-def read_begining_of_file() -> str:
-    result = ""
-    path = os.path.dirname(__file__) + os.sep + ".." + os.sep + "assets" + os.sep
-    with codecs.open(path + "BeginingOfFile.md", encoding="utf-8") as f:
-        result = f.read()
-    return result
-
-
-def read_end_of_file() -> str:
-    result = ""
-    path = os.path.dirname(__file__) + os.sep + ".." + os.sep + "assets" + os.sep
-    with codecs.open(path + "EndOfFile.md", encoding="utf-8") as f:
-        result = f.read()
-    return result

lupin-danquin-0.0.1.dev1/lupin_danquin/core/tools/utils.py

@@ -1,37 +0,0 @@
-import logging
-import re
-import sys
-
-
-def configure_logging():
-    logging.basicConfig(
-        format="%(asctime)s %(levelname)s: %(message)s", level=logging.INFO
-    )
-
-
-def die(msg: str) -> None:
-    logging.error(msg)
-    sys.exit(1)
-
-
-def get_version():
-    """get version from setup.cfg file and
-    update __version__ in lupin_danquin.__init__.py
-    """
-    with open("setup.cfg", "r", encoding="utf-8") as f:
-        setup_cfg = f.read()
-    print(setup_cfg)
-    _version = re.search(
-        r"(^version = )(\d{1,2}\.\d{1,2}\.\d{1,2})(\.[a-z]{1,})?(\d{1,2})?",
-        setup_cfg,
-        re.MULTILINE,
-    )
-    version = ""
-    for group in _version.group(2, 3, 4):
-        if group is not None:
-            version = version + str(group)
-    content = f'__version__ = "{version}"\n'
-
-    with open("lupin_danquin/__init__.py", "w", encoding="utf-8") as outfile:
-        outfile.write(content)
-    return version

lupin-danquin-0.0.1.dev1/lupin_danquin/core/val3_doc_generator/val3_doc_generator.py

@@ -1,45 +0,0 @@
-import codecs
-
-from jinja2 import (
-    Environment,
-    FileSystemLoader,
-    select_autoescape,
-    Template,
-    TemplateNotFound,
-    TemplateError,
-    TemplateRuntimeError,
-)
-
-from core.tools.utils import die
-
-
-class Val3Documentation:
-    def _get_local_template(self) -> Template:
-        try:
-            # Create jinja2 environment
-            env = Environment(
-                loader=FileSystemLoader("lupin_danquin/templates"),
-                autoescape=select_autoescape(),
-                trim_blocks=True,
-                lstrip_blocks=True,
-            )
-            # Charge template
-            template = env.get_template("val3_documentation_md.j2")
-            return template
-        except TemplateNotFound:
-            print(
-                "Template 'lupin_danquin/templates/val3_documentation_md.j2 not found"
-            )
-
-    def generate_markdown(self, context={}) -> None:
-        """Generate the documentation"""
-        template = self._get_local_template()
-        try:
-            content = template.render(context)
-        except (TemplateError, TemplateRuntimeError) as e:
-            die(msg=f"Error rendering Jinja2 template: {e}")
-
-        with codecs.open(
-            "lupin_danquin/val3_documentation.md", "w", encoding="utf-8"
-        ) as f:
-            f.write(content)

lupin-danquin-0.0.1.dev1/lupin_danquin/documentation_extraction.py

@@ -1,54 +0,0 @@
-import os
-
-from core.application import Application
-from core.external_resources import read_begining_of_file, read_end_of_file
-from core.tools.utils import configure_logging, die
-from core.val3_doc_generator.val3_doc_generator import Val3Documentation
-
-
-APPLICATION_NAMES = [
-    "TaskManager",
-    "Watchdog",
-]
-USR_APP_DIR = "usrapp"
-
-
-def find_usrapp_dir() -> str:
-    """Find the usrapp directory"""
-    for dirpath, dirnames, filenames in os.walk(os.getcwd()):
-        if USR_APP_DIR in dirnames:
-            return os.path.join(dirpath, USR_APP_DIR)
-    die(msg=f"'{USR_APP_DIR}' directory not found")
-
-
-def get_informations_from_applications() -> list:
-    """Get all informations from applications"""
-
-    apps_information = []
-    base_program_path = find_usrapp_dir() + os.sep
-
-    for application_name in APPLICATION_NAMES:
-        program_path = base_program_path + application_name
-        apps_information.append(
-            Application(program_path, application_name).get_all_information_from_app()
-        )
-
-    return apps_information
-
-
-def main() -> None:
-    """Main function"""
-
-    configure_logging()
-
-    context = {
-        "begining_of_file": read_begining_of_file(),
-        "end_of_file": read_end_of_file(),
-        "applications": get_informations_from_applications(),
-    }
-
-    Val3Documentation().generate_markdown(context=context)
-
-
-if __name__ == "__main__":
-    main()