primitive 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

primitive/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2024-present Dylan Stein <dylan@steins.studio>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.1.2"
+__version__ = "0.1.4"

primitive/lint/actions.py

@@ -1,6 +1,67 @@
+from pathlib import Path
 from primitive.utils.actions import BaseAction
+import subprocess
+from typing import Tuple
+from loguru import logger
+from ..utils.files import find_files_for_extension
+from ..utils.verible import install_verible
 
 
 class Lint(BaseAction):
-    def run_lint(self):
-        print("lint 100%")
+    def execute(self, source: Path = Path.cwd()) -> Tuple[bool, str]:
+        logger.debug("Starting linter...")
+        files = find_files_for_extension(source, ".sv")
+        if not files:
+            message = "No files found to lint."
+            logger.warning(message)
+            return False, message
+
+        logger.debug("Checking if verible is installed")
+        try:
+            subprocess.run(["verible-verilog-lint", "--version"], capture_output=True)
+        except FileNotFoundError:
+            logger.debug("Did not find verible. Installing...")
+            try:
+                system_info = self.primitive.hardware.get_system_info()
+                install_verible(system_info=system_info)
+            except Exception as exception:
+                message = f"Failed to install verible. {exception}"
+                logger.error(message)
+                return False, message
+
+        try:
+            subprocess.run(["verible-verilog-lint", "--version"], capture_output=True)
+        except FileNotFoundError:
+            message = "Verible is not installed. Please install it to run lint."
+            logger.error(message)
+            return False, message
+
+        # TODO:
+        # run is great for now! we will need to switch to Popen if we want to stream the output
+        logger.debug("Running linter...")
+        result = subprocess.run(
+            ["verible-verilog-lint", *files],
+            capture_output=True,
+            text=True,
+        )
+
+        logger.debug("Linting complete.")
+
+        message = ""
+        if self.primitive.DEBUG:
+            if result.stderr:
+                logger.error("\n" + result.stderr)
+            if result.stdout:
+                logger.info("\n" + result.stdout)
+            message = "See above logs for linter output."
+        else:
+            message = result.stderr
+
+        if result.returncode != 0:
+            if not self.primitive.DEBUG:
+                message = result.stderr
+            return (False, message)
+        else:
+            message = "Linting successful."
+
+        return True, message

primitive/lint/commands.py

@@ -1,7 +1,7 @@
 import click
-
-
+from pathlib import Path
 import typing
+from ..utils.printer import print_result
 
 if typing.TYPE_CHECKING:
     from ..client import Primitive
@@ -9,7 +9,9 @@ if typing.TYPE_CHECKING:
 
 @click.command("lint")
 @click.pass_context
-def cli(context):
+@click.argument("source", type=click.Path(exists=True), default=".")
+def cli(context, source: str):
     """Lint"""
     primitive: Primitive = context.obj.get("PRIMITIVE")
-    primitive.lint.run_lint()
+    result, message = primitive.lint.execute(source=Path(source))
+    print_result(message=message, context=context)

primitive/utils/files.py

@@ -0,0 +1,16 @@
+from typing import List, Tuple
+from pathlib import Path
+from loguru import logger
+
+
+def find_files_for_extension(source: Path, extensions: Tuple[str]) -> List[Path]:
+    matching_files = []
+    logger.debug(f"Looking for files at {source} with extensions {extensions}")
+    for dirpath, dirnames, filenames in source.walk():
+        for filename in filenames:
+            if filename.endswith(extensions):
+                matching_files.append(dirpath.joinpath(filename))
+    logger.debug(
+        f"Found {len(matching_files)} following files that match: {matching_files}"
+    )
+    return matching_files

primitive/utils/printer.py

@@ -7,7 +7,7 @@ from loguru import logger
 def print_result(message: str, context: click.Context, fg: str = None):
     """Print message to stdout or stderr"""
     if context.obj["DEBUG"]:
-        logger.debug(json.dumps(message))
+        logger.info(json.dumps(message))
     else:
         if context.obj["JSON"]:
             message = json.dumps(message, indent=2)

primitive/utils/shell.py

