vm-tool 1.0.28__tar.gz → 1.0.30__tar.gz

vm_tool-1.0.30/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: vm_tool
+Version: 1.0.30
+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.30/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.30/examples/__init__.py

@@ -0,0 +1 @@
+# Example scripts package

vm_tool-1.0.30/examples/cloud/__init__.py

@@ -0,0 +1 @@
+# Cloud VM setup examples package

vm_tool-1.0.30/examples/cloud/ssh_identity_file.py

@@ -0,0 +1,24 @@
+"""
+Example: Cloud VM setup using SSH key authentication (public GitHub repo).
+- Connects to a remote VM using SSH key and runs setup from a public repo.
+"""
+from vm_tool.runner import SetupRunner, SetupRunnerConfig, SSHConfig
+
+def main():
+    config = SetupRunnerConfig(
+        github_project_url='https://github.com/username/public-repo',
+        github_branch='main',
+        docker_compose_file_path='docker-compose.yml'
+    )
+    runner = SetupRunner(config)
+    ssh_configs = [
+        SSHConfig(
+            ssh_username='your_ssh_username',
+            ssh_hostname='your_ssh_hostname',
+            ssh_identity_file='/path/to/your/ssh_key'
+        )
+    ]
+    runner.run_cloud_setup(ssh_configs)
+
+if __name__ == "__main__":
+    main()

vm_tool-1.0.30/examples/cloud/ssh_password.py

@@ -0,0 +1,24 @@
+"""
+Example: Cloud VM setup using SSH password authentication (public GitHub repo).
+- Connects to a remote VM using SSH username/password and runs setup from a public repo.
+"""
+from vm_tool.runner import SetupRunner, SetupRunnerConfig, SSHConfig
+
+def main():
+    config = SetupRunnerConfig(
+        github_project_url='https://github.com/username/public-repo',
+        github_branch='main',
+        docker_compose_file_path='docker-compose.yml'
+    )
+    runner = SetupRunner(config)
+    ssh_configs = [
+        SSHConfig(
+            ssh_username='your_ssh_username',
+            ssh_hostname='your_ssh_hostname',
+            ssh_password='your_ssh_password'
+        )
+    ]
+    runner.run_cloud_setup(ssh_configs)
+
+if __name__ == "__main__":
+    main()

vm_tool-1.0.30/examples/cloud/template_cloud_setup.py

@@ -0,0 +1,33 @@
+"""
+Template: Cloud VM setup (customize for your use case)
+- Use this template to create your own cloud VM setup script.
+- Supports public/private GitHub, DockerHub, SSH key or password authentication, and multiple VMs.
+- Fill in only the fields you need for your scenario.
+"""
+from vm_tool.runner import SetupRunner, SetupRunnerConfig, SSHConfig
+
+def main():
+    # Fill in only the fields you need for your use case
+    config = SetupRunnerConfig(
+        github_username=None,  # e.g., 'your_github_username' (for private repos)
+        github_token=None,     # e.g., 'your_github_token' (for private repos)
+        github_project_url='https://github.com/username/your-repo',
+        github_branch='main',  # Optional, defaults to 'main'
+        docker_compose_file_path='docker-compose.yml',  # Optional
+        dockerhub_username=None,  # e.g., 'your_dockerhub_username' (if DockerHub login needed)
+        dockerhub_password=None   # e.g., 'your_dockerhub_password' (if DockerHub login needed)
+    )
+    runner = SetupRunner(config)
+    ssh_configs = [
+        SSHConfig(
+            ssh_username='your_ssh_username',
+            ssh_hostname='your_ssh_hostname',
+            ssh_identity_file=None,  # e.g., '/path/to/your/ssh_key' (for SSH key auth)
+            ssh_password=None        # e.g., 'your_ssh_password' (for SSH password auth)
+        )
+        # Add more SSHConfig instances for multiple VMs if needed
+    ]
+    runner.run_cloud_setup(ssh_configs)
+
+if __name__ == "__main__":
+    main()

