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

{vm_tool-1.0.26/vm_tool.egg-info → vm_tool-1.0.28}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: vm_tool
-Version: 1.0.26
+Version: 1.0.28
 Summary: A Comprehensive Tool for Setting Up Virtual Machines.
 Home-page: https://github.com/thesunnysinha/vm_tool
 Author: Sunny Sinha
@@ -15,11 +15,6 @@ 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
@@ -46,6 +41,7 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: project-url
 Dynamic: provides-extra
 Dynamic: requires-dist
@@ -190,4 +186,49 @@ When you run the SSH setup, the tool will:
 
 ---
 
+## Command Line Version Info
+
+If you want to check the installed version of `vm_tool`, you can use the following command:
+
+```bash
+vm_tool --version
+```
+
+This will print the current version of the package.
+
+---
+
+## Python API Usage
+
+The primary class for using the VM Setup Tool is `SetupRunner`, which orchestrates the entire setup process.
+
+### **Example Usage**  
+
+```python
+from vm_tool.runner import SetupRunner, SetupRunnerConfig
+
+config = SetupRunnerConfig(
+    # Configuration options
+)
+
+runner = SetupRunner(config)
+
+runner.run_setup()
+```
+
+### **Configuration Options**  
+- `github_username`: Your GitHub username (required for private repositories).
+- `github_token`: A GitHub token with repo access (required for private repositories).
+- `github_project_url`: The URL of your GitHub project.
+- `github_branch`: The branch of the GitHub repository to use.
+- `docker_compose_file_path`: Path to your Docker Compose file.
+- `dockerhub_username`: Your Docker Hub username (if Docker Hub login is needed).
+- `dockerhub_password`: Your Docker Hub password (if Docker Hub login is needed).
+
+### **Methods**  
+- `run_setup()`: Executes the VM setup process.
+- `run_cloud_setup(ssh_configs)`: Executes the cloud VM setup process using the provided SSH configurations.
+
+---
+
 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.26 → vm_tool-1.0.28}/README.md

@@ -136,4 +136,49 @@ When you run the SSH setup, the tool will:
 
 ---
 
+## Command Line Version Info
+
+If you want to check the installed version of `vm_tool`, you can use the following command:
+
+```bash
+vm_tool --version
+```
+
+This will print the current version of the package.
+
+---
+
+## Python API Usage
+
+The primary class for using the VM Setup Tool is `SetupRunner`, which orchestrates the entire setup process.
+
+### **Example Usage**  
+
+```python
+from vm_tool.runner import SetupRunner, SetupRunnerConfig
+
+config = SetupRunnerConfig(
+    # Configuration options
+)
+
+runner = SetupRunner(config)
+
+runner.run_setup()
+```
+
+### **Configuration Options**  
+- `github_username`: Your GitHub username (required for private repositories).
+- `github_token`: A GitHub token with repo access (required for private repositories).
+- `github_project_url`: The URL of your GitHub project.
+- `github_branch`: The branch of the GitHub repository to use.
+- `docker_compose_file_path`: Path to your Docker Compose file.
+- `dockerhub_username`: Your Docker Hub username (if Docker Hub login is needed).
+- `dockerhub_password`: Your Docker Hub password (if Docker Hub login is needed).
+
+### **Methods**  
+- `run_setup()`: Executes the VM setup process.
+- `run_cloud_setup(ssh_configs)`: Executes the cloud VM setup process using the provided SSH configurations.
+
+---
+
 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.26 → vm_tool-1.0.28}/setup.py

@@ -11,7 +11,7 @@ else:
 
 setup(
     name='vm_tool',
-    version='1.0.26',  # This will be updated by bump2version
+    version='1.0.28',  # 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.28/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.28')
+    parser.parse_args()
+
+if __name__ == '__main__':
+    main()

{vm_tool-1.0.26 → vm_tool-1.0.28}/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.28/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.28/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.26 → vm_tool-1.0.28/vm_tool.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: vm_tool
-Version: 1.0.26
+Version: 1.0.28
 Summary: A Comprehensive Tool for Setting Up Virtual Machines.
 Home-page: https://github.com/thesunnysinha/vm_tool
 Author: Sunny Sinha
@@ -15,11 +15,6 @@ 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
@@ -46,6 +41,7 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: project-url
 Dynamic: provides-extra
 Dynamic: requires-dist
@@ -190,4 +186,49 @@ When you run the SSH setup, the tool will:
 
 ---
 
+## Command Line Version Info
+
+If you want to check the installed version of `vm_tool`, you can use the following command:
+
+```bash
+vm_tool --version
+```
+
+This will print the current version of the package.
+
+---
+
+## Python API Usage
+
+The primary class for using the VM Setup Tool is `SetupRunner`, which orchestrates the entire setup process.
+
+### **Example Usage**  
+
+```python
+from vm_tool.runner import SetupRunner, SetupRunnerConfig
+
+config = SetupRunnerConfig(
+    # Configuration options
+)
+
+runner = SetupRunner(config)
+
+runner.run_setup()
+```
+
+### **Configuration Options**  
+- `github_username`: Your GitHub username (required for private repositories).
+- `github_token`: A GitHub token with repo access (required for private repositories).
+- `github_project_url`: The URL of your GitHub project.
+- `github_branch`: The branch of the GitHub repository to use.
+- `docker_compose_file_path`: Path to your Docker Compose file.
+- `dockerhub_username`: Your Docker Hub username (if Docker Hub login is needed).
+- `dockerhub_password`: Your Docker Hub password (if Docker Hub login is needed).
+
+### **Methods**  
+- `run_setup()`: Executes the VM setup process.
+- `run_cloud_setup(ssh_configs)`: Executes the cloud VM setup process using the provided SSH configurations.
+
+---
+
 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.26/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.26')
-
-    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.26/vm_tool/vm_setup/github/git_configuration.yml

@@ -1,39 +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: 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.26/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