@@ -0,0 +1,63 @@
+from pathlib import Path
+import subprocess
+
+
+def add_path_to_shell(path: Path):
+    try:
+        subprocess.run(["fish_add_path", path], capture_output=True)
+        return True
+    except FileNotFoundError:
+        pass
+
+    if Path.home() / ".bash_profile":
+        subprocess.run(
+            [
+                "echo",
+                f"'export PATH={path}:$PATH'",
+                ">>",
+                "~/.bash_profile",
+            ],
+            capture_output=True,
+        )
+    elif Path.home() / ".bashrc":
+        subprocess.run(
+            [
+                "echo",
+                f"'export PATH={path}:$PATH'",
+                ">>",
+                "~/.bashrc",
+            ],
+            capture_output=True,
+        )
+    elif Path.home() / ".zshrc":
+        subprocess.run(
+            [
+                "echo",
+                f"'export PATH={path}:$PATH'",
+                ">>",
+                "~/.zshrc",
+            ],
+            capture_output=True,
+        )
+    elif Path.home() / ".profile":
+        subprocess.run(
+            [
+                "echo",
+                f"'export PATH={path}:$PATH'",
+                ">>",
+                "~/.profile",
+            ],
+            capture_output=True,
+        )
+    elif Path.home() / ".bash_login":
+        subprocess.run(
+            [
+                "echo",
+                f"'export PATH={path}:$PATH'",
+                ">>",
+                "~/.bash_login",
+            ],
+            capture_output=True,
+        )
+    else:
+        raise Exception(f"Failed to add {path} to PATH")

primitive/utils/verible.py

@@ -0,0 +1,51 @@
+import tarfile
+import requests
+from .shell import add_path_to_shell
+from pathlib import Path
+
+from loguru import logger
+
+
+VERIBLE_MAC_OS_LINK = "https://github.com/chipsalliance/verible/releases/download/v0.0-3752-g8b64887e/verible-v0.0-3752-g8b64887e-macOS.tar.gz"
+VERIBLE_WINDOWS_64_OS_LINK = "https://github.com/chipsalliance/verible/releases/download/v0.0-3752-g8b64887e/verible-v0.0-3752-g8b64887e-win64.zip"
+VERIBLE_LINUX_X86_64_OS_LINK = "https://github.com/chipsalliance/verible/releases/download/v0.0-3752-g8b64887e/verible-v0.0-3752-g8b64887e-linux-static-x86_64.tar.gz"
+VERIBLE_LINUX_ARM64_LINK = "https://github.com/chipsalliance/verible/releases/download/v0.0-3752-g8b64887e/verible-v0.0-3752-g8b64887e-linux-static-arm64.tar.gz"
+
+
+def install_verible(system_info: dict) -> bool:
+    url = None
+    if system_info.get("os_family") == "Darwin":
+        url = VERIBLE_MAC_OS_LINK
+    elif system_info.get("os_family") == "Windows":
+        url = VERIBLE_WINDOWS_64_OS_LINK
+    elif system_info.processor == "x86_64":
+        url = VERIBLE_LINUX_X86_64_OS_LINK
+    elif system_info.processor == "arm":
+        url = VERIBLE_LINUX_X86_64_OS_LINK
+
+    verible_dir_name = url.split("/")[-1].split(".tar.gz")[0]
+    file_download_path = Path.home() / f"{verible_dir_name}.tar.gz"
+
+    logger.debug("Downloading verible")
+    response = requests.get(url, stream=True)
+    if response.status_code == 200:
+        with open(file_download_path, "wb") as file:
+            file.write(response.raw.read())
+    else:
+        raise Exception(
+            f"Failed to download verible. {response.status_code}. {response.text}"
+        )
+
+    logger.debug("Untaring verible")
+    with tarfile.open(file_download_path) as tar:
+        tar.extractall(Path.home())
+
+    logger.debug("Deleting tar.gz artifact")
+    file_download_path.unlink()
+
+    verible_bin = Path.home() / verible_dir_name / "bin"
+
+    logger.debug("Adding verible to PATH")
+    add_path_to_shell(verible_bin)
+
+    return True

