grimx 0.3.0__tar.gz

grimx-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 GRIMX LABS
+
+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.

grimx-0.3.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: grimx
+Version: 0.3.0
+Summary: GCC Runtime & Installation Manager, Cross-platform — minimal tooling for C and C++ projects
+License: MIT License
+        
+        Copyright (c) 2026 GRIMX LABS
+        
+        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.
+        
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1
+Requires-Dist: tomlkit>=0.12
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# GRIMX
+
+**GCC Runtime & Installation Manager - Cross Platform**
+
+A minimal developer tool for reproducible C and C++ environments.
+
+---
+
+## Installation
+
+```bash
+pip install grimx
+```
+
+That's it. The `grimx` command is now available globally.
+
+---
+
+## Quick Start
+
+```bash
+grimx new hello_world
+cd hello_world
+grimx install fmt
+grimx build
+grimx test
+grimx run
+```
+
+---
+
+## Commands
+
+| Command | Description |
+|---|---|
+| `grimx new <name>` | Scaffold a new project |
+| `grimx new <name> --type c` | Scaffold a C project (default: cpp) |
+| `grimx install <pkg>` | Install a dependency |
+| `grimx install` | Restore all dependencies from lock file |
+| `grimx build` | Build the project via CMake |
+| `grimx test` | Run tests via CTest |
+| `grimx run` | Run the compiled application |
+
+---
+
+## Project Structure
+
+```
+my_project/
+  src/            source files
+  include/        project headers
+  tests/          unit tests
+  cmake/          optional cmake modules
+  CMakeLists.txt
+  grimx.config
+  grimx.lock
+```
+
+---
+
+## Project Types
+
+```bash
+grimx new my_app --type c            # C application
+grimx new my_app --type cpp          # C++ application (default)
+grimx new my_fw  --type embedded-c   # Embedded C
+grimx new my_fw  --type embedded-cpp # Embedded C++
+```
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+## License
+
+MIT — see [LICENSE](LICENSE).

grimx-0.3.0/README.md

@@ -0,0 +1,80 @@
+# GRIMX
+
+**GCC Runtime & Installation Manager - Cross Platform**
+
+A minimal developer tool for reproducible C and C++ environments.
+
+---
+
+## Installation
+
+```bash
+pip install grimx
+```
+
+That's it. The `grimx` command is now available globally.
+
+---
+
+## Quick Start
+
+```bash
+grimx new hello_world
+cd hello_world
+grimx install fmt
+grimx build
+grimx test
+grimx run
+```
+
+---
+
+## Commands
+
+| Command | Description |
+|---|---|
+| `grimx new <name>` | Scaffold a new project |
+| `grimx new <name> --type c` | Scaffold a C project (default: cpp) |
+| `grimx install <pkg>` | Install a dependency |
+| `grimx install` | Restore all dependencies from lock file |
+| `grimx build` | Build the project via CMake |
+| `grimx test` | Run tests via CTest |
+| `grimx run` | Run the compiled application |
+
+---
+
+## Project Structure
+
+```
+my_project/
+  src/            source files
+  include/        project headers
+  tests/          unit tests
+  cmake/          optional cmake modules
+  CMakeLists.txt
+  grimx.config
+  grimx.lock
+```
+
+---
+
+## Project Types
+
+```bash
+grimx new my_app --type c            # C application
+grimx new my_app --type cpp          # C++ application (default)
+grimx new my_fw  --type embedded-c   # Embedded C
+grimx new my_fw  --type embedded-cpp # Embedded C++
+```
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+## License
+
+MIT — see [LICENSE](LICENSE).

grimx-0.3.0/grimx/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

grimx-0.3.0/grimx/build.py

