pushing changes

Author: arsalan-dev-engineer

build/lib/commands/__init__.py

@@ -0,0 +1,28 @@
+import os
+
+"""
+Get a list of valid Python files to import as modules.
+Uses the location of __file__ to identify the folder.
+"""
+
+list_of_files = [file for file in os.listdir(os.path.dirname(__file__))  
+                 # Get the list of files in the directory
+                 if not file.startswith('-')  
+                 # Exclude files starting with '-'
+                 and not file.startswith('.')  
+                 # Exclude hidden files starting with '.'
+                 and file.endswith('.py')  
+                 # Include only files ending with '.py'
+                 and os.path.isfile(os.path.join(os.path.dirname(__file__), file))]
+                 # Check if it's a file
+
+module_list = []
+
+# Drop the .py extension from the file list and populate the module_list
+for name in list_of_files:
+    module_list.append(os.path.splitext(name)[0])
+    # Remove the '.py' extension and add to module_list
+
+# Use the generated module_list for wildcard imports
+__all__ = module_list  
+# Expose all modules for wildcard imports

build/lib/commands/cache.py

@@ -0,0 +1,61 @@
+import click
+from commands import logger
+
+@click.group(help="A group of commands for managing credentials and tokens.")
+def cache():
+    """
+    A group of commands for managing credentials and tokens.
+    """
+    pass
+
+@click.command(help="Add credentials to the cache.")
+def add_credential():
+    pass
+
+@click.command(help="Update an existing credential.")
+def reset_credential():
+    pass
+
+@click.command(help="Delete an existing credential.")
+def delete_credential():
+    pass
+
+@click.command(help="Add a token.")
+def add_token():
+    pass
+
+@click.command(help="Delete a token.")
+def delete_token():
+    pass
+
+@click.command(help="View all existing credentials.")
+def view_credentials():
+    pass
+
+@click.command(help="View all existing tokens.")
+def view_tokens():
+    pass
+
+@click.command(help="Delete a specific credential.")
+def clear_credentials():
+    pass
+
+@click.command(help="Delete a speficic token.")
+def clear_tokens():
+    pass
+
+# ===== COMMANDS ===============
+
+# Add commands to cache group
+cache.add_command(add_credential)
+cache.add_command(reset_credential)
+cache.add_command(delete_credential)
+cache.add_command(add_token)
+cache.add_command(delete_token)
+cache.add_command(view_credentials)
+cache.add_command(view_tokens)
+cache.add_command(clear_credentials)
+cache.add_command(clear_tokens)
+
+if __name__ == "__main__":
+    cache()

build/lib/commands/calculator.py

@@ -0,0 +1,25 @@
+import click
+
+@click.command(help="A simple calculator.\n\n*Example:*\n`calculator --num1 10 --num2 5 --operation +`")
+@click.option("--num1", prompt="Prompt first number", type=int, help="The first number.")
+@click.option("--num2", prompt="Prompt second number", type=int, help="The second number.")
+@click.option("--operation", prompt="Input operator", type=click.Choice(["+", "-", "*", "/"], case_sensitive=False), help="Promopt operation: + - * /")
+def calculator(num1, num2, operation):
+    """Perform a simple arithmetic operation."""
+    if operation == "+":
+        result = num1 + num2    
+    elif operation == "-":
+        result = num1 - num2    
+    elif operation == "*":
+        result = num1 * num2
+    elif operation == "/":
+        # check for vidion by zero
+        if num2 == 0:
+            click.echo("Error: division by zero is not allowed.")
+            return
+        result = num1 / num2
+
+    click.echo(f"{num1} {operation} {num2} = {result}")
+
+if __name__ == "__main__":
+    calculator()

build/lib/commands/expense.py