vm_tool-1.0.30/examples/local/__init__.py

@@ -0,0 +1 @@
+# Local VM setup examples package

vm_tool-1.0.30/examples/local/template_local_setup.py

@@ -0,0 +1,24 @@
+"""
+Template: Local VM setup (customize for your use case)
+- Use this template to create your own local VM setup script.
+- Supports public/private GitHub, DockerHub, and custom Docker Compose file path.
+- Fill in only the fields you need for your scenario.
+"""
+from vm_tool.runner import SetupRunner, SetupRunnerConfig
+
+def main():
+    # Fill in only the fields you need for your use case
+    config = SetupRunnerConfig(
+        github_username=None,  # e.g., 'your_github_username' (for private repos)
+        github_token=None,     # e.g., 'your_github_token' (for private repos)
+        github_project_url='https://github.com/username/your-repo',
+        github_branch='main',  # Optional, defaults to 'main'
+        docker_compose_file_path='docker-compose.yml',  # Optional
+        dockerhub_username=None,  # e.g., 'your_dockerhub_username' (if DockerHub login needed)
+        dockerhub_password=None   # e.g., 'your_dockerhub_password' (if DockerHub login needed)
+    )
+    runner = SetupRunner(config)
+    runner.run_setup()
+
+if __name__ == "__main__":
+    main()

vm_tool-1.0.30/examples/ssh_key_management.py

@@ -0,0 +1,22 @@
+"""
+Example: SSH Key Management for a VM.
+- Generates an SSH key pair (if not present), configures the VM for SSH access, and updates local SSH config.
+- Useful for preparing a VM for secure, passwordless SSH access.
+"""
+
+from vm_tool.ssh import SSHSetup
+
+
+def main():
+    ssh_setup = SSHSetup(
+        hostname='your_vm_hostname',
+        username='your_vm_username',
+        password='your_vm_password',
+        email='your_email_for_ssh_key'
+    )
+
+    ssh_setup.setup()
+
+
+if __name__ == "__main__":
+    main()

{vm_tool-1.0.28 → vm_tool-1.0.30}/setup.py

