pushing final changes

Author: arsalan-dev-engineer

README.md

@@ -2,8 +2,6 @@
 
 Welcome to **Zap CLI**! This command-line interface (CLI) tool is designed to provide a wide range of useful scripts and commands for various tasks. This repository features a collection of tools and utilities, all accessible through an intuitive and extensible CLI interface, making it easy to integrate into your daily workflows.
 
-Whether you need to perform calculations, manage expenses, generate secure passwords, take notes, convert units, or download YouTube videos, ZAP CLI has you covered. With its modular structure, you can easily extend its capabilities to fit your specific needs.
-
 ## Features
 
 - **Calculator**: Perform basic arithmetic operations with ease.
@@ -13,48 +11,45 @@ Whether you need to perform calculations, manage expenses, generate secure passw
 - **Unit Conversion**: Convert between various units of measurement seamlessly.
 - **YouTube Downloader**: Download your favorite videos from YouTube with simple commands.
 
+## Installation Guide
 
-## zap-cli Installation Guide
-To get started with `zap-cli`, follow these steps:
+To get started with **zap-cli**, follow these steps:
 
 ### 1. Clone the Repository
+
 First, clone the repository to your local machine:
+
 ```bash
 git clone https://github.com/arsalan-dev-engineer/zap-cli.git
 ```
 
 ### 2. Navigate to the Project Directory
+Change to the project directory:
 ```bash
 cd zap-cli
 ```
 
 ### 3. Make the Setup Script Executable
+Make the setup.sh script executable:
 ```bash
-chmod +x scripting_tools/setup.sh
+chmod +x setup.sh
 ```
 
 ### 4. Run the Setup Script
+Run the setup.sh script to set up the environment:
 ```bash
-bash scripting_tools/setup.sh
+./setup.sh
 ```
 
-### The script will:
+## The script will:
 * Install the required dependencies (Python, virtual environment tools).
 * Create and activate a Python virtual environment.
 * Install the dependencies listed in requirements.txt.
 * Set up zap-cli.py as a global command.
 
-### 5. After Installation
-Once the script has completed, you can use zap-cli anywhere on your Ubuntu terminal.
-To verify that zap-cli is working, simply type:
-```bash
-zap-cli --help
-```
+## 5. After Installation
+Once the script has completed, you can use zap-cli anywhere on your Ubuntu terminal. To verify that zap-cli is working, simply type:
 
 ### Notes:
-* Ensure that bash is installed on your system to run the setup script.
-* The setup script will create a virtual environment in the project folder and install all dependencies listed in requirements.txt.
-
-
-
-
+Ensure that bash is installed on your system to run the setup script.
+The setup script will create a virtual environment in the project folder and install all dependencies listed in requirements.txt.

requirements.txt

@@ -1,7 +1,17 @@
-
-# This file lists all the dependencies required for the project.
-# Option1: Run: 'pip install -r requirements.txt' to install all dependencies mentioned in this file.
-# Option2 cd into 'scripting-tools' dir then run: './setup.sh' to install all dependencies.
+# ------------------------------------------------------------------------
+# This is the requirements.txt file for the zap-cli project.
+# It lists all the Python dependencies required to run the zap-cli command-line tool.
+# There are two ways to install these dependencies:
+# 
+# Option 1: Run the following command to install all dependencies from this file:
+#   pip install -r requirements.txt
+#
+# Option 2: Navigate to the 'scripting-tools' directory and run the setup.sh script:
+#   cd scripting-tools
+#   ./setup.sh
+#
+# The dependencies listed in this file are:
+# ------------------------------------------------------------------------
 
 click
 pytube

setup.py

@@ -1,15 +1,40 @@
 from setuptools import setup, find_packages
 