@@ -0,0 +1,142 @@
+"""
+grimx.build
+Orchestrate CMake configure, build, test, and run.
+"""
+
+from __future__ import annotations
+
+import subprocess
+import shutil
+from pathlib import Path
+
+import click
+
+BUILD_DIR = "build"
+
+
+def run() -> None:
+    """Configure and build the project."""
+    _require_tool("cmake")
+    _guard_project_root()
+    _cmake_configure()
+    _cmake_build()
+
+
+def run_tests() -> None:
+    """Run tests via CTest."""
+    _require_tool("ctest")
+    _guard_project_root()
+
+    build_path = _build_path()
+    if not build_path.exists():
+        click.echo("No build directory found — running build first...")
+        run()
+
+    click.echo("Running tests...")
+    result = subprocess.run(
+        ["ctest", "--output-on-failure", "--test-dir", str(build_path)],
+    )
+    if result.returncode != 0:
+        raise SystemExit(result.returncode)
+    click.echo("✓ all tests passed")
+
+
+def run_app() -> None:
+    """Run the compiled application binary."""
+    _guard_project_root()
+
+    build_path = _build_path()
+    if not build_path.exists():
+        click.echo("error: no build directory found. Run 'grimx build' first.", err=True)
+        raise SystemExit(1)
+
+    project_name = Path.cwd().name
+    binary = build_path / project_name
+
+    # Fallback: look for any executable in build root
+    if not binary.exists():
+        candidates = [
+            p for p in build_path.iterdir()
+            if p.is_file() and _is_executable(p)
+        ]
+        if not candidates:
+            click.echo("error: no binary found in build/. Run 'grimx build' first.", err=True)
+            raise SystemExit(1)
+        binary = candidates[0]
+
+    click.echo(f"Running {binary.name}...")
+    result = subprocess.run([str(binary)])
+    raise SystemExit(result.returncode)
+
+
+# ---------------------------------------------------------------------------
+# Internal
+# ---------------------------------------------------------------------------
+
+def _cmake_configure() -> None:
+    project_root = Path.cwd()
+    build_path = _build_path()
+    build_path.mkdir(exist_ok=True)
+
+    click.echo("Configuring with CMake...")
+    result = subprocess.run(
+        [
+            "cmake",
+            str(project_root),          # explicit source dir — never ".."
+            f"-B{build_path}",          # explicit build dir
+            "-DCMAKE_BUILD_TYPE=Debug",
+        ],
+        cwd=project_root,
+    )
+    if result.returncode != 0:
+        raise SystemExit(result.returncode)
+
+
+def _cmake_build() -> None:
+    build_path = _build_path()
+    click.echo("Building...")
+    result = subprocess.run(
+        ["cmake", "--build", str(build_path), "--parallel"],
+    )
+    if result.returncode != 0:
+        raise SystemExit(result.returncode)
+    click.echo("✓ build succeeded")
+
+
+def _build_path() -> Path:
+    return Path.cwd() / BUILD_DIR
+
+
+def _guard_project_root() -> None:
+    """Abort with a clear message if not run from a GRIMX project directory."""
+    cwd = Path.cwd()
+    has_cmake = (cwd / "CMakeLists.txt").exists()
+    has_config = (cwd / "grimx.config").exists()
+
+    if not has_cmake and not has_config:
+        click.echo(
+            "error: no CMakeLists.txt or grimx.config found in current directory.\n"
+            "  Run this command from inside a GRIMX project.",
+            err=True,
+        )
+        raise SystemExit(1)
+
+    if not has_cmake:
+        click.echo(
+            "error: CMakeLists.txt not found.\n"
+            "  Make sure your project was scaffolded correctly.",
+            err=True,
+        )
+        raise SystemExit(1)
+
+
+def _require_tool(name: str) -> None:
+    if not shutil.which(name):
+        click.echo(f"error: '{name}' not found in PATH.", err=True)
+        click.echo(f"  Install it and re-run, or check 'grimx doctor' (coming in v2).")
+        raise SystemExit(1)
+
+
+def _is_executable(path: Path) -> bool:
+    import os
+    return os.access(path, os.X_OK)

grimx-0.3.0/grimx/cli.py

