vm-tool 1.0.1__tar.gz → 1.0.4__tar.gz

vm_tool-1.0.4/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.2
+Name: vm_tool
+Version: 1.0.4
+Summary: A Comprehensive Tool for Setting Up Virtual Machines Using Ansible.
+License: MIT
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ansible
+Requires-Dist: ansible-runner
+Requires-Dist: paramiko
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+# **VM Setup Tool**  
+### **A Comprehensive Solution for Streamlining Virtual Machine Configuration with Ansible**
+
+## **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**. Ensure that a `docker-compose.yml` file is present at the root of your project directory before proceeding.
+
+---
+
+## **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
+
+runner = SetupRunner(
+    github_username='your_github_username',  # e.g., username
+    github_token='your_github_token',        # e.g., token
+    github_project_url='your_github_project_url'  # e.g., https://github.com/username/repo
+)
+
+runner.run_setup()
+```
+
+### **What Happens During Setup**  
+The VM Setup Tool will:  
+1. Clone the specified GitHub repository to your local machine.  
+2. Install **Docker** if it’s not already available on the target machine.  
+3. Install **Docker Compose** for managing multi-container applications.  
+4. Create, enable, and start the Docker service.  
+5. 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.
+
+---
+
+## **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.4/setup.py

@@ -0,0 +1,26 @@
+from setuptools import setup, find_packages
+import os
+
+# Read the contents of README.md
+with open(os.path.join(os.path.dirname(__file__), 'Readme.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+setup(
+    name='vm_tool',
+    version='1.0.4',  # This will be updated by bump2version
+    packages=find_packages(),
+    description='A Comprehensive Tool for Setting Up Virtual Machines Using Ansible.',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    install_requires=[
+        'ansible',
+        'ansible-runner',
+        'paramiko'
+    ],
+    entry_points={
+        'console_scripts': [
+            'vm_tool=vm_tool.cli:main',
+        ],
+    },
+    license='MIT',
+)

vm_tool-1.0.4/vm_tool/ssh.py

@@ -0,0 +1,53 @@
+import os
+import paramiko
+
+class SSHSetup:
+    def __init__(self, hostname, username, password, email):
+        self.hostname = hostname
+        self.username = username
+        self.password = password
+        self.email = email
+        self.private_key_path = os.path.expanduser('~/.ssh/id_rsa')
+        self.client = paramiko.SSHClient()
+        self.client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
+
+    def _generate_ssh_key(self, email):
+        os.system(f'ssh-keygen -t rsa -b 4096 -C "{email}"')
+
+    def _read_or_generate_public_key(self, email):
+        public_key_path = f'{self.private_key_path}.pub'
+        if not os.path.exists(public_key_path):
+            self._generate_ssh_key(email)
+        with open(public_key_path, 'r') as file:
+            return file.read()
+
+    def _configure_vm(self, vm_ip, vm_password, public_key):
+        self.client.connect(vm_ip, username=self.username, password=vm_password)
+        self.client.exec_command(f'echo "{public_key}" >> ~/.ssh/authorized_keys')
+        self.client.close()
+
+    def _update_ssh_config(self):
+        config = f"""
+Host {self.hostname}
+  HostName {self.hostname}
+  User {self.username}
+  StrictHostKeyChecking no
+  IdentityFile {self.private_key_path}
+  ForwardAgent yes
+"""
+        with open(f'{os.path.expanduser("~")}/.ssh/config', 'a') as file:
+            file.write(config)
+
+    def _establish_connection(self):
+        self.client.connect(self.hostname, username=self.username, key_filename=self.private_key_path)
+
+    def _close_connection(self):
+        if self.client:
+            self.client.close()
+
+    def setup(self):
+        public_key = self._read_or_generate_public_key(self.email)
+        self._configure_vm(self.hostname, self.password, public_key)
+        self._update_ssh_config()
+        self._establish_connection()
+        self._close_connection()

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

@@ -0,0 +1,97 @@
+Metadata-Version: 2.2
+Name: vm_tool
+Version: 1.0.4
+Summary: A Comprehensive Tool for Setting Up Virtual Machines Using Ansible.
+License: MIT
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ansible
+Requires-Dist: ansible-runner
+Requires-Dist: paramiko
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+# **VM Setup Tool**  
+### **A Comprehensive Solution for Streamlining Virtual Machine Configuration with Ansible**
+
+## **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**. Ensure that a `docker-compose.yml` file is present at the root of your project directory before proceeding.
+
+---
+
+## **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
+
+runner = SetupRunner(
+    github_username='your_github_username',  # e.g., username
+    github_token='your_github_token',        # e.g., token
+    github_project_url='your_github_project_url'  # e.g., https://github.com/username/repo
+)
+
+runner.run_setup()
+```
+
+### **What Happens During Setup**  
+The VM Setup Tool will:  
+1. Clone the specified GitHub repository to your local machine.  
+2. Install **Docker** if it’s not already available on the target machine.  
+3. Install **Docker Compose** for managing multi-container applications.  
+4. Create, enable, and start the Docker service.  
+5. 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.
+
+---
+
+## **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.1 → vm_tool-1.0.4}/vm_tool.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ setup.py
 vm_tool/__init__.py
 vm_tool/cli.py
 vm_tool/runner.py
