fastsandpm 0.1.0a1__tar.gz

fastsandpm-0.1.0a1/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.3
+Name: fastsandpm
+Version: 0.1.0a1
+Summary: FastSandPM is a a package management and dependency resolution tool for HDL Design and DV projects
+Author: Benjamin Davis
+Author-email: Benjamin Davis <allrisc.dev@gmail.com>
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: pyyaml>=6.0.3
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# FastSandPM
+A package management and dependency resolution tool for HDL Design and DV projects
+
+[![Tests](https://github.com/RISCY-Lib/fastsandpm/actions/workflows/run-ci-tests.yml/badge.svg)](https://github.com/RISCY-Lib/fastsandpm/actions/workflows/run-ci-tests.yml)
+[![PyPI Latest Release](https://img.shields.io/pypi/v/fastsandpm.svg)](https://pypi.org/project/fastsandpm/)
+[![docs](https://readthedocs.org/projects/fastsandpm/badge)](https://fastsandpm.readthedocs.io/en/latest/index.html)
+
+See [Read-The-Docs](https://fastsandpm.readthedocs.io/en/latest/index.html) for details

fastsandpm-0.1.0a1/README.md

@@ -0,0 +1,8 @@
+# FastSandPM
+A package management and dependency resolution tool for HDL Design and DV projects
+
+[![Tests](https://github.com/RISCY-Lib/fastsandpm/actions/workflows/run-ci-tests.yml/badge.svg)](https://github.com/RISCY-Lib/fastsandpm/actions/workflows/run-ci-tests.yml)
+[![PyPI Latest Release](https://img.shields.io/pypi/v/fastsandpm.svg)](https://pypi.org/project/fastsandpm/)
+[![docs](https://readthedocs.org/projects/fastsandpm/badge)](https://fastsandpm.readthedocs.io/en/latest/index.html)
+
+See [Read-The-Docs](https://fastsandpm.readthedocs.io/en/latest/index.html) for details

fastsandpm-0.1.0a1/pyproject.toml

@@ -0,0 +1,166 @@
+####################################################################################################
+# FastSandPM is a package management and dependency resolution tool for HDL Design and DV projects
+# Copyright (C) 2026, Benjamin Davis
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, see
+# <https://www.gnu.org/licenses/>.
+####################################################################################################
+
+[build-system]
+requires = ["uv_build>=0.8.3,<0.9.0"]
+build-backend = "uv_build"
+
+
+[project]
+name = "FastSandPM"
+version = "0.1.0a1"
+description = """FastSandPM is a a package management and dependency resolution tool for HDL Design and DV projects"""
+readme = "README.md"
+authors = [
+    { name = "Benjamin Davis", email = "allrisc.dev@gmail.com" }
+]
+
+requires-python = ">=3.12"
+dependencies = [
+    "pydantic>=2.12.5",
+    "pyyaml>=6.0.3",
+]
+
+[dependency-groups]
+dev = [
+    "ruff>=0.13.0",
+    "tox>=4.25.0",
+    "tox-uv>=1.13.1",
+]
+docs=[
+    "sphinx>=5.3.0",
+    "sphinx-rtd-theme>=2.0.0",
+    "sphinx-prompt>=1.10.0",
+    "sphinxcontrib-autoprogram>=0.1.9",
+    "sphinx-collapse>=0.1.3",
+    "myst-parser>=4.0.1",
+]
+tests=[
+    "pytest>=7.4.4",
+    "pytest-mock>=3.15.1",
+]
+typing=[
+    "mypy>=1.4.1",
+    "types-pyyaml>=6.0.12.20250516",
+]
+
+# Tool Configurations
+####################################################################################################
+[tool.autopep8]
+max-line-length = 100
+
+[tool.mypy]
+warn_return_any = true
+pretty = true
+
+python_version = "3.12"
+
+files = ["src"]
+
+[tool.pyright]
+pythonVersion = "3.12"
+include = ["src"]
+typeCheckingMode = "basic"
+
+[tool.ruff]
+line-length = 100
+indent-width = 4
+
+target-version = "py312"
+show-fixes = true
+
+src = ["src"]
+exclude = [".*", "tests/data/*"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.ruff.lint]
+select = [
+    "B",  # flake8-bugbear
+    "N",  # pep8-naming
+    "E",  # pycodestyle error
+    "F",  # pyflakes
+    "I",  # isort
+    "UP",  # pyupgrade
+    "W",  # pycodestyle warning
+]
+ignore = []
+
+preview = true
+
+[tool.tox]
+env_list = [
+    "py12", "py13", "py14",
+    "style",
+    "typing",
+    "docs_dirhtml",
+]
+
+[tool.tox.env_run_base]
+description = "pytest on latest dependency versions"
+runner = "uv-venv-lock-runner"
+package = "wheel"
+wheel_build_env = ".pkg"
+constrain_package_deps = true
+use_frozen_constraints = true
+dependency_groups = ["tests"]
+
+commands = [[
+    "pytest", "-v", "--tb=short", "--basetemp={env_tmp_dir}",
+    {replace = "posargs", default = [], extend = true},
+]]
+
+[tool.tox.env.style]
+description = "run linting and style checks on code"
+dependency_groups = ["dev"]
+skip_install = true
+commands = [["ruff", "check"]]
+
+[tool.tox.env.typing]
+description = "run static type checkers"
+dependency_groups = ["typing"]
+commands = [
+    ["mypy"],
+]
+
+[tool.tox.env.docs_dirhtml]
+description = "build docs in dirhtml mode"
+dependency_groups = ["docs"]
+allowlist_externals = ["rm"]
+commands_pre = [
+    ["rm", "-rf", "docs/source/api", "docs/_build/dirhtml",],
+]
+commands = [
+    ["sphinx-build", "-E", "-W", "-b", "dirhtml", "docs/source", "docs/_build/dirhtml"],
+]
+
+[tool.tox.env.docs_html]
+description = "build docs in html mode"
+dependency_groups = ["docs"]
+allowlist_externals = ["rm"]
+commands_pre = [
+    ["rm", "-rf", "docs/source/api", "docs/_build/html",],
+]
+commands = [
+    ["sphinx-build", "-E", "-W", "-b", "html", "docs/source", "docs/_build/html"],
+]

fastsandpm-0.1.0a1/src/fastsandpm/__init__.py

@@ -0,0 +1,46 @@
+####################################################################################################
+# FastSandPM is a package management and dependency resolution tool for HDL Design and DV projects
+# Copyright (C) 2026, Benjamin Davis
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, see
+# <https://www.gnu.org/licenses/>.
+####################################################################################################
+"""A package management and dependency resolution tool for HDL Design and DV projects
+
+This package provides tools for managing RTL and Design Verification projects for HDL projects
+"""
+
+from __future__ import annotations
+
+from fastsandpm import _info
+from fastsandpm.manifest import (
+    Manifest,
+    ManifestNotFoundError,
+    ManifestParseError,
+    Package,
+    get_manifest,
+)
+
+__version__ = _info.__version__
+__author__ = _info.__author__
+
+__all__ = [
+    "__version__",
+    "__author__",
+    "get_manifest",
+    "Manifest",
+    "ManifestNotFoundError",
+    "ManifestParseError",
+    "Package",
+]

fastsandpm-0.1.0a1/src/fastsandpm/_git_utils.py

@@ -0,0 +1,175 @@
+####################################################################################################
+# FastSandPM is a package management and dependency resolution tool for HDL Design and DV projects
+# Copyright (C) 2026, Benjamin Davis
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, see
+# <https://www.gnu.org/licenses/>.
+####################################################################################################
+"""Git utility functions for repository operations.
+
+This module provides wrapper functions around git commands for cloning,
+checking out, fetching, and querying git repositories. These utilities
+are used internally by the library controller to manage library dependencies.
+"""
+
+from __future__ import annotations
+
+import pathlib
+import subprocess
+
+
+def clone(remote: str, dest: pathlib.Path) -> None:
+    """Clone a git repository from a remote URL to a local destination.
+
+    Args:
+        remote: The URL of the remote repository to clone.
+        dest: The local path where the repository will be cloned.
+
+    Raises:
+        subprocess.CalledProcessError: If the git clone command fails.
+    """
+    subprocess.check_output(["git", "clone", remote, dest], stderr=subprocess.STDOUT)
+
+
+def checkout(commitish: str, repo: pathlib.Path) -> None:
+    """Checkout a specific commit, branch, or tag in a repository.
+
+    Args:
+        commitish: The commit SHA, branch name, or tag to checkout.
+        repo: The path to the local git repository.
+
+    Raises:
+        subprocess.CalledProcessError: If the git checkout command fails.
+    """
+    subprocess.check_output(["git", "checkout", commitish], cwd=repo, stderr=subprocess.STDOUT)
+
+
+def fetch(repo: pathlib.Path) -> None:
+    """Fetch updates from the remote repository.
+
+    Args:
+        repo: The path to the local git repository.
+
+    Raises:
+        subprocess.CalledProcessError: If the git fetch command fails.
+    """
+    subprocess.check_output(["git", "fetch"], cwd=repo, stderr=subprocess.STDOUT)
+
+
+def is_dirty(repo: pathlib.Path) -> bool:
+    """Check if a repository has uncommitted changes.
+
+    This checks both staged changes (diff-index) and unstaged changes
+    (diff-files) to determine if the working directory is dirty.
+
+    Args:
+        repo: The path to the local git repository.
+
+    Returns:
+        True if the repository has uncommitted changes, False otherwise.
+    """
+    proc = subprocess.run(
+        ["git", "diff-index", "--quiet", "HEAD", "--"],
+        cwd=repo,
+        stdout=subprocess.DEVNULL,
+        stderr=subprocess.DEVNULL,
+    )
+    if proc.returncode != 0:
+        return True
+
+    proc = subprocess.run(
+        ["git", "diff-files", "--quiet"], cwd=repo, stdout=subprocess.PIPE, stderr=subprocess.STDOUT
+    )
+
+    if proc.returncode != 0 or len(proc.stdout) != 0:
+        return True
+
+    return False
+
+
+def remote_exists(remote: str) -> bool:
+    """Check if a remote repository URL is accessible.
+
+    Args:
+        remote: The URL of the remote repository to check.
+
+    Returns:
+        True if the remote repository exists and is accessible, False otherwise.
+    """
+    proc = subprocess.run(
+        ["git", "ls-remote", remote], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL
+    )
+    return proc.returncode == 0
+
+
+def get_available_tags(remote: str) -> list[str]:
+    """Get all available tags from a repository.
+
+    Args:
+        remote: The URL of the remote repository.
+
+    Returns:
+        List of tag names from the repository.
+
+    Raises:
+        ValueError: If the remote repository cannot be found.
+    """
+    proc = subprocess.run(
+        ["git", "ls-remote", "--tags", remote],
+        stderr=subprocess.STDOUT,
+        stdout=subprocess.PIPE,
+    )
+
+    if proc.returncode != 0:
+        raise ValueError(f"Could not access remote {remote}")
+
+    tags = []
+    for line in proc.stdout.decode("utf-8").split("\n"):
+        if line.strip():
+            # Parse lines like: "abc123 refs/tags/v1.2.3"
+            parts = line.split("\t")
+            if len(parts) == 2:
+                ref = parts[1]
+                if ref.startswith("refs/tags/"):
+                    tag_name = ref[10:]  # Remove 'refs/tags/' prefix
+                    # Skip tags that end with ^{} (annotated tag references)
+                    if not tag_name.endswith("^{}"):
+                        tags.append(tag_name)
+    return tags
+
+
+def get_remote_file(remote: str, treeish: str, path: str) -> bytes:
+    """Get a file from a remote repository.
+
+    Args:
+        remote: The remote repository URL.
+        treeish: The commit, branch, or tag get the file from.
+        path: The path of the file in the repository.
+
+    Returns:
+        The contents of the file.
+
+    Raises:
+        ValueError: If the file cannot be fetched from the remote repository.
+    """
+    proc = subprocess.run(
+        f"git archive --remote={remote} {treeish} {path} | tar xO",
+        stderr=subprocess.STDOUT,
+        stdout=subprocess.PIPE,
+    )
+
+    if proc.returncode != 0:
+        raise ValueError(f"Could not fetch file {path} from remote {remote}")
+
+    return proc.stdout

fastsandpm-0.1.0a1/src/fastsandpm/_info.py

@@ -0,0 +1,35 @@
+####################################################################################################
+# FastSandPM is a package management and dependency resolution tool for HDL Design and DV projects
+# Copyright (C) 2026, Benjamin Davis
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, see
+# <https://www.gnu.org/licenses/>.
+####################################################################################################
+"""Package metadata for FastSandPM.
+
+This module provides package-level metadata including version and author
+information. The version is dynamically retrieved from the installed
+package metadata.
+
+Attributes:
+    __version__: The current version of the package.
+    __author__: The primary author of the package.
+"""
+
+from __future__ import annotations
+
+import importlib.metadata
+
+__version__: str = importlib.metadata.version("fastsandpm")
+__author__: str = "Benjamin Davis"