{primitive-0.1.2.dist-info → primitive-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: primitive
-Version: 0.1.2
+Version: 0.1.4
 Project-URL: Documentation, https://github.com//primitivecorp/primitive-cli#readme
 Project-URL: Issues, https://github.com//primitivecorp/primitive-cli/issues
 Project-URL: Source, https://github.com//primitivecorp/primitive-cli

{primitive-0.1.2.dist-info → primitive-0.1.4.dist-info}/RECORD

@@ -1,4 +1,4 @@
-primitive/__about__.py,sha256=-cDaoH25zZk42p51RdJ-K5fLmfLdYLlAzU6Svg3Twtw,128
+primitive/__about__.py,sha256=E2SXPkbuFZByKB4zIeOf_Me_bVBs-mUA8TpF7fO1FrM,128
 primitive/__init__.py,sha256=bwKdgggKNVssJFVPfKSxqFMz4IxSr54WWbmiZqTMPNI,106
 primitive/cli.py,sha256=QC4jbu8s0uhNxFmaTO2B-X1o1gpyFX3xJVHU-j5CvQE,1705
 primitive/client.py,sha256=cZiJjzZ4HkCtYViDNOIoNuf7mcp772eSCSztsqh381E,2010
@@ -11,19 +11,22 @@ primitive/graphql/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU
 primitive/graphql/sdk.py,sha256=BhCGmDtc4sNnH8CxbQSJyFwOZ-ZSqMtjsxMB3JRBhPw,1456
 primitive/hardware/actions.py,sha256=BbFz17NKVDiI-9SiV1R1GPqsXRZwUm9oNj-Dc_bBFJ8,17133
 primitive/hardware/commands.py,sha256=QE7LLeFdfOqlvz3JwdwJJRZAY3fHI1zB9kYmmDajpq0,1477
-primitive/lint/actions.py,sha256=O6XfKA9cgl0nj-BxcWfH2GTTuCND5A_tjwjYOj3zljE,124
-primitive/lint/commands.py,sha256=BXCp5CW2ibsk-dLe0FQ1xH3pga-Agzai0QmdNH1vaHo,254
+primitive/lint/actions.py,sha256=FVigksFrADPDD3zHS0g0riyVrge7eEtwWk5PG2aZv9A,2352
+primitive/lint/commands.py,sha256=3CZvkOEMpJspJWmaQzA5bpPKx0_VCijQIXA9l-eTnZE,487
 primitive/projects/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 primitive/projects/actions.py,sha256=Zi0uFCUG5KU7w7HNE8eGlhUPdsJyjVrakcdU1PR8-MQ,1481
 primitive/simulations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 primitive/simulations/actions.py,sha256=YR0oxxd7_kuUIH77BWZLUs9rLRiSJztPPhpgDJU2PbY,1267
 primitive/utils/actions.py,sha256=HOFrmM3-0A_A3NS84MqrZ6JmQEiiPSoDqEeuu6b_qfQ,196
 primitive/utils/config.py,sha256=DlFM5Nglo22WPtbpZSVtH7NX-PTMaKYlcrUE7GPRG4c,1058
+primitive/utils/files.py,sha256=Ug5UqrS9eZoTd08EFtgyyp8flsJTfsG9CwXBWmI-yFA,606
 primitive/utils/git.py,sha256=1qNOu8X-33CavmrD580BmrFhD_WVO9PGWHUUboXJR_g,663
 primitive/utils/memory_size.py,sha256=4xfha21kW82nFvOTtDFx9Jk2ZQoEhkfXii-PGNTpIUk,3058
-primitive/utils/printer.py,sha256=EXJnWWyFDrACnxHa7jtT_fXrSQoJUu1ZXOF05Y1hCaA,371
-primitive-0.1.2.dist-info/METADATA,sha256=ngX3kaLW5fY6Ze_ThcZ5SExZcDtaezbpS4zC-_KvyDo,1642
-primitive-0.1.2.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-primitive-0.1.2.dist-info/entry_points.txt,sha256=p1K8DMCWka5FqLlqP1sPek5Uovy9jq8u51gUsP-z334,48
-primitive-0.1.2.dist-info/licenses/LICENSE.txt,sha256=B8kmQMJ2sxYygjCLBk770uacaMci4mPSoJJ8WoDBY_c,1098
-primitive-0.1.2.dist-info/RECORD,,
+primitive/utils/printer.py,sha256=f1XUpqi5dkTL3GWvYRUGlSwtj2IxU1q745T4Fxo7Tn4,370
+primitive/utils/shell.py,sha256=xGsz3-3mmUP5xRrFotNj0UpbHmRSsiliQnyPzB48xLI,1567
+primitive/utils/verible.py,sha256=o2NBbqteePgFY-28S7AaEivSEszZcePFkMRXpg_XhHg,1990
+primitive-0.1.4.dist-info/METADATA,sha256=bW4QfYYNW6TWBazUnmjK3s7see0nYczt4UHcyupynYw,1642
+primitive-0.1.4.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+primitive-0.1.4.dist-info/entry_points.txt,sha256=p1K8DMCWka5FqLlqP1sPek5Uovy9jq8u51gUsP-z334,48
+primitive-0.1.4.dist-info/licenses/LICENSE.txt,sha256=B8kmQMJ2sxYygjCLBk770uacaMci4mPSoJJ8WoDBY_c,1098
+primitive-0.1.4.dist-info/RECORD,,