croom 0.1.0__py3-none-any.whl

croom/__init__.py

@@ -0,0 +1,5 @@
+from .room import Room
+from .roomspec import Checksum, RoomSpec
+
+__version__ = "0.1.0"
+__all__ = ["Checksum", "Room", "RoomSpec"]

croom/helpers.py

@@ -0,0 +1,8 @@
+from urllib.parse import urlparse
+
+
+def is_valid_url(url: str) -> bool:
+    """validate an HTTP(S) url"""
+    parsed = urlparse(url)
+
+    return parsed.scheme in {"http", "https"} and bool(parsed.netloc)

croom/room.py

@@ -0,0 +1,2 @@
+class Room:
+    """represents a room instance"""

croom/roomspec.py

@@ -0,0 +1,134 @@
+import hashlib
+import shlex
+import tomllib
+from dataclasses import dataclass, field
+from pathlib import Path
+
+from .helpers import is_valid_url
+
+
+@dataclass
+class Checksum:
+    """represents a checksum to verify a downloaded artifact against"""
+
+    checksum: str
+    type: str = "sha256"
+
+    def check(self, b: bytes) -> bool:
+        """check the stored checksum against bytes"""
+        h = hashlib.new(self.type)
+        h.update(b)
+        return h.hexdigest().strip().lower() == self.checksum.strip().lower()
+
+
+@dataclass
+class RoomSpecSource:
+    checksum: Checksum
+    url: str
+    directory: Path | None = None
+
+    def __post_init__(self):
+        if not is_valid_url(self.url):
+            raise ValueError(f"invalid url: {self.url}")
+
+    @classmethod
+    def from_dict(cls, d: dict) -> "RoomSpecSource":
+        """create a RoomSpecSource from a dict"""
+        dchecksum = d.get("checksum", {})
+        checksum_type = dchecksum.get("type", None)
+        checksum_value = dchecksum.get("value", None)
+        checksum = Checksum(checksum_value, checksum_type)
+
+        url = d.get("url", "")
+        directory = d.get("directory", None)
+
+        if not is_valid_url(url):
+            raise ValueError(f"invalid url: {url}")
+
+        return cls(checksum, url, Path(directory) if directory else None)
+
+
+@dataclass
+class RoomSpecConfiguration:
+    symlink_resolv: bool = True
+    can_persist: bool = True
+    can_cache: bool = False
+
+    @classmethod
+    def from_dict(cls, d: dict) -> "RoomSpecConfiguration":
+        """create a RoomSpecConfiguration from a dict"""
+        return cls(
+            bool(d.get("symlink-resolv", True)),
+            bool(d.get("can-persist", True)),
+            bool(d.get("can-cache", False)),
+        )
+
+
+@dataclass
+class PostExtractStep:
+    name: str
+    optional: bool = False
+    requires_reload: bool = False
+    ignore_fail: bool = False
+    command: list[str] = field(default_factory=list)
+
+    @classmethod
+    def from_dict(cls, d: dict) -> "PostExtractStep":
+        """create a PostExtractStep from a dict"""
+        name = d.get("name", "")
+        if not name.strip():
+            raise ValueError("name not found")
+
+        optional = bool(d.get("optional", False))
+        requires_reload = bool(d.get("requires-reload", False))
+        ignore_fail = bool(d.get("ignore-fail", False))
+        scommand = d.get("command", "")
+        if not scommand.strip():
+            raise ValueError("command not found")
+        command = shlex.split(scommand)
+
+        return cls(name, optional, requires_reload, ignore_fail, command)
+
+
+@dataclass
+class RoomSpec:
+    """represents a room spec"""
+
+    name: str
+    version: str
+
+    source: RoomSpecSource
+    configuration: RoomSpecConfiguration
+    postextract: list[PostExtractStep] = field(default_factory=list)
+
+    @classmethod
+    def from_toml(cls, f: Path) -> "RoomSpec":
+        """create a RoomSpec from a TOML file"""
+        with open(str(f), "rb") as fp:
+            d = tomllib.load(fp)
+        return cls.from_dict(d)
+
+    @classmethod
+    def from_dict(cls, d: dict) -> "RoomSpec":
+        """create a RoomSpec from a dict"""
+        name = d.get("roomspec", {}).get("name", "").strip()
+        version = d.get("roomspec", {}).get("version", "").strip()
+
+        if not name:
+            raise ValueError("name not found")
+
+        if not version:
+            raise ValueError("version not found")
+
+        dsrc = d.get("source", {})
+        rsrc = RoomSpecSource.from_dict(dsrc)
+
+        dcfg = d.get("configuration", {})
+        rcfg = RoomSpecConfiguration.from_dict(dcfg)
+
+        dpsteps = d.get("postextract", [])
+        psteps = []
+        for dpstep in dpsteps:
+            psteps.append(PostExtractStep.from_dict(dpstep))
+
+        return cls(name, version, rsrc, rcfg, psteps)