+# ------------------------------------------------------------------------
+# This is the setup.py file for the zap-cli package.
+# It is used for packaging and distributing the zap-cli command-line tool.
+# It defines the metadata and configuration for the package, including:
+# - The package name, version, and dependencies.
+# - The entry point for the command-line tool.
+# - It also specifies the modules or packages that should be included
+#   in the distribution (using find_packages).
+# ------------------------------------------------------------------------
+
 setup(
+    # Name of the package (this is what will be used for installation)
     name="zap-cli",
+
+    # Version of the package (helps in managing versions and dependencies)
     version="0.1",
-    packages=find_packages(),  # Automatically finds the zap_cli package
+
+    # Automatically discover and include all Python packages in the zap_cli directory
+    # Finds and includes all packages in the zap_cli module
+    packages=find_packages(),
+
+    # List of dependencies that should be installed when the package is installed
     install_requires=[
-        'click',  # Add any dependencies here, like 'requests', etc.
+        # Required for building the command-line interface with Click
+        'click',
+        # Add any other external dependencies here (e.g., 'requests', 'flask', etc.)
     ],
+
+    # Entry points for creating executable commands via the command line
     entry_points={
         'console_scripts': [
-            'zap-cli = zap_cli.zap_cli:cli',  # Correct the path to the cli function
+            # This defines a command called 'zap-cli' that runs the cli() function
+            # from the zap_cli.zap_cli module (your main CLI script)
+            # Points to the `cli` function in `zap_cli/zap_cli.py`
+            'zap-cli = zap_cli.zap_cli:cli',
         ],
     },
 )

setup.sh

@@ -1,13 +1,24 @@
 #!/bin/bash
 
-# Exit on any error
+# ------------------------------------------------------------------------
+# This is the setup.sh script for the zap-cli project.
+# It is used to set up the environment and install dependencies for the zap-cli
+# command-line tool. The script performs the following tasks:
+# - Checks if Python 3 and the venv module are installed.
+# - Creates a virtual environment (venv) to isolate the project's dependencies.
+# - Installs all required dependencies from requirements.txt or setup.py.
+# - Installs the zap-cli package globally in editable mode.
+# - Ensures that the zap-cli tool is available for use in any directory.
+# ------------------------------------------------------------------------
+
+# Exit the script if any command fails
 set -e
 
-# Define the project directory
+# Get the current project directory
 PROJECT_DIR="$(pwd)"
 
 # 1. Check if Python and venv are installed
-echo "Checking Python and venv installation..."
+echo "Checking for Python and venv..."
 if ! command -v python3 &> /dev/null
 then
     echo "Python3 is not installed. Please install Python 3."
@@ -16,7 +27,7 @@ fi
 
 if ! command -v python3 -m venv &> /dev/null
 then
-    echo "venv module is not available. Installing..."
+    echo "venv module is not available. Installing virtualenv..."
     python3 -m pip install --user virtualenv
 fi
 
@@ -25,26 +36,27 @@ echo "Creating virtual environment..."
 python3 -m venv venv
 
 # 3. Activate the virtual environment
+echo "Activating the virtual environment..."
 source venv/bin/activate
 
-# 4. Install the packages from requirements.txt or setup.py
+# 4. Install dependencies from requirements.txt (or setup.py if no requirements.txt)
 echo "Installing dependencies..."
 if [[ -f "$PROJECT_DIR/requirements.txt" ]]; then
+    # If requirements.txt exists, install the packages
     pip install -r "$PROJECT_DIR/requirements.txt"
 else
-    echo "requirements.txt not found. Installing from setup.py..."
+    # If no requirements.txt, install from setup.py
+    echo "No requirements.txt found, installing from setup.py..."
     pip install .
 fi
 
-# 5. Install zap-cli globally (editable mode)
+# 5. Install the zap-cli package globally in editable mode
 echo "Installing zap-cli globally in editable mode..."
 pip install -e .
 
-# 6. Check if the installation was successful by running zap-cli
-echo "Checking zap-cli installation..."
-zap-cli --version
-
-# 7. Deactivate the virtual environment
+# 6. Deactivate the virtual environment after setup is complete
+echo "Deactivating the virtual environment..."
 deactivate
 
+# Final message
 echo "Setup complete! You can now use zap-cli globally."