+vm_tool/ssh.py
 vm_tool.egg-info/PKG-INFO
 vm_tool.egg-info/SOURCES.txt
 vm_tool.egg-info/dependency_links.txt

{vm_tool-1.0.1 → vm_tool-1.0.4}/vm_tool.egg-info/requires.txt

@@ -1,2 +1,3 @@
 ansible
 ansible-runner
+paramiko

vm_tool-1.0.1/PKG-INFO

@@ -1,30 +0,0 @@
-Metadata-Version: 2.2
-Name: vm_tool
-Version: 1.0.1
-Summary: A tool to setup VMs using Ansible.
-License: MIT
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: ansible
-Requires-Dist: ansible-runner
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: license
-Dynamic: requires-dist
-Dynamic: summary
-
-
-    This is a tool to setup VMs using Ansible.
-
-    Example usage:
-
-    from vm_tool.runner import SetupRunner
-
-    runner = SetupRunner(
-        github_username='your_github_username', # e.g. username
-        github_token='your_github_token', # e.g. token
-        github_project_url='your_github_project_url' # e.g. https://github.com/username/repo
-    )
-
-    runner.run_setup()
-    

vm_tool-1.0.1/setup.py

@@ -1,34 +0,0 @@
-from setuptools import setup, find_packages
-
-setup(
-    name='vm_tool',
-    version='1.0.1',  # This will be updated by bump2version
-    packages=find_packages(),
-    description='A tool to setup VMs using Ansible.',
-    long_description='''
-    This is a tool to setup VMs using Ansible.
-
-    Example usage:
-
-    from vm_tool.runner import SetupRunner
-
-    runner = SetupRunner(
-        github_username='your_github_username', # e.g. username
-        github_token='your_github_token', # e.g. token
-        github_project_url='your_github_project_url' # e.g. https://github.com/username/repo
-    )
-
-    runner.run_setup()
-    ''',
-    long_description_content_type='text/markdown',
-    install_requires=[
-        'ansible',
-        'ansible-runner',
-    ],
-    entry_points={
-        'console_scripts': [
-            'vm_tool=vm_tool.cli:main',
-        ],
-    },
-    license='MIT',
-)

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

@@ -1,30 +0,0 @@
-Metadata-Version: 2.2
-Name: vm_tool
-Version: 1.0.1
-Summary: A tool to setup VMs using Ansible.
-License: MIT
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: ansible
-Requires-Dist: ansible-runner
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: license
-Dynamic: requires-dist
-Dynamic: summary
-
-
-    This is a tool to setup VMs using Ansible.
-
-    Example usage:
-
-    from vm_tool.runner import SetupRunner
-
-    runner = SetupRunner(
-        github_username='your_github_username', # e.g. username
-        github_token='your_github_token', # e.g. token
-        github_project_url='your_github_project_url' # e.g. https://github.com/username/repo
-    )
-
-    runner.run_setup()
-