croom-0.1.0.dist-info/METADATA

@@ -0,0 +1,52 @@
+Metadata-Version: 2.5
+Name: croom
+Version: 0.1.0
+Summary: chroot-based linux sandbox cli
+Project-URL: Homepage, https://github.com/juanvel4000/croom
+Project-URL: Repository, https://github.com/juanvel4000/croom
+Project-URL: Issues, https://github.com/juanvel4000/croom/issues
+Project-URL: Changelog, https://github.com/juanvel4000/croom/blob/main/CHANGELOG.md
+Author: juanvel400
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: chroot,cli,sandbox
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# croom
+
+[![run tests](https://github.com/juanvel4000/croom/actions/workflows/tests.yml/badge.svg)](https://github.com/juanvel4000/croom/actions/workflows/tests.yml)
+[![publish to pypi](https://github.com/juanvel4000/croom/actions/workflows/publish.yml/badge.svg)](https://github.com/juanvel4000/croom/actions/workflows/publish.yml)
+
+a simple Linux sandbox CLI.
+
+## overview
+
+croom provides a simpler way to create and interact with semi-isolated environments ("`Rooms`"). it uses utilities such as `unshare` and standard Unix tools to construct and provide these environments without root privileges.
+
+croom environments are not designed to provide security isolation. instead, they provide a simple space to try, run, and test programs in custom, semi-isolated environments.
+
+> croom uses `croom` as the project wide name and `croom` as the distribution name.
+
+## project status
+
+croom is in active development. while functional, it is **not yet production-ready** for real-world usage.
+
+- [CHANGELOG.md](CHANGELOG.md) -- release history
+- [CONTRIBUTING.md](CONTRIBUTING.md) -- how to report bugs and send patches
+
+## license
+
+BSD-3-Clause, see [LICENSE](LICENSE)

croom-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+croom/__init__.py,sha256=uZuhD9s5qXq2lrLkyf6CKrF87C_fkKfNxVeXLmuQ0bA,130
+croom/helpers.py,sha256=jTWDuCXPeYc-40p6FIj79SefuyBWQtjlaI0dBdMbN2Y,204
+croom/room.py,sha256=Hj3Hil3sBUP3kH6CWLABShuF7ank4rW_sV5wqbn62Y8,49
+croom/roomspec.py,sha256=Ng78HYWwfyzQbsRMTnywYh9JyTVo9WzmHSTVbc78A_g,3805
+croom-0.1.0.dist-info/METADATA,sha256=nfCvJnLoaw1-7USRufeKoSicfIqfbKAGYM2oeazDeCg,2229
+croom-0.1.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+croom-0.1.0.dist-info/entry_points.txt,sha256=f9o-tcEh5gS5OCcOoKLimH526qlnhYsoqgR0bQYM32Y,41
+croom-0.1.0.dist-info/licenses/LICENSE,sha256=qioo2eoiY8QhGSbjOXvakhjPzwlmPFxxdFlDT4YIDrU,1471
+croom-0.1.0.dist-info/RECORD,,

croom-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

croom-0.1.0.dist-info/entry_points.txt

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

croom-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,10 @@
+
+Copyright (c) 2026 juanvel400.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.