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

primitive/utils/actions.py

@@ -0,0 +1,9 @@
+import typing
+
+if typing.TYPE_CHECKING:
+    import primitive.client
+
+
+class BaseAction:
+    def __init__(self, primitive: "primitive.client.Primitive") -> None:
+        self.primitive = primitive

primitive/utils/config.py

@@ -0,0 +1,34 @@
+import json
+from pathlib import Path
+from typing import Dict
+
+HOME_DIRECTORY = Path.home()
+PRIMITIVE_CREDENTIALS_FILEPATH = Path(
+    HOME_DIRECTORY / ".config" / "primitive" / "credentials.json"
+)
+
+
+def create_directory(filepath: Path = PRIMITIVE_CREDENTIALS_FILEPATH):
+    filepath.mkdir(parents=True, exist_ok=True)
+
+
+def create_config_file(filepath: Path = PRIMITIVE_CREDENTIALS_FILEPATH):
+    filepath.parent.mkdir(parents=True, exist_ok=True)
+    filepath.touch()
+    with filepath.open("w") as json_file:
+        json.dump({}, json_file)
+
+
+def update_config_file(
+    filepath: Path = PRIMITIVE_CREDENTIALS_FILEPATH, new_config: Dict = {}
+):
+    existing_config = read_config_file(filepath=filepath)
+    merged_config = {**existing_config, **new_config}
+    with filepath.open("w") as json_file:
+        json.dump(merged_config, json_file, indent=2)
+
+
+def read_config_file(filepath: Path = PRIMITIVE_CREDENTIALS_FILEPATH) -> Dict:
+    if not filepath.exists():
+        create_config_file(filepath=filepath)
+    return json.loads(filepath.read_text())

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/git.py

@@ -0,0 +1,15 @@
+import os
+from loguru import logger
+
+
+def download_source(github_access_token, git_repository, git_ref) -> None:
+    # Download code to current directory
+    logger.debug(f"Downloading source code from {git_repository} {git_ref}")
+    url = f"https://api.github.com/repos/{git_repository}/tarball/{git_ref}"
+    # TODO: switch to supbrocess.run or subprocess.Popen
+    result = os.system(
+        f"curl -s -L -H 'Accept: application/vnd.github+json' -H 'Authorization: Bearer {github_access_token}' -H 'X-GitHub-Api-Version: 2022-11-28' {url} | tar zx --strip-components 1 -C ."
+    )
+
+    if result != 0:
+        raise Exception("Failed to import repository.")

primitive/utils/memory_size.py