@@ -0,0 +1,170 @@
+import click
+import requests
+
+"""
+SCRIPT REQUIRES expense_api.py to run with univorn.
+Notes:
+expose_value=False --> option will not show up as an actual option when the user invokes the command.
+"""
+
+# base url for your fastapi server
+BASE_URL = "http://127.0.0.1:8000"
+
+@click.group(help="A group of commands for the expense tracker app.")
+@click.option("--warning", is_eager=True, help="WARNING: fastapi/expense_api.py needs to run on uvicorn server before running this script.", expose_value=False)
+def expense():
+    """
+    command group for managing expenses.
+    """
+    pass
+
+# ==========
+
+@click.command()
+@click.option("-a", "--amount", type=float, required=True, help="Amount of the expense.")
+@click.option("-c", "--category", type=str, required=True, help="Category of the expense.")
+@click.option("-d", "--date", type=click.DateTime(formats=["%d-%m-%y"]), required=True, help="Date of the expense (format: DD-MM-YY).")
+@click.option("-n", "--note", type=str, help="Optional notes for the expense.")
+def add_expense(amount, category, date, note):
+    """
+    add a new expense.
+    """
+    # send a POST request to the server to add a new expense
+    response = requests.post(f"{BASE_URL}/expenses/", json={
+        "amount": amount,
+        "category": category,
+        "date": date.date().isoformat(),
+        "note": note or ""
+    })
+
+    # check if the response status code indicates success (201 Created)
+    if response.status_code == 201:
+        result = response.json()
+        # output the added expense details in a formatted manner
+        click.echo("\nExpense Added Successfully:")
+        click.echo("=" * 30)
+        click.echo(f"ID      : {result['id']}")
+        click.echo(f"Amount  : ${amount:.2f}")
+        click.echo(f"Category: {category}")
+        click.echo(f"Date    : {date.date()}")
+        click.echo(f"Note    : {note or 'No notes provided'}")
+        click.echo("=" * 30)
+    # handle bad request errors (400 Bad Request)
+    elif response.status_code == 400:
+        click.echo(f"Bad request: {response.json().get('detail', 'Invalid data provided')}")
+    else:
+        # handle other errors
+        click.echo(f"Error adding expense: {response.status_code} - {response.text}")
+
+# ==========
+
+@click.command()
+@click.option("-s", "--start-date", type=click.DateTime(formats=["%d-%m-%y"]), help="Start date for viewing expenses (format: DD-MM-YY).")
+@click.option("-e", "--end-date", type=click.DateTime(formats=["%d-%m-%y"]), help="End date for viewing expenses (format: DD-MM-YY).")
+def view_expenses(start_date, end_date):
+    """
+    view expenses within a date range.
+    """
+    # prepare query parameters for the GET request
+    params = {
+        "start_date": start_date.date().isoformat() if start_date else None,
+        "end_date": end_date.date().isoformat() if end_date else None
+    }
+
+    # remove any parameters that are None to avoid sending unnecessary parameters
+    params = {k: v for k, v in params.items() if v is not None}
+
+    # send a GET request to the server to retrieve expenses
+    response = requests.get(f"{BASE_URL}/expenses/", params=params)
+
+    # check if the response status code indicates success (200 OK)
+    if response.status_code == 200:
+        expenses = response.json()
+        if not expenses:
+            click.echo("No expenses found for the given dates.")
+        else:
+            # output the retrieved expenses in a formatted manner
+            click.echo("\nExpenses Found:")
+            click.echo("=" * 30)
+            for exp in expenses:
+                click.echo(f"ID      : {exp['id']}")
+                click.echo(f"Amount  : ${exp['amount']:.2f}")
+                click.echo(f"Category: {exp['category']}")
+                click.echo(f"Date    : {exp['date']}")
+                click.echo(f"Note    : {exp['note'] or 'No notes provided'}")
+                click.echo("-" * 30)
+    
+    # handle bad request errors (400 Bad Request)
+    elif response.status_code == 400:
+        click.echo(f"Bad request: {response.json().get('detail', 'Invalid date format')}")
+    else:
+        # handle other errors
+        click.echo(f"Error retrieving expenses: {response.status_code} - {response.text}")
+
+# ==========
+
+@click.command()
+@click.option("--id", type=int, required=True, help="ID of the expense to delete.")
+def delete_expense(id):
+    """
+    delete an expense by its id.
+    """
+    # send a DELETE request to the server to remove the expense with the given ID
+    response = requests.delete(f"{BASE_URL}/expenses/{id}")
+
+    # check if the response status code indicates success (204 No Content)
+    if response.status_code == 204:
+        click.echo(f"Deleted expense with ID: {id}")
+    
+    # handle not found errors (404 Not Found)
+    elif response.status_code == 404:
+        click.echo(f"Expense with ID {id} not found.")
+    else:
+        # handle other errors
+        click.echo(f"Error deleting expense: {response.status_code} - {response.text}")
+
+# ==========
+
+@click.command()
+@click.option("-s", "--start-date", type=click.DateTime(formats=["%d-%m-%y"]), help="Start date for the expense report (format: DD-MM-YY).")
+@click.option("-e", "--end-date", type=click.DateTime(formats=["%d-%m-%y"]), help="End date for the expense report (format: DD-MM-YY).")
+def generate_report(start_date, end_date):
+    """
+    generate an expense report within a date range.
+    """
+    # prepare query parameters for the GET request
+    params = {
+        "start_date": start_date.date().isoformat() if start_date else None,
+        "end_date": end_date.date().isoformat() if end_date else None
+    }
+
+    # remove any parameters that are None to avoid sending unnecessary parameters
+    params = {k: v for k, v in params.items() if v is not None}
+
+    # send a GET request to the server to generate the expense report
+    response = requests.get(f"{BASE_URL}/report/", params=params)
+
+    # check if the response status code indicates success (200 OK)
+    if response.status_code == 200:
+        report = response.json()
+        total_amount = report.get("total_amount", 0)
+        click.echo(f"Total expenses from {start_date.date() if start_date else 'start'} to {end_date.date() if end_date else 'end'}: ${total_amount:.2f}")
+    
+    # handle bad request errors (400 Bad Request)
+    elif response.status_code == 400:
+        click.echo(f"Bad request: {response.json().get('detail', 'Invalid date format')}")
+    else:
+        # handle other errors
+        click.echo(f"Error generating report: {response.status_code} - {response.text}")
+
+# ==========
+
+# add the sub-commands to the "expense" group
+expense.add_command(add_expense)
+expense.add_command(view_expenses)
+expense.add_command(delete_expense)
+expense.add_command(generate_report)
+
+# if this script runs directly, invoke the "expense" group
+if __name__ == "__main__":
+    expense()