@@ -11,7 +11,7 @@ else:
 
 setup(
     name='vm_tool',
-    version='1.0.28',  # This will be updated by bump2version
+    version='1.0.30',  # This will be updated by bump2version
     packages=find_packages(),
     description='A Comprehensive Tool for Setting Up Virtual Machines.',
     long_description=long_description,

{vm_tool-1.0.28 → vm_tool-1.0.30}/vm_tool/cli.py

@@ -2,7 +2,7 @@ import argparse
 
 def main():
     parser = argparse.ArgumentParser(description='VM Tool version info')
-    parser.add_argument('--version', action='version', version='1.0.28')
+    parser.add_argument('--version', action='version', version='1.0.30')
     parser.parse_args()
 
 if __name__ == '__main__':

{vm_tool-1.0.28 → vm_tool-1.0.30}/vm_tool/runner.py

@@ -17,6 +17,8 @@ class SetupRunnerConfig(BaseModel):
         docker_compose_file_path (str): Path to the Docker Compose file (default: 'docker-compose.yml').
         dockerhub_username (Optional[str]): DockerHub username (optional).
         dockerhub_password (Optional[str]): DockerHub password (required if username is provided).
+        env_path (Optional[str]): Path where the environment file should be created (optional).
+        env_data (Optional[dict]): Environment data to dump into the file (optional, should be a dict).
     """
 
     github_username: Optional[str] = Field(
@@ -36,11 +38,26 @@ class SetupRunnerConfig(BaseModel):
     dockerhub_password: Optional[str] = Field(
         default=None, description="DockerHub password (required if username is provided)"
     )
+    env_path: Optional[str] = Field(
+        default=None, description="Path where the environment file should be created (optional)"
+    )
+    env_data: Optional[dict] = Field(
+        default=None, description="Environment data to dump into the file (optional, should be a dict)"
+    )
 
-    @validator('docker_compose_file_path', pre=True, always=True)
-    def set_default_docker_compose_file_path(cls, v):
-        """Ensures a default value for the Docker Compose file path."""
-        return v or 'docker-compose.yml'
+    @validator('env_path', always=True)
+    def check_env_path_with_env_data(cls, v, values):
+        """If env_data is provided, env_path must also be provided."""
+        if values.get('env_data') is not None and not v:
+            raise ValueError("env_path must be provided if env_data is specified")
+        return v
+
+    @validator('env_data', always=True)
+    def check_env_data_with_env_path(cls, v, values):
+        """If env_path is provided, env_data must also be provided."""
+        if values.get('env_path') is not None and v is None:
+            raise ValueError("env_data must be provided if env_path is specified")
+        return v
 
     @validator('dockerhub_password', always=True)
     def check_dockerhub_password(cls, v, values):
@@ -122,6 +139,8 @@ class SetupRunner:
         self.docker_compose_file_path = config.docker_compose_file_path
         self.dockerhub_username = config.dockerhub_username
         self.dockerhub_password = config.dockerhub_password
+        self.env_path = config.env_path
+        self.env_data = config.env_data
 
     def _run_ansible_playbook(self, extravars, inventory_file):
         """Executes an Ansible playbook with the given variables and inventory."""
@@ -160,6 +179,9 @@ class SetupRunner:
 
         if self.docker_compose_file_path:
             extravars["DOCKER_COMPOSE_FILE_PATH"] = self.docker_compose_file_path
+        if self.env_path and self.env_data:
+            extravars["ENV_PATH"] = self.env_path
+            extravars["ENV_DATA"] = self.env_data
 
         self._run_ansible_playbook(extravars, 'inventory.yml')
 
@@ -204,5 +226,8 @@ class SetupRunner:
 
         if self.docker_compose_file_path:
             extravars["DOCKER_COMPOSE_FILE_PATH"] = self.docker_compose_file_path
+        if self.env_path and self.env_data:
+            extravars["ENV_PATH"] = self.env_path
+            extravars["ENV_DATA"] = self.env_data
 
         self._run_ansible_playbook(extravars, 'dynamic_inventory.yml')

{vm_tool-1.0.28 → vm_tool-1.0.30}/vm_tool/vm_setup/github/git_configuration.yml

@@ -6,11 +6,6 @@
         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:

{vm_tool-1.0.28 → vm_tool-1.0.30}/vm_tool/vm_setup/main.yml

@@ -9,6 +9,9 @@
     - name: Git Configuration
       include_tasks: github/git_configuration.yml
 
+    - name: Setup Project Environment File
+      include_tasks: setup_project_env.yml
+
     - name: Docker Setup
       include_tasks: docker/docker_setup.yml
 

vm_tool-1.0.30/vm_tool/vm_setup/setup.yml

@@ -0,0 +1,17 @@
+- name: Setup VM
+  block:
+    # --- 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$', '') }}"
+
+    # --- Set project_dest_dir based on EXECUTION_TYPE ---
+    - name: Set project_dest_dir variable for cloud
+      set_fact:
+        project_dest_dir: "{{ ansible_user_dir }}/{{ project_name }}"
+      when: EXECUTION_TYPE == "cloud"
+
+    - name: Set project_dest_dir variable for normal
+      set_fact:
+        project_dest_dir: "{{ playbook_dir }}/{{ project_name }}"
+      when: EXECUTION_TYPE == "normal"

vm_tool-1.0.30/vm_tool/vm_setup/setup_project_env.yml

@@ -0,0 +1,7 @@
+---
+- name: Create environment file if env_path and env_data are provided
+  when: ENV_PATH is defined and ENV_DATA is defined and PROJECT_PATH is defined
+  copy:
+    dest: "{{ project_dest_dir }}/{{ ENV_PATH }}"
+    content: "{{ ENV_DATA | to_nice_yaml }}"
+    mode: '0644'