@@ -0,0 +1,87 @@
+from typing import Tuple
+
+
+class MemorySize:
+    CONVERSION_FACTORS: dict[str, float] = {
+        "b": 1 / 8,
+        "B": 1,
+        "KB": 1000,
+        "MB": 1000**2,
+        "GB": 1000**3,
+        "TB": 1000**4,
+        "PB": 1000**5,
+        "KiB": 2**10,
+        "MiB": 2**20,
+        "GiB": 2**30,
+        "TiB": 2**40,
+        "PiB": 2**50,
+    }
+
+    def __init__(self, value_or_string: int | float | str, unit: str | None = None):
+        """
+        Initializes MemorySize in two ways:
+            size = MemorySize("3.14 GB") - value_or_string is str and unit is None
+            size = MemorySize(42, "MB") - value_or_string is int and unit is str
+            size = MemorySize(2.718, "PB") - value_or_string is float and unit is str
+        """
+        if isinstance(value_or_string, str):
+            parts = value_or_string.split()
+            if len(parts) != 2:
+                raise ValueError(f"Invalid size string format: {value_or_string}")
+
+            value_string, unit = parts
+            try:
+                self.value = float(value_string)
+            except ValueError:
+                raise ValueError(f"Invalid size value: {value_string}")
+            self.unit = unit
+        elif isinstance(value_or_string, int | float) and isinstance(unit, str):
+            self.value = float(value_or_string)
+            self.unit = unit
+        else:
+            message = f"Invalid arguments provided: {value_or_string}:{type(value_or_string)} and {unit}:{type(unit)}"  # noqa
+            raise ValueError(message)
+
+        if not self.CONVERSION_FACTORS.get(self.unit):
+            message = f"Invalid unit: {self.unit}"
+            raise ValueError(message)
+
+    def __str__(self):
+        return f"{self.value:.3f} {self.unit}"
+
+    def __eq__(self, other):
+        if not isinstance(other, MemorySize):
+            raise TypeError(f"Comparison with unsupported type: {type(other)}")
+        return self.to_bytes() == other.to_bytes()
+
+    def to_bytes(self):
+        """
+        Converts value to bytes (B)
+        """
+        return self.value * self.CONVERSION_FACTORS.get(self.unit, 1)
+
+    def convert_to(self, target_unit):
+        """
+        Converts the stored value to a different unit and updates the instance.
+        """
+        if target_unit not in self.CONVERSION_FACTORS:
+            raise ValueError(f"Invalid unit {target_unit}")
+
+        factor = (
+            self.CONVERSION_FACTORS[self.unit] / self.CONVERSION_FACTORS[target_unit]
+        )
+        self.value *= factor
+        self.unit = target_unit
+
+    def get_human_readable(self) -> Tuple[float, str]:
+        """
+        Converts the stored value to a human-readable format
+        """
+        HUMAN_READABLE_UNITS: list[str] = ["PB", "TB", "GB", "MB", "KB", "B"]
+
+        value_in_bytes = self.to_bytes()
+        for unit in HUMAN_READABLE_UNITS:
+            value_in_unit = value_in_bytes * (1.000 / self.CONVERSION_FACTORS[unit])
+            if value_in_unit >= 1.0:
+                return (value_in_unit, unit)
+        return (value_in_bytes, "B")

primitive/utils/printer.py

@@ -0,0 +1,14 @@
+import json
+
+import click
+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.info(json.dumps(message))
+    else:
+        if context.obj["JSON"]:
+            message = json.dumps(message, indent=2)
+        click.secho(message, fg=fg)

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.4.dist-info/METADATA