build/lib/commands/gen_pass.py

@@ -0,0 +1,76 @@
+import click
+import secrets
+import string
+from commands import logger
+
+# ====================
+
+@click.group(help="A group of commands for password generator.")
+def gen_pass():
+    """
+    A group of commands for the password generator.
+    This function serves as the entry point for the Click group.
+    """
+    pass
+
+# ====================
+
+@click.command("gen")
+@click.option("-l", "--length", type=int, required=True, help="Length of password (minimum: 8).")
+@click.option("-c", "--include-cap", is_flag=True, help="Include uppercase letters in the password.")
+@click.option("-n", "--include-num", is_flag=True, help="Include numbers in the password.")
+@click.option("-s", "--include-sp", is_flag=True, help="Include special characters in the password.")
+def generate_pass(length, include_cap, include_num, include_sp):
+    """
+    Generate a random password based on specified criteria.
+
+    Parameters:
+    - length (int): The length of the password to be generated. Must be at least 8.
+    - include_cap (bool): Flag to include uppercase letters in the password.
+    - include_num (bool): Flag to include numbers in the password.
+    - include_sp (bool): Flag to include special characters in the password.
+    """
+
+    # Check if the length is less than the minimum required
+    if length < 8:
+        logger.error("Password length must be at least 8.")
+        return
+    
+    # Initialise the alphabet with lowercase letters
+    alphabet = string.ascii_lowercase
+    
+    # Include uppercase letters if the flag is set
+    if include_cap:
+        # Append uppercase letters
+        alphabet += string.ascii_uppercase
+    
+    # Include numbers if the flag is set
+    if include_num:
+        alphabet += string.digits  # Append digits
+    
+    # Include special characters if the flag is set
+    if include_sp:
+        alphabet += string.punctuation  # Append special characters
+
+    # Ensure at least one character type is included
+    if len(alphabet) == 0:
+        logger.error("At least one character type must be included.")
+        return
+
+    # Generate the password by selecting random characters from the alphabet
+    password = "".join(secrets.choice(alphabet) for _ in range(length))
+    
+    # Output the generated password
+    logger.success("Password successfully generated:")
+    # Print the password to the console
+    click.echo(f"{password}")
+    
+# ====================
+
+# Add the generate_pass command to the gen_pass group
+gen_pass.add_command(generate_pass)
+
+# ====================
+
+if __name__ == "__main__":
+    gen_pass()