clonebox 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

clonebox/cloner.py

@@ -31,6 +31,7 @@ class VMConfig:
     paths: dict = field(default_factory=dict)
     packages: list = field(default_factory=list)
     services: list = field(default_factory=list)
+    user_session: bool = False  # Use qemu:///session instead of qemu:///system
     
     def to_dict(self) -> dict:
         return {
@@ -46,8 +47,16 @@ class SelectiveVMCloner:
     Uses bind mounts instead of full disk cloning.
     """
     
-    def __init__(self, conn_uri: str = "qemu:///system"):
-        self.conn_uri = conn_uri
+    # Default images directories
+    SYSTEM_IMAGES_DIR = Path("/var/lib/libvirt/images")
+    USER_IMAGES_DIR = Path.home() / ".local/share/libvirt/images"
+    
+    def __init__(self, conn_uri: str = None, user_session: bool = False):
+        self.user_session = user_session
+        if conn_uri:
+            self.conn_uri = conn_uri
+        else:
+            self.conn_uri = "qemu:///session" if user_session else "qemu:///system"
         self.conn = None
         self._connect()
     
@@ -59,17 +68,40 @@ class SelectiveVMCloner:
                 "Also ensure libvirt is installed: sudo apt install libvirt-daemon-system"
             )
         
-        self.conn = libvirt.open(self.conn_uri)
+        try:
+            self.conn = libvirt.open(self.conn_uri)
+        except libvirt.libvirtError as e:
+            raise ConnectionError(
+                f"Cannot connect to {self.conn_uri}\n"
+                f"Error: {e}\n\n"
+                f"Troubleshooting:\n"
+                f"  1. Check if libvirtd is running: sudo systemctl status libvirtd\n"
+                f"  2. Start libvirtd: sudo systemctl start libvirtd\n"
+                f"  3. Add user to libvirt group: sudo usermod -aG libvirt $USER\n"
+                f"  4. Re-login or run: newgrp libvirt\n"
+                f"  5. For user session (no sudo): use --user flag"
+            )
+        
         if self.conn is None:
             raise ConnectionError(f"Cannot connect to {self.conn_uri}")
     
+    def get_images_dir(self) -> Path:
+        """Get the appropriate images directory based on session type."""
+        if self.user_session:
+            return self.USER_IMAGES_DIR
+        return self.SYSTEM_IMAGES_DIR
+    
     def check_prerequisites(self) -> dict:
         """Check system prerequisites for VM creation."""
+        images_dir = self.get_images_dir()
+        
         checks = {
             "libvirt_connected": False,
             "kvm_available": False,
             "default_network": False,
             "images_dir_writable": False,
+            "images_dir": str(images_dir),
+            "session_type": "user" if self.user_session else "system",
         }
         
         # Check libvirt connection
@@ -77,18 +109,45 @@ class SelectiveVMCloner:
             checks["libvirt_connected"] = True
         
         # Check KVM
-        checks["kvm_available"] = Path("/dev/kvm").exists()
+        kvm_path = Path("/dev/kvm")
+        checks["kvm_available"] = kvm_path.exists()
+        if not checks["kvm_available"]:
+            checks["kvm_error"] = "KVM not available. Enable virtualization in BIOS."
+        elif not os.access(kvm_path, os.R_OK | os.W_OK):
+            checks["kvm_error"] = f"No access to /dev/kvm. Add user to kvm group: sudo usermod -aG kvm $USER"
         
         # Check default network
         try:
             net = self.conn.networkLookupByName("default")
             checks["default_network"] = net.isActive() == 1
         except libvirt.libvirtError:
-            pass
+            checks["network_error"] = (
+                "Default network not found or inactive.\n"
+                "  Start it with: sudo virsh net-start default\n"
+                "  Or create it: sudo virsh net-define /usr/share/libvirt/networks/default.xml"
+            )
         
         # Check images directory
-        images_dir = Path("/var/lib/libvirt/images")
-        checks["images_dir_writable"] = images_dir.exists() and os.access(images_dir, os.W_OK)
+        if images_dir.exists():
+            checks["images_dir_writable"] = os.access(images_dir, os.W_OK)
+            if not checks["images_dir_writable"]:
+                checks["images_dir_error"] = (
+                    f"Cannot write to {images_dir}\n"
+                    f"  Option 1: Run with sudo\n"
+                    f"  Option 2: Use --user flag for user session (no root needed)\n"
+                    f"  Option 3: Fix permissions: sudo chown -R $USER:libvirt {images_dir}"
+                )
+        else:
+            # Try to create it
+            try:
+                images_dir.mkdir(parents=True, exist_ok=True)
+                checks["images_dir_writable"] = True
+            except PermissionError:
+                checks["images_dir_writable"] = False
+                checks["images_dir_error"] = (
+                    f"Cannot create {images_dir}\n"
+                    f"  Use --user flag for user session (stores in ~/.local/share/libvirt/images/)"
+                )
         
         return checks
     
@@ -109,8 +168,25 @@ class SelectiveVMCloner:
             else:
                 print(msg)
         
-        vm_dir = Path(f"/var/lib/libvirt/images/{config.name}")
-        vm_dir.mkdir(parents=True, exist_ok=True)
+        # Determine images directory
+        images_dir = self.get_images_dir()
+        vm_dir = images_dir / config.name
+        
+        try:
+            vm_dir.mkdir(parents=True, exist_ok=True)
+        except PermissionError as e:
+            raise PermissionError(
+                f"Cannot create VM directory: {vm_dir}\n\n"
+                f"🔧 Solutions:\n"
+                f"  1. Use --user flag to run in user session (recommended):\n"
+                f"     clonebox clone . --user\n\n"
+                f"  2. Run with sudo (not recommended):\n"
+                f"     sudo clonebox clone .\n\n"
+                f"  3. Fix directory permissions:\n"
+                f"     sudo mkdir -p {images_dir}\n"
+                f"     sudo chown -R $USER:libvirt {images_dir}\n\n"
+                f"Original error: {e}"
+            ) from e
         
         # Create root disk
         root_disk = vm_dir / "root.qcow2"

clonebox/detector.py

@@ -276,6 +276,8 @@ class SystemDetector:
     def _get_dir_size(self, path: Path, max_depth: int = 2) -> int:
         """Get approximate directory size in bytes."""
         total = 0
+        if not path.exists():
+            return 0
         try:
             for item in path.iterdir():
                 if item.is_file():
@@ -285,7 +287,7 @@ class SystemDetector:
                         pass
                 elif item.is_dir() and max_depth > 0 and not item.is_symlink():
                     total += self._get_dir_size(item, max_depth - 1)
-        except PermissionError:
+        except (PermissionError, FileNotFoundError, OSError):
             pass
         return total
     

clonebox-0.1.2.dist-info/METADATA

@@ -0,0 +1,301 @@
+Metadata-Version: 2.4
+Name: clonebox
+Version: 0.1.2
+Summary: Clone your workstation environment to an isolated VM with selective apps, paths and services
+Author: CloneBox Team
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/wronai/clonebox
+Project-URL: Repository, https://github.com/wronai/clonebox
+Project-URL: Issues, https://github.com/wronai/clonebox/issues
+Keywords: vm,virtualization,libvirt,clone,workstation,qemu,kvm
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: POSIX :: Linux
+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: Topic :: System :: Systems Administration
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: libvirt-python>=9.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: questionary>=2.0.0
+Requires-Dist: psutil>=5.9.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# CloneBox 📦
+
+```commandline
+╔═══════════════════════════════════════════════════════╗
+║     ____  _                    ____                   ║
+║    / ___|| |  ___   _ __   ___|  _ \  ___ __  __      ║
+║   | |    | | / _ \ | '_ \ / _ \ |_) |/ _ \\ \/ /      ║
+║   | |___ | || (_) || | | |  __/  _ <| (_) |>  <       ║
+║    \____||_| \___/ |_| |_|\___|_| \_\\___//_/\_\      ║
+║                                                       ║
+║      Clone your workstation to an isolated VM         ║
+╚═══════════════════════════════════════════════════════╝
+```
+**Clone your workstation environment to an isolated VM with selective apps, paths and services.**
+
+CloneBox lets you create isolated virtual machines with only the applications, directories and services you need - using bind mounts instead of full disk cloning. Perfect for development, testing, or creating reproducible environments.
+
+## Features
+
+- 🎯 **Selective cloning** - Choose exactly which paths, services and apps to include
+- 🔍 **Auto-detection** - Automatically detects running services, applications, and project directories
+- 🔗 **Bind mounts** - Share directories with the VM without copying data
+- ☁️ **Cloud-init** - Automatic package installation and service setup
+- 🖥️ **GUI support** - SPICE graphics with virt-viewer integration
+- ⚡ **Fast creation** - No full disk cloning, VMs are ready in seconds
+
+## Installation
+
+### Prerequisites
+
+```bash
+# Install libvirt and QEMU/KVM
+sudo apt install qemu-kvm libvirt-daemon-system libvirt-clients bridge-utils virt-manager virt-viewer
+
+# Enable and start libvirtd
+sudo systemctl enable --now libvirtd
+
+# Add user to libvirt group
+sudo usermod -aG libvirt $USER
+newgrp libvirt
+
+# Install genisoimage for cloud-init
+sudo apt install genisoimage
+```
+
+### Install CloneBox
+
+```bash
+# From source
+git clone https://github.com/wronai/clonebox.git
+cd clonebox
+pip install -e .
+
+# Or directly
+pip install clonebox
+```
+lub
+```bash
+# Aktywuj venv
+source .venv/bin/activate
+
+# Interaktywny tryb (wizard)
+clonebox
+
+# Lub poszczególne komendy
+clonebox detect              # Pokaż wykryte usługi/apps/ścieżki
+clonebox list                # Lista VM
+clonebox create --config ... # Utwórz VM z JSON config
+clonebox start <name>        # Uruchom VM
+clonebox stop <name>         # Zatrzymaj VM
+clonebox delete <name>       # Usuń VM
+```
+
+## Quick Start
+
+### Interactive Mode (Recommended)
+
+Simply run `clonebox` to start the interactive wizard:
+
+```bash
+clonebox
+```
+
+The wizard will:
+1. Detect running services (Docker, PostgreSQL, nginx, etc.)
+2. Detect running applications and their working directories
+3. Detect project directories and config files
+4. Let you select what to include in the VM
+5. Create and optionally start the VM
+
+### Command Line
+
+```bash
+# Create VM with specific config
+clonebox create --name my-dev-vm --config '{
+  "paths": {
+    "/home/user/projects": "/mnt/projects",
+    "/home/user/.config": "/mnt/config"
+  },
+  "packages": ["python3", "nodejs", "docker.io"],
+  "services": ["docker"]
+}' --ram 4096 --vcpus 4 --start
+
+# List VMs
+clonebox list
+
+# Start/Stop VM
+clonebox start my-dev-vm
+clonebox stop my-dev-vm
+
+# Delete VM
+clonebox delete my-dev-vm
+
+# Detect system state (useful for scripting)
+clonebox detect --json
+```
+
+## Usage Examples
+
+### Python Development Environment
+
+```bash
+clonebox create --name python-dev --config '{
+  "paths": {
+    "/home/user/my-python-project": "/workspace",
+    "/home/user/.pyenv": "/root/.pyenv"
+  },
+  "packages": ["python3", "python3-pip", "python3-venv", "build-essential"],
+  "services": []
+}' --ram 2048 --start
+```
+
+### Docker Development
+
+```bash
+clonebox create --name docker-dev --config '{
+  "paths": {
+    "/home/user/docker-projects": "/projects",
+    "/var/run/docker.sock": "/var/run/docker.sock"
+  },
+  "packages": ["docker.io", "docker-compose"],
+  "services": ["docker"]
+}' --ram 4096 --start
+```
+
+### Full Stack (Node.js + PostgreSQL)
+
+```bash
+clonebox create --name fullstack --config '{
+  "paths": {
+    "/home/user/my-app": "/app",
+    "/home/user/pgdata": "/var/lib/postgresql/data"
+  },
+  "packages": ["nodejs", "npm", "postgresql"],
+  "services": ["postgresql"]
+}' --ram 4096 --vcpus 4 --start
+```
+
+## Inside the VM
+
+After the VM boots, mount shared directories:
+
+```bash
+# Mount shared paths (9p filesystem)
+sudo mkdir -p /mnt/projects
+sudo mount -t 9p -o trans=virtio,version=9p2000.L mount0 /mnt/projects
+
+# Or add to /etc/fstab for permanent mount
+echo "mount0 /mnt/projects 9p trans=virtio,version=9p2000.L 0 0" | sudo tee -a /etc/fstab
+```
+
+## Architecture
+
+```
+┌────────────────────────────────────────────────────────┐
+│                     HOST SYSTEM                        │
+│  ┌──────────────┐  ┌──────────────┐  ┌──────────────┐  │
+│  │ /home/user/  │  │  /var/www/   │  │   Docker     │  │
+│  │  projects/   │  │    html/     │  │   Socket     │  │
+│  └──────┬───────┘  └──────┬───────┘  └──────┬───────┘  │
+│         │                 │                 │          │
+│         │    9p/virtio    │                 │          │
+│         │   bind mounts   │                 │          │
+│  ┌──────▼─────────────────▼─────────────────▼───────┐  │
+│  │               CloneBox VM                        │  │
+│  │  ┌────────────┐ ┌────────────┐ ┌────────────┐    │  │
+│  │  │ /mnt/proj  │ │ /mnt/www   │ │ /var/run/  │    │  │
+│  │  │            │ │            │ │ docker.sock│    │  │
+│  │  └────────────┘ └────────────┘ └────────────┘    │  │
+│  │                                                  │  │
+│  │  cloud-init installed packages & services        │  │
+│  └──────────────────────────────────────────────────┘  │
+└────────────────────────────────────────────────────────┘
+```
+
+## Quick Clone (Recommended)
+
+The fastest way to clone your current working directory:
+
+```bash
+# Clone current directory - generates .clonebox.yaml and asks to create VM
+clonebox clone .
+
+# Clone specific path
+clonebox clone ~/projects/my-app
+
+# Clone with custom name and auto-start
+clonebox clone ~/projects/my-app --name my-dev-vm --run
+
+# Clone and edit config before creating
+clonebox clone . --edit
+```
+
+Later, start the VM from any directory with `.clonebox.yaml`:
+
+```bash
+# Start VM from config in current directory
+clonebox start .
+
+# Start VM from specific path
+clonebox start ~/projects/my-app
+```
+
+### Export YAML Config
+
+```bash
+# Export detected state as YAML (with deduplication)
+clonebox detect --yaml --dedupe
+
+# Save to file
+clonebox detect --yaml --dedupe -o my-config.yaml
+```
+
+## Commands Reference
+
+| Command | Description |
+|---------|-------------|
+| `clonebox` | Interactive VM creation wizard |
+| `clonebox clone <path>` | Generate `.clonebox.yaml` from path + running processes |
+| `clonebox clone . --run` | Clone and immediately start VM |
+| `clonebox clone . --edit` | Clone, edit config, then create |
+| `clonebox start .` | Start VM from `.clonebox.yaml` in current dir |
+| `clonebox start <name>` | Start existing VM by name |
+| `clonebox stop <name>` | Stop a VM (graceful shutdown) |
+| `clonebox stop -f <name>` | Force stop a VM |
+| `clonebox delete <name>` | Delete VM and storage |
+| `clonebox list` | List all VMs |
+| `clonebox detect` | Show detected services/apps/paths |
+| `clonebox detect --yaml` | Output as YAML config |
+| `clonebox detect --yaml --dedupe` | YAML with duplicates removed |
+| `clonebox detect --json` | Output as JSON |
+
+## Requirements
+
+- Linux with KVM support (`/dev/kvm`)
+- libvirt daemon running
+- Python 3.8+
+- User in `libvirt` group
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file.

clonebox-0.1.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+clonebox/__init__.py,sha256=IOk7G0DiSQ33EGbFC0xbnnFB9aou_6yuyFxvycQEvA0,407
+clonebox/cli.py,sha256=Zk9D99G2Zcaeb0Pw3eNhv0EtLYKPcpE0GyB3QtuhvgQ,31625
+clonebox/cloner.py,sha256=qfMpx7tS5Eozvhi2ZzBc5GY6HLYotncuMakeknHnTwo,18099
+clonebox/detector.py,sha256=Umg4CRJU61yV3a1AvR_0tOfjBMCCIbiQdDAAhlrOL5k,11916
+clonebox-0.1.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+clonebox-0.1.2.dist-info/METADATA,sha256=YtSqXudDO6TrPtAZzbP5fbMvf-PHarUpkY55ZGpHplw,10374
+clonebox-0.1.2.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+clonebox-0.1.2.dist-info/entry_points.txt,sha256=FES95Vi3btfViLEEoHdb8nikNxTqzaooi9ehZw9ZfWI,47
+clonebox-0.1.2.dist-info/top_level.txt,sha256=LdMo2cvCrEcRGH2M8JgQNVsCoszLV0xug6kx1JnaRjo,9
+clonebox-0.1.2.dist-info/RECORD,,

clonebox-0.1.1.dist-info/METADATA

@@ -1,40 +0,0 @@
-Metadata-Version: 2.4
-Name: clonebox
-Version: 0.1.1
-Summary: Clone your workstation environment to an isolated VM with selective apps, paths and services
-Author: CloneBox Team
-License: MIT
-Project-URL: Homepage, https://github.com/wronai/clonebox
-Project-URL: Repository, https://github.com/wronai/clonebox
-Project-URL: Issues, https://github.com/wronai/clonebox/issues
-Keywords: vm,virtualization,libvirt,clone,workstation,qemu,kvm
-Classifier: Development Status :: 4 - Beta
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: System Administrators
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: POSIX :: Linux
-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: Topic :: System :: Systems Administration
-Classifier: Topic :: Utilities
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: libvirt-python>=9.0.0
-Requires-Dist: rich>=13.0.0
-Requires-Dist: questionary>=2.0.0
-Requires-Dist: psutil>=5.9.0
-Requires-Dist: pyyaml>=6.0
-Provides-Extra: dev
-Requires-Dist: pytest>=7.0.0; extra == "dev"
-Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
-Requires-Dist: black>=23.0.0; extra == "dev"
-Requires-Dist: ruff>=0.1.0; extra == "dev"
-Dynamic: license-file
-
-# clonebox

clonebox-0.1.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-clonebox/__init__.py,sha256=IOk7G0DiSQ33EGbFC0xbnnFB9aou_6yuyFxvycQEvA0,407
-clonebox/cloner.py,sha256=SamhrCJoJ-k_u4b-yvpNCmr_IHpSrVjlo826lq4fD2M,14523
-clonebox/detector.py,sha256=dwtMg2FybGR79c3xce5PXNfrQgMpH4HK-nEsNfucPms,11835
-clonebox-0.1.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-clonebox-0.1.1.dist-info/METADATA,sha256=NQWcmpWvadnOr-UC3Ge3yYMD5vo7ClIcYUFiAXagxuA,1570
-clonebox-0.1.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-clonebox-0.1.1.dist-info/entry_points.txt,sha256=FES95Vi3btfViLEEoHdb8nikNxTqzaooi9ehZw9ZfWI,47
-clonebox-0.1.1.dist-info/top_level.txt,sha256=LdMo2cvCrEcRGH2M8JgQNVsCoszLV0xug6kx1JnaRjo,9
-clonebox-0.1.1.dist-info/RECORD,,