maqet 0.0.1.4__py3-none-any.whl → 0.0.5__py3-none-any.whl

maqet-0.0.5.dist-info/METADATA

@@ -0,0 +1,237 @@
+Metadata-Version: 2.4
+Name: maqet
+Version: 0.0.5
+Summary: M4x0n's QEMU Tool - A Python-based QEMU automation framework for VM running
+Author: Max Rogol
+Maintainer: Max Rogol
+License-Expression: MIT
+Project-URL: Repository, https://github.com/m4x0n/maqet
+Project-URL: Documentation, https://github.com/m4x0n/maqet/blob/main/README.md
+Project-URL: Issues, https://github.com/m4x0n/maqet/issues
+Keywords: qemu,virtualization,vm
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Utilities
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-benedict>=0.33.2
+Requires-Dist: PyYAML>=6.0.2
+Provides-Extra: qemu
+Requires-Dist: qemu.qmp>=3.0.0; extra == "qemu"
+Provides-Extra: tables
+Requires-Dist: tabulate>=0.9.0; extra == "tables"
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-testmon; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: tabulate>=0.9.0; extra == "dev"
+Dynamic: license-file
+
+# MAQET
+
+**MAQET** (M4x0n's QEMU Tool) is a VM management system that implements unified API generation. Methods decorated with `@api_method` automatically become CLI commands, Python API methods, and configuration-driven calls.
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install maqet
+```
+
+**Optional Dependencies:**
+
+- `psutil` - Enhanced process management and validation (recommended)
+
+  ```bash
+  pip install psutil
+  ```
+
+  Without psutil, basic PID tracking still works but ownership validation is skipped.
+
+### Core Concept
+
+Write once, use everywhere. A single method becomes a CLI command, Python API, and configuration option:
+
+```python
+@api_method(cli_name="start", description="Start a virtual machine", category="vm")
+def start(self, vm_id: str, detach: bool = False):
+    """Start a virtual machine."""
+    # Single implementation
+```
+
+This automatically creates:
+
+- **CLI**: `maqet start myvm --detach`
+- **Python API**: `maqet.start("myvm", detach=True)`
+- **Config**: VM settings only (no commands in YAML)
+
+## Usage
+
+### Command Line Interface
+
+```bash
+# Create a VM
+maqet add --config config.yaml --name myvm
+
+# Start VM
+maqet start myvm
+
+# List all VMs
+maqet ls
+
+# Check VM status
+maqet status myvm
+
+# Execute QMP command
+maqet qmp myvm system_powerdown
+
+# Remove VM
+maqet rm myvm --force
+```
+
+### Python API
+
+```python
+from maqet import Maqet
+
+maqet = Maqet()
+
+# Create and start VM
+vm_id = maqet.add(name='myvm', memory='4G', cpu=2)
+maqet.start(vm_id)
+
+# Manage VM
+status = maqet.status(vm_id)
+maqet.qmp(vm_id, 'system_powerdown')
+maqet.rm(vm_id, force=True)
+```
+
+### Configuration Files
+
+```yaml
+# config.yaml - VM configuration only
+name: myvm
+binary: /usr/bin/qemu-system-x86_64
+memory: 4G
+cpu: 2
+storage:
+  - name: hdd
+    size: 20G
+    type: qcow2
+    interface: virtio
+```
+
+```bash
+# Use configuration file
+maqet add --config config.yaml
+maqet start myvm --detach
+```
+
+**Configuration Features:**
+
+- Deep-merge multiple config files
+- Lists are concatenated (storage, network)
+- Command-line args override config values
+- Full QEMU argument support
+
+See [Configuration Guide](docs/user-guide/configuration.md) for details.
+
+## Core Commands
+
+| Command | Description | Example |
+|---------|-------------|---------|
+| `add` | Create new VM | `maqet add --config config.yaml --name myvm` |
+| `start` | Start VM | `maqet start myvm` |
+| `stop` | Stop VM | `maqet stop myvm --force` |
+| `rm` | Remove VM | `maqet rm myvm --force` |
+| `ls` | List VMs | `maqet ls --status running` |
+| `status` | Show VM status | `maqet status myvm` |
+| `apply` | Apply configuration | `maqet apply myvm --memory 8G` |
+| `snapshot` | Manage snapshots | `maqet snapshot myvm create hdd snap1` |
+
+### QMP Commands
+
+| Command | Description | Example |
+|---------|-------------|---------|
+| `qmp keys` | Send key combination | `maqet qmp keys myvm ctrl alt f2` |
+| `qmp type` | Type text to VM | `maqet qmp type myvm "hello world"` |
+| `qmp screendump` | Take screenshot | `maqet qmp screendump myvm screenshot.ppm` |
+| `qmp pause` | Pause VM | `maqet qmp pause myvm` |
+| `qmp resume` | Resume VM | `maqet qmp resume myvm` |
+| `qmp device-add` | Hot-plug device | `maqet qmp device-add myvm usb-storage` |
+| `qmp device-del` | Hot-unplug device | `maqet qmp device-del myvm usb1` |
+
+### Global Options
+
+| Option | Description |
+|--------|-------------|
+| `-v, --verbose` | Increase verbosity (-v, -vv, -vvv) |
+| `-q, --quiet` | Suppress non-error output |
+| `--data-dir` | Override data directory |
+| `--log-file` | Enable file logging |
+
+## Documentation
+
+### Full Documentation
+
+- **[Documentation Index](docs/README.md)** - Complete documentation portal
+- **[Architecture](docs/architecture/)** - Internal architecture and design
+- **[Development](docs/development/)** - Contributing and development guides
+- **[Deployment](docs/deployment/)** - Production deployment
+- **[Reference](docs/reference/)** - Technical references
+
+### Architecture
+
+- **Unified API System** - Single methods generate CLI, Python API, and config
+- **State Management** - SQLite backend with XDG compliance
+- **QEMU Integration** - Full QMP protocol support
+- **Storage System** - QCOW2, Raw, VirtFS support with snapshots
+
+See [QEMU Internal Architecture](docs/architecture/QEMU_INTERNAL_ARCHITECTURE.md) for details.
+
+### Development
+
+```bash
+# Run tests
+python tests/run_tests.py
+
+# Run pre-commit checks
+pre-commit run --all-files
+```
+
+See [Testing Guide](docs/development/TESTING.md) for details on running tests and contributing.
+
+### Roadmap
+
+See [Roadmap](docs/development/ROADMAP.md) and [Future Features](docs/development/FUTURE_FEATURES.md) for planned improvements.
+
+## Features
+
+- **Write Once, Use Everywhere** - Single method for CLI, API, and config
+- **XDG Compliant** - Follows Linux directory standards
+- **Production Ready** - Security hardened, tested, robust error handling
+- **Full QMP Support** - Complete QEMU Machine Protocol integration
+- **Snapshot Management** - Create, load, list, and delete snapshots
+- **Hot-plug Support** - Add/remove devices while VM is running
+
+## Contributing
+
+Contributions welcome! See [Development Guide](docs/development/) for contributing guidelines.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.

maqet-0.0.5.dist-info/RECORD

@@ -0,0 +1,55 @@
+maqet/__init__.py,sha256=9D0pu897AZ7QRXp_9m9VGqZPChrIc0J74SD7-6_wWQE,1635
+maqet/__main__.py,sha256=lZPzTVQaTF1Wd7HatKbLxQVbor8RaQaJObWaCY97F9c,2573
+maqet/__version__.py,sha256=z85BMRCM_1zI8rVf8B1JAWN9Pp4eDYrp2cabRrxeJWo,60
+maqet/cli.py,sha256=saZioU6IYiC_meYh1_XGnBQuS9uXSznEqqczSBT5VhA,1891
+maqet/config_handlers.py,sha256=qfsxMO8SbrgPiMkPU5rtNIXQhpb0Vcfw2tKkda6UPs0,28249
+maqet/constants.py,sha256=AxaBzSByXdyvd1hkmY1DyAzfuUFJayLZ8JFNLdmwUFc,5250
+maqet/exceptions.py,sha256=G3DtdaX0myyF3t1K4to4bTAviE2iNcXGftJ14BWucko,5407
+maqet/formatters.py,sha256=pyyXztPg-VSplIfxK81g4a_-7rCyhILFGPBv_gaVt78,9001
+maqet/logger.py,sha256=EgQl48uv2qxRbQfzPOYCvpGEukNYd9Q5eIis7FrVc6w,5417
+maqet/machine.py,sha256=IoUgKEb15n43T3NmwRcwe3OtDoOaMFaR_emJpBCVCtc,32322
+maqet/maqet.py,sha256=6I_hyvDjermX8o-Zao4c4R4R_Bfl-Kjf5kbfKFaO6F8,36638
+maqet/os_interactions.py,sha256=nLLnnuWVUh_41QiG0EPhlOydDTE44RQMLhYAqreV6AQ,1212
+maqet/process_spawner.py,sha256=TOAH0QZBW-CZjY4Nvt5oSWXxgY4iMwY0yIFt3gPXy6Q,12833
+maqet/qemu_args.py,sha256=7J0-qvUJPLAVbjKR1m8vH2o7ay9yvgxoRZwNA-5mm18,2359
+maqet/snapshot.py,sha256=Hlz8uMJVuoQhGl8CCl27Emux3E9yHKMfwXtVUrXy4GY,16269
+maqet/state.py,sha256=bxWJ_rv6LYJjObfX5UCHY32hi2QRDoirtiT_L6_k8zc,33634
+maqet/storage.py,sha256=eTM7GoV-zmpDq0ThK_cThcIwcMJSmRMasRwyZ9YxrLM,25804
+maqet/vm_runner.py,sha256=yVNmvQVAnVX12W8a-g60E25ix1FRBJxpPEdZJWyTKyY,17985
+maqet/api/__init__.py,sha256=VgP-LeRWxeOdZmESO1ugMz_fuXG8o-iJb5aQ4xtbMmA,1234
+maqet/api/decorators.py,sha256=bd72qw-2rqRrsqlEK0s9pFCzcRxY57qAJs-oMs_aRog,6072
+maqet/api/metadata.py,sha256=vGp-V7CI9b8PIr99azfBrwoV1TK9rpaj9ItFLWs8ZRo,4786
+maqet/api/registry.py,sha256=pQhSAZIz5FLwyu5rxYGDijoBwaWrDdIEtjO1uiKl55I,5962
+maqet/config/__init__.py,sha256=7QrAGSLnbhfdISNk1IM3yod8Ug7y6O1iZnT--pdeYgU,534
+maqet/config/merger.py,sha256=-ClcGMH5ZeWeElu_gNEDyVdBCpxWjke_FjUyiLqEf3s,8397
+maqet/config/parser.py,sha256=hQJ-1uOUILuafe38zzmcedXkSrmHuHn8GdKg4XMv_FU,6850
+maqet/config/validators.py,sha256=TEzraqWZ7sfXqiev0v5euVwAXEW7HUj8jIx9QCg5ofg,16497
+maqet/generators/__init__.py,sha256=xSBx-yp5Q1FfxgXA_-tMP2hLwrAL9kTJivnFDqLA31U,310
+maqet/generators/base_generator.py,sha256=Hd9ZOYekeDXsEYIkVhyGszJBWgtX4pIQtMkrRshvld4,2892
+maqet/generators/cli_generator.py,sha256=V4t_WPxZJGPv-A74NbSNaj9Zfp6vD_1fLAjh1R5TkS4,23080
+maqet/generators/python_generator.py,sha256=udgCoDczMZdAZYuB5VfzeZ51yGNhZMN2Eoya10s9dTQ,7725
+maqet/generators/rest_generator.py,sha256=ERNEjcWt0kKyw2cVYgFaxiOA_hX4nhivFJ-iMg404nc,1800
+maqet/handlers/__init__.py,sha256=mECVYMkGBnJgNsAjZHwk56sfJkUSklfnsa-EV7I9DdM,281
+maqet/handlers/base.py,sha256=3rT4w6I5H4rt7Fr3o709whGh_UZEcqBP0BG7qCODhfY,3491
+maqet/handlers/init.py,sha256=dkfizI37cJsZ7GMNnV0nrFBinunOBR-eQs-RMjz68HI,4671
+maqet/handlers/stage.py,sha256=6sRQ72sR6MPnQdUTfl75vrAKiLCbQIKAycReT8TG9IA,5557
+maqet/ipc/__init__.py,sha256=h7Z0abJvi8QbZ4We5Z9zNpwIh0V4ve7d-9YDVbNIrRA,704
+maqet/ipc/retry.py,sha256=2-GI5ScGTgQ8iDlrWXGeuOAEKzi9kH4aaG6WobUNg84,8968
+maqet/ipc/runner_client.py,sha256=yifYgiNLKdwFShxswFZGb3vaBpFswLPVsJWiKulAldg,9333
+maqet/ipc/unix_socket_server.py,sha256=uz020s88JM6bmUzsRDvc3wfhtUwr0oRVkPJch3CDKRU,7945
+maqet/managers/__init__.py,sha256=l2DCi2RH-5MgHxryQMfZ945YU8vI0Gc2vV1TkRMsef4,231
+maqet/managers/qmp_manager.py,sha256=NXUn5iB7sXH0UXocc5Z8VbUtIFuByKIWdkfIw4uabDI,10382
+maqet/managers/snapshot_coordinator.py,sha256=iVYVJSQa7tqtfN00ElZ8tacYYF_T55SrqM0FYzni-q0,11007
+maqet/managers/vm_manager.py,sha256=_6oIbnMO_3RAcB2KgPlWXik6pk-yew_ZKvUvWWKXJCc,24171
+maqet/qmp/__init__.py,sha256=nd0aNCjKd9YIgRmmS7Ltb6X2qn2o56kTq9UgzeRr_Y0,187
+maqet/qmp/commands.py,sha256=g5tHWK1XYQukCpiGkrHQJKmzJ99A7VC5Cmz1Tp29mxw,2238
+maqet/qmp/keyboard.py,sha256=gBsnaloceKp-T_XzaBCqu2uY0xcbtcvAab6MNE7V080,5521
+maqet/qmp/qmp.py,sha256=ABgV_Qpce4C2RMxpU5sbAbNRFdpNsz3LAAh9A-eLE9U,637
+maqet/validation/__init__.py,sha256=hdkYdm72DsKO0OJikHo_NIak_qz4PzP3rQfTekhXrKM,219
+maqet/validation/config_validator.py,sha256=ZZm-NRnFLCTTb6UAqnu2BRYWffw0oZbh3HI56Gi0RLc,5728
+maqet-0.0.5.dist-info/licenses/LICENSE,sha256=rOgOi9uqKq5-h53e_v1CuY7rQpxL8heKLrweLmnC5rI,1066
+maqet-0.0.5.dist-info/METADATA,sha256=oMfMTxgpJ8iMj9F7Sw7ygk-FQ3diakC9Uph6cQg1aAk,6874
+maqet-0.0.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+maqet-0.0.5.dist-info/entry_points.txt,sha256=CDsejhGOi9jDKmlxaIiDUSj208af6l0BmDQWboEdB4M,46
+maqet-0.0.5.dist-info/top_level.txt,sha256=qfP8Lh5LI3qwQ5XoATTR8UIYECuLUJRhB1sWjgqEH5I,6
+maqet-0.0.5.dist-info/RECORD,,

{maqet-0.0.1.4.dist-info → maqet-0.0.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (73.0.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

maqet-0.0.5.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+maqet = maqet.__main__:main

maqet-0.0.5.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Max Rogol
+
+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.

{maqet-0.0.1.4.dist-info → maqet-0.0.5.dist-info}/top_level.txt

@@ -1,2 +1 @@
 maqet
-qemu