@@ -0,0 +1,49 @@
+Metadata-Version: 2.3
+Name: primitive
+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
+Author-email: Dylan Stein <dylan@primitive.tech>, Chase Zimmerman <chase@primitive.tech>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.12
+Requires-Dist: click
+Requires-Dist: gql[all]
+Requires-Dist: ipdb
+Requires-Dist: loguru
+Requires-Dist: pyright
+Requires-Dist: ruff
+Description-Content-Type: text/markdown
+
+# primitive
+
+[![PyPI - Version](https://img.shields.io/pypi/v/primitive-cli.svg)](https://pypi.org/project/primitive-cli)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/primitive-cli.svg)](https://pypi.org/project/primitive-cli)
+
+---
+
+**Table of Contents**
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+```console
+pip install primitive
+```
+
+## License
+
+`primitive` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

primitive-0.1.4.dist-info/RECORD

@@ -0,0 +1,32 @@
+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
+primitive/auth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+primitive/auth/actions.py,sha256=N2bGcwXNsB89pzs66gF9A5_WzUScY5fhfOyWixqo2y8,1054
+primitive/auth/commands.py,sha256=JahUq0E2e7Xa-FX1WEUv7TgM6ieDvNH4VwRRtxAW7HE,2340
+primitive/files/actions.py,sha256=f4JN3QFB2WXw-0JpnE-4-movnqtvXIpCrGd_9pdkeW4,2624
+primitive/files/commands.py,sha256=DDizo3xJnU3KLUBTMeeM72viVpnJinLwxs84tmqKhqo,810
+primitive/graphql/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+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=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=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,,

{primitive-0.1.1.dist-info → primitive-0.1.4.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.7.0
+Generator: hatchling 1.25.0
 Root-Is-Purelib: true
 Tag: py3-none-any

primitive-0.1.4.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+primitive = primitive.cli:cli

primitive-0.1.4.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present Dylan Stein <dylan@steins.studio>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

primitive/main.py

@@ -1,18 +0,0 @@
-import click
-from scope import DirectoryWatch
-
-@click.group()
-def cli():
-    pass
-
-# Watch filesystem for changes
-@cli.command()
-@click.option('--path', default='.', help='Path to watch for changes.')
-@click.option('--ask', default=False, help='Ask before running simulation.')
-def watch(path, ask):
-	click.echo(f"Watching {path} for changes")
-	watcher = DirectoryWatch(path, ask)
-	watcher.run()
-
-if __name__ == '__main__':
-    cli()

primitive/scope/__init__.py

@@ -1,2 +0,0 @@
-from scope.watch import *
-from scope.sim import *

primitive/scope/simulator.py

@@ -1,12 +0,0 @@
-""" Run simulation to generate a new vcd file. """
-import subprocess
-
-class Simulator:
-
-	def __init__(self):
-		pass
-
-	def run(self):
-		subprocess.run(["iverilog", "-o", "test", "test.v"])
-		subprocess.run(["vvp", "test"])
-	

primitive/scope/watch.py

@@ -1,42 +0,0 @@
-""" Watch filesystem for changes and manage simulation data """
-import click
-import time
-from watchdog.observers import Observer
-from watchdog.events import FileSystemEventHandler
-from scope.simulator import Simulator
-
-class Handler(FileSystemEventHandler):
-	def __init__(self, ask):
-		self.ask = ask
-		self.simulator = Simulator()
-
-	def on_any_event(self, event):
-		if event.is_directory: return None
-
-		if event.event_type == 'created' or event.event_type == 'modified' or event.event_type == 'deleted':
-			# If we recognize a file has changed, prompt user to run simulation
-			click.echo(f"File {event.src_path} has changed. ", nl=False)
-			if self.ask:
-				click.echo(f"Press enter to start simulation.")
-				input()
-			
-			click.echo(f"Running simulation...")
-
-class DirectoryWatch:
-	def __init__(self, path, ask):
-		self.path = path
-		self.ask = ask
-		self.observer = Observer()
-	
-	def run(self):
-		event_handler = Handler(self.ask)
-		self.observer.schedule(event_handler, self.path, recursive = True)
-		self.observer.start()
-		try:
-			while True:
-				time.sleep(5)
-		except:
-			self.observer.stop()
-			print("Observer Stopped")
-
-		self.observer.join()

primitive-0.1.1.dist-info/METADATA

@@ -1,15 +0,0 @@
-Metadata-Version: 2.1
-Name: primitive
-Version: 0.1.1
-Summary: cli tool for interacting with primitive
-Author: Chase Zimmerman
-Author-email: chaseklvk@icloud.com
-Requires-Python: >=3.10,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: click (>=8.1.7,<9.0.0)
-Requires-Dist: watchdog (>=3.0.0,<4.0.0)
-Description-Content-Type: text/markdown
-
-# cli

primitive-0.1.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-primitive/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-primitive/main.py,sha256=ZC_2xwCBbCjihKpVCq2EO3QW7C9RfZnL0WtZ3FPdd1s,433
-primitive/scope/__init__.py,sha256=Te58G6-QBLjsRJBE78puT5vzYIxMcXKebFRCDGUhbNc,49
-primitive/scope/simulator.py,sha256=VV6YewLkGvGBCTogRWJ85FmZyuuG--mLmoX6_-N9IvI,223
-primitive/scope/watch.py,sha256=Abq-Ncvmx3PykI6Qn92J2wmFd6y8-wQSKf8IWTvnws4,1158
-primitive-0.1.1.dist-info/METADATA,sha256=79KL3BNNfw6tvqa7zJCURf9PdMVsDYrfMSzopiWgNoA,466
-primitive-0.1.1.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-primitive-0.1.1.dist-info/entry_points.txt,sha256=v26R3swfLXOD1XUSqQN7hZWC2CYH49Hp7iq7Tzk2NYE,48
-primitive-0.1.1.dist-info/RECORD,,

primitive-0.1.1.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-primitive=primitive.main:cli
-