@@ -0,0 +1,51 @@
+"""
+grimx.cli
+Entry point for the GRIMX command-line interface
+"""
+
+import click 
+from grimx import __version__
+from grimx import scaffold, install as install_mod, build as build_mod 
+
+@click.group()
+@click.version_option(__version__, prog_name="grimx")
+def main():
+    """GRIMX - GNU Runtime & Installation Manager.
+    
+    Minimal tooling for reproducible C and C++ environments.
+    """
+
+@main.command()
+@click.argument("name", required=False, default=None)
+@click.option(
+    "--type",
+    "project_type",
+    default=None,
+    type=click.Choice(["c", "cpp", "embedded-c", "embedded-cpp"], case_sensitive=False),
+    help="Project type (skips prompt if provided).",
+)
+def new(name: str | None, project_type: str | None):
+    """Scaffold a new project interactivity, or pass NAME to skip the name prompt."""
+    scaffold.create_project(name, project_type)
+
+
+@main.command("install")
+@click.argument("package", required=False, default=None)
+def install_cmd(package):
+    """Install a dependency, or restore all from grimx.lock."""
+    install_mod.run(package)
+
+@main.command("build")
+def build_cmd():
+    """Build the project via CMake."""
+    build_mod.run()
+
+@main.command("test")
+def test_cmd():
+    """Run tests via CTest."""
+    build_mod.run_tests()
+
+@main.command("run")
+def run_cmd():
+    """Run the compiled application."""
+    build_mod.run_app()

grimx-0.3.0/grimx/config.py

@@ -0,0 +1,84 @@
+"""
+grimx.config
+Read and write grimx.config and grimx.lock using TOML.
+"""
+
+from __future__ import annotations
+
+import os
+from pathlib import Path
+from typing import Any
+
+import tomlkit
+
+CONFIG_FILE = "grimx.config"
+LOCK_FILE = "grimx.lock"
+
+DEFAULT_CONFIG: dict[str, Any] = {
+    "package_manager": {
+        "priority": ["vcpkg", "conan"],
+    }
+}
+
+
+# ---------------------------------------------------------------------------
+# Config helpers
+# ---------------------------------------------------------------------------
+
+def load_config(root: Path | None = None) -> dict[str, Any]:
+    """Load grimx.config from root (defaults to cwd)."""
+    path = _resolve(root, CONFIG_FILE)
+    if not path.exists():
+        return dict(DEFAULT_CONFIG)
+    return tomlkit.loads(path.read_text())
+
+
+def write_config(data: dict[str, Any], root: Path | None = None) -> None:
+    path = _resolve(root, CONFIG_FILE)
+    path.write_text(tomlkit.dumps(data))
+
+
+# ---------------------------------------------------------------------------
+# Lock file helpers
+# ---------------------------------------------------------------------------
+
+def load_lock(root: Path | None = None) -> dict[str, Any]:
+    path = _resolve(root, LOCK_FILE)
+    if not path.exists():
+        doc = tomlkit.document()
+        doc["dependencies"] = tomlkit.table()
+        return doc
+    return tomlkit.loads(path.read_text())
+
+
+def write_lock(data: dict[str, Any], root: Path | None = None) -> None:
+    path = _resolve(root, LOCK_FILE)
+    path.write_text(tomlkit.dumps(data))
+
+
+def add_dependency(
+    name: str,
+    manager: str,
+    version: str,
+    root: Path | None = None,
+) -> None:
+    lock = load_lock(root)
+
+    if "dependencies" not in lock:
+        lock["dependencies"] = tomlkit.table()
+
+    entry = tomlkit.inline_table()
+    entry.append("manager", manager)
+    entry.append("version", version)
+
+    lock["dependencies"][name] = entry
+    write_lock(lock, root)
+
+
+# ---------------------------------------------------------------------------
+# Internal
+# ---------------------------------------------------------------------------
+
+def _resolve(root: Path | None, filename: str) -> Path:
+    base = root or Path(os.getcwd())
+    return base / filename