# SpiceXtract
SpiceXtract is a command-line utility that facilitates the easy download of SPICE files for virtual machines hosted on
Proxmox. This tool is especially useful for developers and IT professionals who manage VMs and need to quickly access
SPICE connection files.
## Features
- Simple CLI for downloading SPICE files.
- Support for multiple Proxmox nodes and VMs.
- Secure password handling and optional SSL verification.
## Requirements
- Python 3.6 or later.
- `requests` and `urllib3` libraries.
## Installation
Clone the repository and install the dependencies:
```bash
git clone https://github.com/lHumaNl/SpiceXtract.git
cd SpiceXtract
pip install -r requirements.txt
```
Alternatively, you can install the package using pip:
```bash
pip install spicextract
```
## Usage
To use SpiceXtract, run the following command with the required parameters:
```bash
spicextract -s <server-url> -u <username> -p <password> -n <node> -i <vm_id> -o <output_file_name> [-v]
```
#### Arguments Table
| Argument | Description |
|-----------------------|-----------------------------------------------------------------------|
| `-s`, `--server` | Proxmox host URL. |
| `-u`, `--username` | Proxmox username (must include authentication realm, e.g., user@pam). |
| `-p`, `--password` | Proxmox password. |
| `-n`, `--node` | Proxmox node. |
| `-i`, `--vm_id` | VM ID. |
| `-o`, `--output_file` | Output SPICE file name (.vv extension is appended if not present). |
| `-v`, `--ssl_verify` | Optional. Verifies the SSL connection if flagged. |
Raw data
{
"_id": null,
"home_page": "https://github.com/lHumaNl/SpiceXtract",
"name": "spicextract",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "spice proxmox vm downloader",
"author": "lHumaNl",
"author_email": "fisher_sam@mail.ru",
"download_url": null,
"platform": null,
"description": "# SpiceXtract\n\nSpiceXtract is a command-line utility that facilitates the easy download of SPICE files for virtual machines hosted on\nProxmox. This tool is especially useful for developers and IT professionals who manage VMs and need to quickly access\nSPICE connection files.\n\n## Features\n\n- Simple CLI for downloading SPICE files.\n- Support for multiple Proxmox nodes and VMs.\n- Secure password handling and optional SSL verification.\n\n## Requirements\n\n- Python 3.6 or later.\n- `requests` and `urllib3` libraries.\n\n## Installation\n\nClone the repository and install the dependencies:\n\n```bash\ngit clone https://github.com/lHumaNl/SpiceXtract.git\ncd SpiceXtract\npip install -r requirements.txt\n```\n\nAlternatively, you can install the package using pip:\n\n```bash\npip install spicextract\n```\n\n## Usage\n\nTo use SpiceXtract, run the following command with the required parameters:\n\n```bash\nspicextract -s <server-url> -u <username> -p <password> -n <node> -i <vm_id> -o <output_file_name> [-v]\n```\n\n#### Arguments Table\n\n| Argument | Description |\n|-----------------------|-----------------------------------------------------------------------|\n| `-s`, `--server` | Proxmox host URL. |\n| `-u`, `--username` | Proxmox username (must include authentication realm, e.g., user@pam). |\n| `-p`, `--password` | Proxmox password. |\n| `-n`, `--node` | Proxmox node. |\n| `-i`, `--vm_id` | VM ID. |\n| `-o`, `--output_file` | Output SPICE file name (.vv extension is appended if not present). |\n| `-v`, `--ssl_verify` | Optional. Verifies the SSL connection if flagged. |\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Util for easy download SPICE file for Proxmox VMs",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/lHumaNl/SpiceXtract"
},
"split_keywords": [
"spice",
"proxmox",
"vm",
"downloader"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3863e2991e9680443af2c1fc46bc9eb8238f161b4347952940c3409c96ab9a8f",
"md5": "a9f6d0ba4bfe3c5a86e0be3475c57cbb",
"sha256": "cdede7a4b9c4d1ceb72afefe95d9c5559b38dd8ee1eeb3f5dfcf3e8f112a179d"
},
"downloads": -1,
"filename": "spicextract-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a9f6d0ba4bfe3c5a86e0be3475c57cbb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5256,
"upload_time": "2024-05-22T21:24:25",
"upload_time_iso_8601": "2024-05-22T21:24:25.386461Z",
"url": "https://files.pythonhosted.org/packages/38/63/e2991e9680443af2c1fc46bc9eb8238f161b4347952940c3409c96ab9a8f/spicextract-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-22 21:24:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lHumaNl",
"github_project": "SpiceXtract",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
"~=",
"2.32.2"
]
]
},
{
"name": "urllib3",
"specs": [
[
"~=",
"2.2.1"
]
]
}
],
"lcname": "spicextract"
}
JSON
