vm-tool 1.0.27__tar.gz → 1.0.29__tar.gz

vm_tool-1.0.29/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: vm_tool
+Version: 1.0.29
+Summary: A Comprehensive Tool for Setting Up Virtual Machines.
+Home-page: https://github.com/thesunnysinha/vm_tool
+Author: Sunny Sinha
+Author-email: thesunnysinha@gmail.com
+License: MIT
+Project-URL: Documentation, https://github.com/thesunnysinha/vm_tool/README.md
+Project-URL: Source, https://github.com/thesunnysinha/vm_tool
+Project-URL: Tracker, https://github.com/thesunnysinha/vm_tool/issues
+Keywords: virtual machine setup ansible automation
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ansible
+Requires-Dist: ansible-runner
+Requires-Dist: paramiko
+Requires-Dist: pydantic
+Requires-Dist: pyyaml
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: bump2version; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# 🚀 VM Setup Tool
+
+[![PyPI version](https://img.shields.io/pypi/v/vm-tool.svg)](https://pypi.org/project/vm-tool/) [![Python versions](https://img.shields.io/pypi/pyversions/vm-tool.svg)](https://pypi.org/project/vm-tool/)
+
+[**PyPI**](https://pypi.org/project/vm-tool/) • [**GitHub**](https://github.com/thesunnysinha/vm_tool) • [**Contributing**](CONTRIBUTING) • [**License**](LICENSE)
+
+A modern, user-friendly solution for automating and managing virtual machine (VM) setup and configuration using Ansible.
+
+---
+
+## ✨ Features
+- Automated VM setup with Docker & Docker Compose
+- Cloud VM provisioning via SSH
+- SSH key management and configuration
+- Simple Python API for integration
+- One-command version check: `vm_tool --version`
+
+---
+
+## ⚡️ Installation
+Install the latest version from PyPI:
+
+```bash
+pip install vm-tool
+```
+
+---
+
+## 🛠️ Usage Examples
+
+### Automated Local VM Setup
+```python
+from vm_tool.runner import SetupRunner, SetupRunnerConfig
+
+config = SetupRunnerConfig(
+    github_username='your_github_username',
+    github_token='your_github_token',
+    github_project_url='your_github_project_url',
+    github_branch='your_branch_name',
+    docker_compose_file_path='path_to_your_docker_compose_file',
+    dockerhub_username='your_dockerhub_username',
+    dockerhub_password='your_dockerhub_password'
+)
+
+runner = SetupRunner(config)
+runner.run_setup()
+```
+
+### Cloud VM Setup (via SSH)
+```python
+from vm_tool.runner import SetupRunner, SetupRunnerConfig, SSHConfig
+
+config = SetupRunnerConfig(
+    github_username='your_github_username',
+    github_token='your_github_token',
+    github_project_url='your_github_project_url',
+    github_branch='your_branch_name',
+    docker_compose_file_path='path_to_your_docker_compose_file',
+    dockerhub_username='your_dockerhub_username',
+    dockerhub_password='your_dockerhub_password'
+)
+
+runner = SetupRunner(config)
+
+ssh_configs = [
+    SSHConfig(
+        ssh_username='your_ssh_username',
+        ssh_password='your_ssh_password',
+        ssh_hostname='your_ssh_hostname',
+        ssh_identity_file='/path/to/your/ssh_key'  # Optional
+    )
+]
+
+runner.run_cloud_setup(ssh_configs)
+```
+
+### SSH Key Management
+```python
+from vm_tool.ssh import SSHSetup
+
+ssh_setup = SSHSetup(
+    hostname='your_vm_hostname',
+    username='your_vm_username',
+    password='your_vm_password',
+    email='your_email_for_ssh_key'
+)
+
+ssh_setup.setup()
+```
+
+---
+
+## 🖥️ Command Line Version Check
+
+Check your installed version at any time:
+
+```bash
+vm_tool --version
+```
+
+---
+
+## ⚙️ Configuration Options
+- `github_username`: GitHub username (for private repos)
+- `github_token`: GitHub token (for private repos)
+- `github_project_url`: GitHub repository URL
+- `github_branch`: Branch to use (default: main)
+- `docker_compose_file_path`: Path to Docker Compose file (default: docker-compose.yml)
+- `dockerhub_username`: Docker Hub username (if login needed)
+- `dockerhub_password`: Docker Hub password (if login needed)
+
+---
+
+## 📚 Learn More
+See the [PyPI page](https://pypi.org/project/vm-tool/) for more details, or visit the [GitHub repository](https://github.com/thesunnysinha/vm_tool) for full documentation, issues, and contributions.
+
+---
+
+Empower your infrastructure automation with **VM Setup Tool** – fast, reliable, and developer-friendly!

vm_tool-1.0.29/README.md

@@ -0,0 +1,119 @@
+# 🚀 VM Setup Tool
+
+[![PyPI version](https://img.shields.io/pypi/v/vm-tool.svg)](https://pypi.org/project/vm-tool/) [![Python versions](https://img.shields.io/pypi/pyversions/vm-tool.svg)](https://pypi.org/project/vm-tool/)
+
+[**PyPI**](https://pypi.org/project/vm-tool/) • [**GitHub**](https://github.com/thesunnysinha/vm_tool) • [**Contributing**](CONTRIBUTING) • [**License**](LICENSE)
+
+A modern, user-friendly solution for automating and managing virtual machine (VM) setup and configuration using Ansible.
+
+---
+
+## ✨ Features
+- Automated VM setup with Docker & Docker Compose
+- Cloud VM provisioning via SSH
+- SSH key management and configuration
+- Simple Python API for integration
+- One-command version check: `vm_tool --version`
+
+---
+
+## ⚡️ Installation
+Install the latest version from PyPI:
+
+```bash
+pip install vm-tool
+```
+
+---
+
+## 🛠️ Usage Examples
+
+### Automated Local VM Setup
+```python
+from vm_tool.runner import SetupRunner, SetupRunnerConfig
+
+config = SetupRunnerConfig(
+    github_username='your_github_username',
+    github_token='your_github_token',
+    github_project_url='your_github_project_url',
+    github_branch='your_branch_name',
+    docker_compose_file_path='path_to_your_docker_compose_file',
+    dockerhub_username='your_dockerhub_username',
+    dockerhub_password='your_dockerhub_password'
+)
+
+runner = SetupRunner(config)
+runner.run_setup()
+```
+
+### Cloud VM Setup (via SSH)
+```python
+from vm_tool.runner import SetupRunner, SetupRunnerConfig, SSHConfig
+
+config = SetupRunnerConfig(
+    github_username='your_github_username',
+    github_token='your_github_token',
+    github_project_url='your_github_project_url',
+    github_branch='your_branch_name',
+    docker_compose_file_path='path_to_your_docker_compose_file',
+    dockerhub_username='your_dockerhub_username',
+    dockerhub_password='your_dockerhub_password'
+)
+
+runner = SetupRunner(config)
+
+ssh_configs = [
+    SSHConfig(
+        ssh_username='your_ssh_username',
+        ssh_password='your_ssh_password',
+        ssh_hostname='your_ssh_hostname',
+        ssh_identity_file='/path/to/your/ssh_key'  # Optional
+    )
+]
+
+runner.run_cloud_setup(ssh_configs)
+```
+
+### SSH Key Management
+```python
+from vm_tool.ssh import SSHSetup
+
+ssh_setup = SSHSetup(
+    hostname='your_vm_hostname',
+    username='your_vm_username',
+    password='your_vm_password',
+    email='your_email_for_ssh_key'
+)
+
+ssh_setup.setup()
+```
+
+---
+
+## 🖥️ Command Line Version Check
+
+Check your installed version at any time:
+
+```bash
+vm_tool --version
+```
+
+---
+
+## ⚙️ Configuration Options
+- `github_username`: GitHub username (for private repos)
+- `github_token`: GitHub token (for private repos)
+- `github_project_url`: GitHub repository URL
+- `github_branch`: Branch to use (default: main)
+- `docker_compose_file_path`: Path to Docker Compose file (default: docker-compose.yml)
+- `dockerhub_username`: Docker Hub username (if login needed)
+- `dockerhub_password`: Docker Hub password (if login needed)
+
+---
+
+## 📚 Learn More
+See the [PyPI page](https://pypi.org/project/vm-tool/) for more details, or visit the [GitHub repository](https://github.com/thesunnysinha/vm_tool) for full documentation, issues, and contributions.
+
+---
+
+Empower your infrastructure automation with **VM Setup Tool** – fast, reliable, and developer-friendly!

{vm_tool-1.0.27 → vm_tool-1.0.29}/setup.py

@@ -11,7 +11,7 @@ else:
 
 setup(
     name='vm_tool',
-    version='1.0.27',  # This will be updated by bump2version
+    version='1.0.29',  # This will be updated by bump2version
     packages=find_packages(),
     description='A Comprehensive Tool for Setting Up Virtual Machines.',
     long_description=long_description,
@@ -41,11 +41,6 @@ setup(
         'Intended Audience :: System Administrators',
         'License :: OSI Approved :: MIT License',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
-        'Programming Language :: Python :: 3.9',
         'Programming Language :: Python :: 3.10',
         'Programming Language :: Python :: 3.11',
         'Programming Language :: Python :: 3.12',

vm_tool-1.0.29/vm_tool/cli.py

@@ -0,0 +1,9 @@
+import argparse
+
+def main():
+    parser = argparse.ArgumentParser(description='VM Tool version info')
+    parser.add_argument('--version', action='version', version='1.0.29')
+    parser.parse_args()
+
+if __name__ == '__main__':
+    main()

{vm_tool-1.0.27 → vm_tool-1.0.29}/vm_tool/runner.py

@@ -2,7 +2,7 @@ import sys
 import ansible_runner
 import os
 import yaml
-from pydantic import BaseModel, validator, model_validator
+from pydantic import BaseModel, validator, model_validator, Field
 from typing import List, Optional
 
 class SetupRunnerConfig(BaseModel):
@@ -19,13 +19,23 @@ class SetupRunnerConfig(BaseModel):
         dockerhub_password (Optional[str]): DockerHub password (required if username is provided).
     """
 
-    github_username: Optional[str] = None
-    github_token: Optional[str] = None
-    github_project_url: str
-    github_branch: str = "main"  # Default to main branch
-    docker_compose_file_path: str = 'docker-compose.yml'
-    dockerhub_username: Optional[str] = None
-    dockerhub_password: Optional[str] = None
+    github_username: Optional[str] = Field(
+        default=None, description="GitHub username for authentication (optional)"
+    )
+    github_token: Optional[str] = Field(
+        default=None, description="GitHub token for authentication (optional)"
+    )
+    github_project_url: str = Field(..., description="URL of the GitHub repository")
+    github_branch: str = Field(default='main', description="GitHub branch to use (default: 'main')")
+    docker_compose_file_path: str = Field(
+        default='docker-compose.yml', description="Path to the Docker Compose file (default: 'docker-compose.yml')"
+    )
+    dockerhub_username: Optional[str] = Field(
+        default=None, description="DockerHub username (optional)"
+    )
+    dockerhub_password: Optional[str] = Field(
+        default=None, description="DockerHub password (required if username is provided)"
+    )
 
     @validator('docker_compose_file_path', pre=True, always=True)
     def set_default_docker_compose_file_path(cls, v):
@@ -71,10 +81,14 @@ class SSHConfig(BaseModel):
         ssh_identity_file (Optional[str]): Path to SSH private key file (optional if password is provided).
     """
 
-    ssh_username: str
-    ssh_hostname: str
-    ssh_password: Optional[str] = None
-    ssh_identity_file: Optional[str] = None
+    ssh_username: str = Field(..., description="SSH username")
+    ssh_hostname: str = Field(..., description="SSH host/IP")
+    ssh_password: Optional[str] = Field(
+        default=None, description="SSH password (optional if identity file is provided)"
+    )
+    ssh_identity_file: Optional[str] = Field(
+        default=None, description="Path to SSH private key file (optional if password is provided)"
+    )
 
     @model_validator(mode="before")
     def validate_authentication(cls, values):

vm_tool-1.0.29/vm_tool/vm_setup/github/git_configuration.yml

@@ -0,0 +1,73 @@
+- name: Git Configuration Playbook
+  block:
+    - name: Ensure Git is installed
+      package:
+        name: git
+        state: present
+      become: yes
+    
+    # --- Extract Project Name from GITHUB_PROJECT_URL ---
+    - name: Extract project name from GITHUB_PROJECT_URL
+      set_fact:
+        project_name: "{{ GITHUB_PROJECT_URL | basename | regex_replace('\\.git$', '') }}"
+
+    # --- Git Credential Setup ---
+    - name: Check if Git credentials file exists
+      stat:
+        path: ~/.git-credentials
+      register: git_credentials_stat
+
+    - name: Read contents of Git credentials file
+      slurp:
+        src: ~/.git-credentials
+      register: git_credentials_content
+      when: git_credentials_stat.stat.exists
+
+    - name: Decode Git credentials content
+      set_fact:
+        git_credentials: "{{ git_credentials_content.content | b64decode }}"
+      when: git_credentials_stat.stat.exists
+
+    - name: Fail if Git credentials not configured and vars not provided
+      fail:
+        msg: >
+          Git credentials not found and GITHUB_USERNAME/GITHUB_TOKEN not provided. Aborting.
+      when: >
+        (not git_credentials_stat.stat.exists or
+        ("{{ GITHUB_USERNAME }}" not in git_credentials | default(''))) and
+        (GITHUB_USERNAME is not defined or GITHUB_TOKEN is not defined)
+
+    - name: Configure Git with GitHub token if not already configured
+      shell: |
+        git config --global credential.helper store
+        echo "https://{{ GITHUB_USERNAME }}:{{ GITHUB_TOKEN }}@github.com" > ~/.git-credentials
+      become: yes
+      when: >
+        (not git_credentials_stat.stat.exists or
+        ("{{ GITHUB_USERNAME }}" not in git_credentials | default(''))) and
+        (GITHUB_USERNAME is defined and GITHUB_TOKEN is defined)
+
+    # --- Git Clone or Pull Logic ---
+    - name: Check if .git directory exists (repo already cloned)
+      stat:
+        path: "{{ project_dest_dir }}/.git"
+      register: project_dir_stat
+
+    - name: Pull latest changes if repository already exists
+      shell: |
+        cd {{ project_dest_dir }}
+        git remote set-url origin {{ GITHUB_PROJECT_URL }}
+        git fetch origin
+        git checkout {{ GITHUB_BRANCH }}
+        git pull origin {{ GITHUB_BRANCH }}
+      when: project_dir_stat.stat.exists
+      become: yes
+
+    - name: Clone the Project repository if not already cloned
+      git:
+        repo: "{{ GITHUB_PROJECT_URL }}"
+        dest: "{{ project_dest_dir }}"
+        version: "{{ GITHUB_BRANCH }}"
+        depth: 1
+      when: not project_dir_stat.stat.exists
+      become: yes

vm_tool-1.0.29/vm_tool/vm_setup/project_service.yml

@@ -0,0 +1,17 @@
+- name: Project Service Playbook
+  block:
+    - name: Set systemd service unit variables
+      set_fact:
+        systemd_unit_name: "{{ project_name }}-{{ branch_name }}.service"
+        systemd_unit_path: "/etc/systemd/system/{{ systemd_unit_name }}.service"
+
+    - name: Create Docker Service 
+      include_tasks: docker/create_docker_service.yml
+
+    - name: Enable and start service
+      ansible.builtin.systemd:
+        name: "{{ systemd_unit_name }}"
+        state: started
+        enabled: yes
+      become: yes
+      ignore_errors: yes

vm_tool-1.0.29/vm_tool.egg-info/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: vm_tool
+Version: 1.0.29
+Summary: A Comprehensive Tool for Setting Up Virtual Machines.
+Home-page: https://github.com/thesunnysinha/vm_tool
+Author: Sunny Sinha
+Author-email: thesunnysinha@gmail.com
+License: MIT
+Project-URL: Documentation, https://github.com/thesunnysinha/vm_tool/README.md
+Project-URL: Source, https://github.com/thesunnysinha/vm_tool
+Project-URL: Tracker, https://github.com/thesunnysinha/vm_tool/issues
+Keywords: virtual machine setup ansible automation
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ansible
+Requires-Dist: ansible-runner
+Requires-Dist: paramiko
+Requires-Dist: pydantic
+Requires-Dist: pyyaml
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: bump2version; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# 🚀 VM Setup Tool
+
+[![PyPI version](https://img.shields.io/pypi/v/vm-tool.svg)](https://pypi.org/project/vm-tool/) [![Python versions](https://img.shields.io/pypi/pyversions/vm-tool.svg)](https://pypi.org/project/vm-tool/)
+
+[**PyPI**](https://pypi.org/project/vm-tool/) • [**GitHub**](https://github.com/thesunnysinha/vm_tool) • [**Contributing**](CONTRIBUTING) • [**License**](LICENSE)
+
+A modern, user-friendly solution for automating and managing virtual machine (VM) setup and configuration using Ansible.
+
+---
+
+## ✨ Features
+- Automated VM setup with Docker & Docker Compose
+- Cloud VM provisioning via SSH
+- SSH key management and configuration
+- Simple Python API for integration
+- One-command version check: `vm_tool --version`
+
+---
+
+## ⚡️ Installation
+Install the latest version from PyPI:
+
+```bash
+pip install vm-tool
+```
+
+---
+
+## 🛠️ Usage Examples
+
+### Automated Local VM Setup
+```python
+from vm_tool.runner import SetupRunner, SetupRunnerConfig
+
+config = SetupRunnerConfig(
+    github_username='your_github_username',
+    github_token='your_github_token',
+    github_project_url='your_github_project_url',
+    github_branch='your_branch_name',
+    docker_compose_file_path='path_to_your_docker_compose_file',
+    dockerhub_username='your_dockerhub_username',
+    dockerhub_password='your_dockerhub_password'
+)
+
+runner = SetupRunner(config)
+runner.run_setup()
+```
+
+### Cloud VM Setup (via SSH)
+```python
+from vm_tool.runner import SetupRunner, SetupRunnerConfig, SSHConfig
+
+config = SetupRunnerConfig(
+    github_username='your_github_username',
+    github_token='your_github_token',
+    github_project_url='your_github_project_url',
+    github_branch='your_branch_name',
+    docker_compose_file_path='path_to_your_docker_compose_file',
+    dockerhub_username='your_dockerhub_username',
+    dockerhub_password='your_dockerhub_password'
+)
+
+runner = SetupRunner(config)
+
+ssh_configs = [
+    SSHConfig(
+        ssh_username='your_ssh_username',
+        ssh_password='your_ssh_password',
+        ssh_hostname='your_ssh_hostname',
+        ssh_identity_file='/path/to/your/ssh_key'  # Optional
+    )
+]
+
+runner.run_cloud_setup(ssh_configs)
+```
+
+### SSH Key Management
+```python
+from vm_tool.ssh import SSHSetup
+
+ssh_setup = SSHSetup(
+    hostname='your_vm_hostname',
+    username='your_vm_username',
+    password='your_vm_password',
+    email='your_email_for_ssh_key'
+)
+
+ssh_setup.setup()
+```
+
+---
+
+## 🖥️ Command Line Version Check
+
+Check your installed version at any time:
+
+```bash
+vm_tool --version
+```
+
+---
+
+## ⚙️ Configuration Options
+- `github_username`: GitHub username (for private repos)
+- `github_token`: GitHub token (for private repos)
+- `github_project_url`: GitHub repository URL
+- `github_branch`: Branch to use (default: main)
+- `docker_compose_file_path`: Path to Docker Compose file (default: docker-compose.yml)
+- `dockerhub_username`: Docker Hub username (if login needed)
+- `dockerhub_password`: Docker Hub password (if login needed)
+
+---
+
+## 📚 Learn More
+See the [PyPI page](https://pypi.org/project/vm-tool/) for more details, or visit the [GitHub repository](https://github.com/thesunnysinha/vm_tool) for full documentation, issues, and contributions.
+
+---
+
+Empower your infrastructure automation with **VM Setup Tool** – fast, reliable, and developer-friendly!

vm_tool-1.0.27/PKG-INFO

@@ -1,193 +0,0 @@
-Metadata-Version: 2.2
-Name: vm_tool
-Version: 1.0.27
-Summary: A Comprehensive Tool for Setting Up Virtual Machines.
-Home-page: https://github.com/thesunnysinha/vm_tool
-Author: Sunny Sinha
-Author-email: thesunnysinha@gmail.com
-License: MIT
-Project-URL: Documentation, https://github.com/thesunnysinha/vm_tool/README.md
-Project-URL: Source, https://github.com/thesunnysinha/vm_tool
-Project-URL: Tracker, https://github.com/thesunnysinha/vm_tool/issues
-Keywords: virtual machine setup ansible automation
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: System Administrators
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-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: Programming Language :: Python :: 3.13
-Classifier: Topic :: Software Development :: Build Tools
-Classifier: Topic :: System :: Systems Administration
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: ansible
-Requires-Dist: ansible-runner
-Requires-Dist: paramiko
-Requires-Dist: pydantic
-Requires-Dist: pyyaml
-Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: bump2version; extra == "dev"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: project-url
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# **VM Setup Tool**  
-### **A Comprehensive Solution for Streamlining Virtual Machine Configuration**
-
-## **Overview**  
-The **VM Setup Tool** is an efficient, user-friendly solution designed to simplify the process of setting up and managing virtual machines (VMs) using Ansible. Ideal for automating VM deployment and configuration, this tool ensures consistency and enhances operational efficiency across your infrastructure.
-
----
-
-## **Pre-requisites**  
-This tool supports projects utilizing **Docker Compose**.
-
----
-
-## **Installation**  
-Install the VM Setup Tool using **pip**, the Python package manager:  
-
-```bash
-pip install vm-tool
-```
-
----
-
-## **Example Usage**  
-
-### **Automated VM Setup**  
-Use the following example to configure and run the VM setup:  
-
-```python
-from vm_tool.runner import SetupRunner, SetupRunnerConfig
-
-config = SetupRunnerConfig(
-    github_username='your_github_username',  # Required if the repository is private, e.g., username
-    github_token='your_github_token',        # Required if the repository is private, e.g., token
-    github_project_url='your_github_project_url',  # e.g., https://github.com/username/repo
-    github_branch='your_branch_name',        # Optional, defaults to 'main'
-    docker_compose_file_path='path_to_your_docker_compose_file',  # Optional, defaults to 'docker-compose.yml'
-    dockerhub_username='your_dockerhub_username',  # Required if DockerHub login is needed, e.g., dockerhub_user
-    dockerhub_password='your_dockerhub_password'   # Required if DockerHub login is needed, e.g., dockerhub_password
-)
-
-runner = SetupRunner(config)
-
-runner.run_setup()
-```
-
-### **What Happens During Setup**  
-The VM Setup Tool will:  
-1. Configure Git with GitHub token if provided.
-2. Clone the specified GitHub repository to your local machine.  
-3. Install **Docker** if it’s not already available on the target machine.  
-4. Install **Docker Compose** for managing multi-container applications.  
-5. Log in to Docker Hub if credentials are provided.
-6. Create, enable, and start the Docker service.  
-7. Ensure the Docker container remains active, providing a robust environment for your applications.  
-
-By automating these tasks, the tool minimizes errors and saves time, allowing you to focus on development and deployment.
-
----
-
-## **Cloud Setup**  
-The **VM Setup Tool** also supports cloud setup for VMs. Use the following example to configure and run the cloud setup:
-
-```python
-from vm_tool.runner import SetupRunner, SetupRunnerConfig, SSHConfig
-
-config = SetupRunnerConfig(
-    github_username='your_github_username',  # Required if the repository is private, e.g., username
-    github_token='your_github_token',        # Required if the repository is private, e.g., token
-    github_project_url='your_github_project_url',  # e.g., https://github.com/username/repo
-    github_branch='your_branch_name',        # Optional, defaults to 'main'
-    docker_compose_file_path='path_to_your_docker_compose_file',  # Optional, defaults to 'docker-compose.yml'
-    dockerhub_username='your_dockerhub_username',  # Required if DockerHub login is needed, e.g., dockerhub_user
-    dockerhub_password='your_dockerhub_password'   # Required if DockerHub login is needed, e.g., dockerhub_password
-)
-
-runner = SetupRunner(config)
-
-ssh_configs = [
-    SSHConfig(
-        ssh_username='your_ssh_username_1',           # e.g., ssh_user_1
-        ssh_password='your_ssh_password_1',           # Optional, only use if you don’t want to use SSH key
-        ssh_hostname='your_ssh_hostname_1',           # e.g., ssh1.example.com
-        ssh_identity_file='/path/to/your/ssh_key_1'   # Optional, path to SSH Identity file
-    ),
-    SSHConfig(
-        ssh_username='your_ssh_username_2',           # e.g., ssh_user_2
-        ssh_password='your_ssh_password_2',           # Optional, only use if you don’t want to use SSH key
-        ssh_hostname='your_ssh_hostname_2',           # e.g., ssh2.example.com
-        ssh_identity_file='/path/to/your/ssh_key_2'   # Optional, path to SSH Identity file
-    )
-    # Add more SSHConfig instances as needed
-]
-
-runner.run_cloud_setup(ssh_configs)
-```
-
-### **What Happens During Cloud Setup**  
-When you run the cloud setup, the tool will:  
-1. Connect to the specified cloud VM using SSH.  
-2. Configure Git with GitHub token if provided.
-3. Clone the specified GitHub repository to the VM.  
-4. Install **Docker** if it’s not already available on the VM.  
-5. Install **Docker Compose** for managing multi-container applications.  
-6. Log in to Docker Hub if credentials are provided.
-7. Create, enable, and start the Docker service on the VM.  
-8. Ensure the Docker container remains active, providing a robust environment for your applications.  
-
----
-
-## **SSH Client Feature**  
-The **VM Setup Tool** also includes a dedicated **SSH client** feature to simplify the configuration of SSH access for VMs, including automated SSH key generation and management.
-
-### **Example Usage**  
-
-```python
-from vm_tool.ssh import SSHSetup
-
-ssh_setup = SSHSetup(
-    hostname='your_vm_hostname',  # e.g., vm.example.com
-    username='your_vm_username',  # e.g., user
-    password='your_vm_password',  # e.g., password
-    email='your_email_for_ssh_key'  # e.g., user@example.com
-)
-
-ssh_setup.setup()
-```
-
-### **What Happens During SSH Setup**  
-When you run the SSH setup, the tool will:  
-1. Generate an SSH key pair if none exists.  
-2. Read the public SSH key or create a new one if necessary.  
-3. Configure the VM by adding the public key to the VM's **authorized_keys** file.  
-4. Update the local SSH configuration file with the VM's details.  
-5. Establish an SSH connection to verify the setup.  
-6. Close the connection once setup is complete.  
-
----
-
-With its comprehensive features, the **VM Setup Tool** eliminates the hassle of manual configurations and enables seamless integration of VMs into your workflows. Start using the tool today to automate and optimize your virtual machine setup process.

vm_tool-1.0.27/README.md

@@ -1,139 +0,0 @@
-# **VM Setup Tool**  
-### **A Comprehensive Solution for Streamlining Virtual Machine Configuration**
-
-## **Overview**  
-The **VM Setup Tool** is an efficient, user-friendly solution designed to simplify the process of setting up and managing virtual machines (VMs) using Ansible. Ideal for automating VM deployment and configuration, this tool ensures consistency and enhances operational efficiency across your infrastructure.
-
----
-
-## **Pre-requisites**  
-This tool supports projects utilizing **Docker Compose**.
-
----
-
-## **Installation**  
-Install the VM Setup Tool using **pip**, the Python package manager:  
-
-```bash
-pip install vm-tool
-```
-
----
-
-## **Example Usage**  
-
-### **Automated VM Setup**  
-Use the following example to configure and run the VM setup:  
-
-```python
-from vm_tool.runner import SetupRunner, SetupRunnerConfig
-
-config = SetupRunnerConfig(
-    github_username='your_github_username',  # Required if the repository is private, e.g., username
-    github_token='your_github_token',        # Required if the repository is private, e.g., token
-    github_project_url='your_github_project_url',  # e.g., https://github.com/username/repo
-    github_branch='your_branch_name',        # Optional, defaults to 'main'
-    docker_compose_file_path='path_to_your_docker_compose_file',  # Optional, defaults to 'docker-compose.yml'
-    dockerhub_username='your_dockerhub_username',  # Required if DockerHub login is needed, e.g., dockerhub_user
-    dockerhub_password='your_dockerhub_password'   # Required if DockerHub login is needed, e.g., dockerhub_password
-)
-
-runner = SetupRunner(config)
-
-runner.run_setup()
-```
-
-### **What Happens During Setup**  
-The VM Setup Tool will:  
-1. Configure Git with GitHub token if provided.
-2. Clone the specified GitHub repository to your local machine.  
-3. Install **Docker** if it’s not already available on the target machine.  
-4. Install **Docker Compose** for managing multi-container applications.  
-5. Log in to Docker Hub if credentials are provided.
-6. Create, enable, and start the Docker service.  
-7. Ensure the Docker container remains active, providing a robust environment for your applications.  
-
-By automating these tasks, the tool minimizes errors and saves time, allowing you to focus on development and deployment.
-
----
-
-## **Cloud Setup**  
-The **VM Setup Tool** also supports cloud setup for VMs. Use the following example to configure and run the cloud setup:
-
-```python
-from vm_tool.runner import SetupRunner, SetupRunnerConfig, SSHConfig
-
-config = SetupRunnerConfig(
-    github_username='your_github_username',  # Required if the repository is private, e.g., username
-    github_token='your_github_token',        # Required if the repository is private, e.g., token
-    github_project_url='your_github_project_url',  # e.g., https://github.com/username/repo
-    github_branch='your_branch_name',        # Optional, defaults to 'main'
-    docker_compose_file_path='path_to_your_docker_compose_file',  # Optional, defaults to 'docker-compose.yml'
-    dockerhub_username='your_dockerhub_username',  # Required if DockerHub login is needed, e.g., dockerhub_user
-    dockerhub_password='your_dockerhub_password'   # Required if DockerHub login is needed, e.g., dockerhub_password
-)
-
-runner = SetupRunner(config)
-
-ssh_configs = [
-    SSHConfig(
-        ssh_username='your_ssh_username_1',           # e.g., ssh_user_1
-        ssh_password='your_ssh_password_1',           # Optional, only use if you don’t want to use SSH key
-        ssh_hostname='your_ssh_hostname_1',           # e.g., ssh1.example.com
-        ssh_identity_file='/path/to/your/ssh_key_1'   # Optional, path to SSH Identity file
-    ),
-    SSHConfig(
-        ssh_username='your_ssh_username_2',           # e.g., ssh_user_2
-        ssh_password='your_ssh_password_2',           # Optional, only use if you don’t want to use SSH key
-        ssh_hostname='your_ssh_hostname_2',           # e.g., ssh2.example.com
-        ssh_identity_file='/path/to/your/ssh_key_2'   # Optional, path to SSH Identity file
-    )
-    # Add more SSHConfig instances as needed
-]
-
-runner.run_cloud_setup(ssh_configs)
-```
-
-### **What Happens During Cloud Setup**  
-When you run the cloud setup, the tool will:  
-1. Connect to the specified cloud VM using SSH.  
-2. Configure Git with GitHub token if provided.
-3. Clone the specified GitHub repository to the VM.  
-4. Install **Docker** if it’s not already available on the VM.  
-5. Install **Docker Compose** for managing multi-container applications.  
-6. Log in to Docker Hub if credentials are provided.
-7. Create, enable, and start the Docker service on the VM.  
-8. Ensure the Docker container remains active, providing a robust environment for your applications.  
-
----
-
-## **SSH Client Feature**  
-The **VM Setup Tool** also includes a dedicated **SSH client** feature to simplify the configuration of SSH access for VMs, including automated SSH key generation and management.
-
-### **Example Usage**  
-
-```python
-from vm_tool.ssh import SSHSetup
-
-ssh_setup = SSHSetup(
-    hostname='your_vm_hostname',  # e.g., vm.example.com
-    username='your_vm_username',  # e.g., user
-    password='your_vm_password',  # e.g., password
-    email='your_email_for_ssh_key'  # e.g., user@example.com
-)
-
-ssh_setup.setup()
-```
-
-### **What Happens During SSH Setup**  
-When you run the SSH setup, the tool will:  
-1. Generate an SSH key pair if none exists.  
-2. Read the public SSH key or create a new one if necessary.  
-3. Configure the VM by adding the public key to the VM's **authorized_keys** file.  
-4. Update the local SSH configuration file with the VM's details.  
-5. Establish an SSH connection to verify the setup.  
-6. Close the connection once setup is complete.  
-
----
-
-With its comprehensive features, the **VM Setup Tool** eliminates the hassle of manual configurations and enables seamless integration of VMs into your workflows. Start using the tool today to automate and optimize your virtual machine setup process.

vm_tool-1.0.27/vm_tool/cli.py

@@ -1,14 +0,0 @@
-import argparse
-
-def main():
-    parser = argparse.ArgumentParser(description='Setup VMs using Ansible.')
-    parser.add_argument('--version', action='version', version='1.0.27')
-
-    args = parser.parse_args()
-
-    # If no arguments are provided, print the help message
-    if not vars(args):
-        parser.print_help()
-
-if __name__ == '__main__':
-    main()

vm_tool-1.0.27/vm_tool/vm_setup/github/git_configuration.yml

@@ -1,46 +0,0 @@
-- name: Git Configuration Playbook
-  block:
-    - name: Ensure Git is installed
-      package:
-        name: git
-        state: present
-      become: yes
-
-    - name: Configure Git with GitHub token
-      shell: |
-        git config --global credential.helper store
-        echo "https://{{ GITHUB_USERNAME }}:{{ GITHUB_TOKEN }}@github.com" > ~/.git-credentials
-      become: yes
-      when: GITHUB_TOKEN is defined and GITHUB_USERNAME is defined
-
-    - name: Check if project directory exists
-      stat:
-        path: "{{ project_dest_dir }}"
-      register: project_dir_stat
-
-    - name: Remove existing Project repository if present
-      file:
-        path: "{{ project_dest_dir }}"
-        state: absent
-        force: yes
-      become: yes
-      when: project_dir_stat.stat.exists
-
-    - name: Log the GitHub repository being cloned
-      debug:
-        msg: "Cloning repository from {{ GITHUB_PROJECT_URL }} (branch: {{ GITHUB_BRANCH }})"
-
-    - name: Ensure project directory is empty
-      file:
-        path: "{{ project_dest_dir }}"
-        state: directory
-        mode: '0755'
-      become: yes
-
-    - name: Clone the Project repository with shallow clone
-      git:
-        repo: "{{ GITHUB_PROJECT_URL }}"
-        dest: "{{ project_dest_dir }}"
-        version: "{{ GITHUB_BRANCH }}"
-        depth: 1
-      become: yes

vm_tool-1.0.27/vm_tool/vm_setup/project_service.yml

@@ -1,16 +0,0 @@
-- name: Project Service Playbook
-  block:
-    - name: Set service_file_path variable
-      set_fact:
-        service_file_path: /etc/systemd/system/project.service
-
-    - name: Create Docker Service
-      include_tasks: docker/create_docker_service.yml
-
-    - name: Enable and start project service
-      ansible.builtin.systemd:
-        name: project
-        state: started
-        enabled: yes
-      become: yes
-      ignore_errors: yes

vm_tool-1.0.27/vm_tool.egg-info/PKG-INFO

@@ -1,193 +0,0 @@
-Metadata-Version: 2.2
-Name: vm_tool
-Version: 1.0.27
-Summary: A Comprehensive Tool for Setting Up Virtual Machines.
-Home-page: https://github.com/thesunnysinha/vm_tool
-Author: Sunny Sinha
-Author-email: thesunnysinha@gmail.com
-License: MIT
-Project-URL: Documentation, https://github.com/thesunnysinha/vm_tool/README.md
-Project-URL: Source, https://github.com/thesunnysinha/vm_tool
-Project-URL: Tracker, https://github.com/thesunnysinha/vm_tool/issues
-Keywords: virtual machine setup ansible automation
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: System Administrators
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-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: Programming Language :: Python :: 3.13
-Classifier: Topic :: Software Development :: Build Tools
-Classifier: Topic :: System :: Systems Administration
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: ansible
-Requires-Dist: ansible-runner
-Requires-Dist: paramiko
-Requires-Dist: pydantic
-Requires-Dist: pyyaml
-Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: bump2version; extra == "dev"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: project-url
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# **VM Setup Tool**  
-### **A Comprehensive Solution for Streamlining Virtual Machine Configuration**
-
-## **Overview**  
-The **VM Setup Tool** is an efficient, user-friendly solution designed to simplify the process of setting up and managing virtual machines (VMs) using Ansible. Ideal for automating VM deployment and configuration, this tool ensures consistency and enhances operational efficiency across your infrastructure.
-
----
-
-## **Pre-requisites**  
-This tool supports projects utilizing **Docker Compose**.
-
----
-
-## **Installation**  
-Install the VM Setup Tool using **pip**, the Python package manager:  
-
-```bash
-pip install vm-tool
-```
-
----
-
-## **Example Usage**  
-
-### **Automated VM Setup**  
-Use the following example to configure and run the VM setup:  
-
-```python
-from vm_tool.runner import SetupRunner, SetupRunnerConfig
-
-config = SetupRunnerConfig(
-    github_username='your_github_username',  # Required if the repository is private, e.g., username
-    github_token='your_github_token',        # Required if the repository is private, e.g., token
-    github_project_url='your_github_project_url',  # e.g., https://github.com/username/repo
-    github_branch='your_branch_name',        # Optional, defaults to 'main'
-    docker_compose_file_path='path_to_your_docker_compose_file',  # Optional, defaults to 'docker-compose.yml'
-    dockerhub_username='your_dockerhub_username',  # Required if DockerHub login is needed, e.g., dockerhub_user
-    dockerhub_password='your_dockerhub_password'   # Required if DockerHub login is needed, e.g., dockerhub_password
-)
-
-runner = SetupRunner(config)
-
-runner.run_setup()
-```
-
-### **What Happens During Setup**  
-The VM Setup Tool will:  
-1. Configure Git with GitHub token if provided.
-2. Clone the specified GitHub repository to your local machine.  
-3. Install **Docker** if it’s not already available on the target machine.  
-4. Install **Docker Compose** for managing multi-container applications.  
-5. Log in to Docker Hub if credentials are provided.
-6. Create, enable, and start the Docker service.  
-7. Ensure the Docker container remains active, providing a robust environment for your applications.  
-
-By automating these tasks, the tool minimizes errors and saves time, allowing you to focus on development and deployment.
-
----
-
-## **Cloud Setup**  
-The **VM Setup Tool** also supports cloud setup for VMs. Use the following example to configure and run the cloud setup:
-
-```python
-from vm_tool.runner import SetupRunner, SetupRunnerConfig, SSHConfig
-
-config = SetupRunnerConfig(
-    github_username='your_github_username',  # Required if the repository is private, e.g., username
-    github_token='your_github_token',        # Required if the repository is private, e.g., token
-    github_project_url='your_github_project_url',  # e.g., https://github.com/username/repo
-    github_branch='your_branch_name',        # Optional, defaults to 'main'
-    docker_compose_file_path='path_to_your_docker_compose_file',  # Optional, defaults to 'docker-compose.yml'
-    dockerhub_username='your_dockerhub_username',  # Required if DockerHub login is needed, e.g., dockerhub_user
-    dockerhub_password='your_dockerhub_password'   # Required if DockerHub login is needed, e.g., dockerhub_password
-)
-
-runner = SetupRunner(config)
-
-ssh_configs = [
-    SSHConfig(
-        ssh_username='your_ssh_username_1',           # e.g., ssh_user_1
-        ssh_password='your_ssh_password_1',           # Optional, only use if you don’t want to use SSH key
-        ssh_hostname='your_ssh_hostname_1',           # e.g., ssh1.example.com
-        ssh_identity_file='/path/to/your/ssh_key_1'   # Optional, path to SSH Identity file
-    ),
-    SSHConfig(
-        ssh_username='your_ssh_username_2',           # e.g., ssh_user_2
-        ssh_password='your_ssh_password_2',           # Optional, only use if you don’t want to use SSH key
-        ssh_hostname='your_ssh_hostname_2',           # e.g., ssh2.example.com
-        ssh_identity_file='/path/to/your/ssh_key_2'   # Optional, path to SSH Identity file
-    )
-    # Add more SSHConfig instances as needed
-]
-
-runner.run_cloud_setup(ssh_configs)
-```
-
-### **What Happens During Cloud Setup**  
-When you run the cloud setup, the tool will:  
-1. Connect to the specified cloud VM using SSH.  
-2. Configure Git with GitHub token if provided.
-3. Clone the specified GitHub repository to the VM.  
-4. Install **Docker** if it’s not already available on the VM.  
-5. Install **Docker Compose** for managing multi-container applications.  
-6. Log in to Docker Hub if credentials are provided.
-7. Create, enable, and start the Docker service on the VM.  
-8. Ensure the Docker container remains active, providing a robust environment for your applications.  
-
----
-
-## **SSH Client Feature**  
-The **VM Setup Tool** also includes a dedicated **SSH client** feature to simplify the configuration of SSH access for VMs, including automated SSH key generation and management.
-
-### **Example Usage**  
-
-```python
-from vm_tool.ssh import SSHSetup
-
-ssh_setup = SSHSetup(
-    hostname='your_vm_hostname',  # e.g., vm.example.com
-    username='your_vm_username',  # e.g., user
-    password='your_vm_password',  # e.g., password
-    email='your_email_for_ssh_key'  # e.g., user@example.com
-)
-
-ssh_setup.setup()
-```
-
-### **What Happens During SSH Setup**  
-When you run the SSH setup, the tool will:  
-1. Generate an SSH key pair if none exists.  
-2. Read the public SSH key or create a new one if necessary.  
-3. Configure the VM by adding the public key to the VM's **authorized_keys** file.  
-4. Update the local SSH configuration file with the VM's details.  
-5. Establish an SSH connection to verify the setup.  
-6. Close the connection once setup is complete.  
-
----
-
-With its comprehensive features, the **VM Setup Tool** eliminates the hassle of manual configurations and enables seamless integration of VMs into your workflows. Start using the tool today to automate and optimize your virtual machine setup process.