update project structure

Author: hasib503

Programs/AddTwoNumbers.py

@@ -1,11 +1,33 @@
+# ================= Problem Description =================
+# This script prompts the user to enter two numerical values (integers or floating-point numbers).
+# It calculates and displays the sum of these values.
+# 
+# 1. Displays a welcome message.
+# 2. Prompts for and reads two numerical inputs.
+# 3. Computes and displays their sum.
+#
+# ================= Input =================
+# - Two numerical values (integers or floating-point).
+#
+# ================= Output =================
+# - The sum of the two input values.
+#
+# Example:
+# Input:
+# 5
+# 7.5
+#
+# Output:
+# Sum of the given two numbers: 12.5
+# =========================================================
 
 # ============= Solution 01 =============
 # num1 = 10
 # num2 = 20
-# print("Sum of given two numbers :", num1 + num2)
+# print("Sum of given two numbers:", num1 + num2)
 
 # ============= Solution 02 =============
 print("Welcome to TowSome programme")
-num1 = float(input("Enter first number :"))
-num2 = float(input("Enter second number :"))
-print("Sum of given two numbers :", num1 + num2)
+num1 = float(input("Enter first number: "))
+num2 = float(input("Enter second number: "))
+print("Sum of given two numbers:", num1 + num2)

Programs/CalculateSquareRoot.py

@@ -1,3 +1,25 @@
+# ================= Problem Description =================
+# This script calculates the square root of a user-provided number.
+# 
+# 1. Displays the program name.
+# 2. Prompts the user to input a numerical value.
+# 3. Computes the square root of the input value.
+# 4. Displays the result.
+#
+# ================= Input =================
+# - A numerical value (integer or floating-point) for which the square root is to be calculated.
+#
+# ================= Output =================
+# - The square root of the input value.
+#
+# Example:
+# Input:
+# 16
+#
+# Output:
+# Square Root : 4.0
+# =========================================================
+
 # ============= Solution 01 =============
 # print("Program Name : Calculate Square Root")
 # num = float(input("Enter a number :"))

Programs/CheckLeapYear.py

@@ -1,19 +1,44 @@
+# ================= Problem Description =================
+# This script determines whether a given year is a leap year.
+# It prompts the user to enter a year and checks if it is a leap year based on the following criteria:
+# - A year is a leap year if it is divisible by 4 and not divisible by 100, or if it is divisible by 400.
+# 
+# 1. Displays a welcome message.
+# 2. Prompts the user to input a year.
+# 3. Checks if the entered year is a leap year.
+# 4. Displays whether the year is a leap year or not.
+# 5. Asks the user if they want to retry or quit.
+#
+# The program continues to prompt for a new year until the user decides to quit or provides invalid input.
+#
+# ================= Input =================
+# - A year (integer value).
+#
+# ================= Output =================
+# - A message indicating whether the year is a leap year or not.
+# - Option to retry or quit after each result.
+#
+# Example:
+# Input:
+# Enter year: 2024
+# Output:
+# 2024 is a leap year!
+# Do you want to retry? (y/q): n
+# =========================================================
+
 print("Welcome to Leap Year programme!")
 
 def check_leap_year(y):
     if ((y % 4 == 0) and (y % 100 != 0)) or (y % 400 == 0):
-        print(str(y) + " is a leap year !")
-        retry = input("Do you want to retry? (y/q): ").lower()
-        if retry != "y":
-            quit()
+        print(f"{y} is a leap year!")
     else:
-        print(str(y) + " is not a leap year")
-        retry = input("Do you want to retry? (y/q): ").lower()
-        if retry != "y":
-            quit()
+        print(f"{y} is not a leap year")
+    retry = input("Do you want to retry? (y/q): ").lower()
+    if retry != "y":
+        quit()
 
 while True:
-    y = input("Enter year : ")
+    y = input("Enter year: ")
     if y.isnumeric():
         y = int(y)
         check_leap_year(y)

Programs/CheckPrimeNumber.py

@@ -1,33 +1,50 @@
-print("Welcome to Prime Number Checking programme!")
+# ================= Problem Description =================
+# This script determines whether a given number is a prime number.
+# A prime number is a number greater than 1 that has no positive divisors other than 1 and itself.
+# 
+# 1. Displays a welcome message.
+# 2. Prompts the user to input a number.
+# 3. Checks if the entered number is a prime number.
+# 4. Displays whether the number is prime or not.
+# 5. Asks the user if they want to retry or quit.
+#
+# The program continues to prompt for new numbers until the user decides to quit.
+#
+# ================= Input =================
+# - A number (integer value).
+#
+# ================= Output =================
+# - A message indicating whether the number is a prime number or not.
+# - Option to retry or quit after each result.
+#
+# Example:
+# Input:
+# Enter number: 7
+# Output:
+# 7 is a prime number!
+# Do you want to retry? (y/q): n
+# =========================================================
 
-run = True
+print("Welcome to Prime Number Checking programme!")
 
-def check_primenumber():
-    num =  int(input("Enter number : "))
-    
-    if num == 1 :
-        print(str(num) + " is not a prime number")
+def check_prime_number():
+    num = int(input("Enter number: "))
 
+    if num < 2:
+        print(f"{num} is not a prime number")
     else:
-        for i in range(2, num):
-            if num % i == 0 :
-                print(str(num)+" is not a prime number fdg1")
+        for i in range(2, int(num**0.5) + 1):
+            if num % i == 0:
+                print(f"{num} is not a prime number")
                 retry = input("Do you want to retry? (y/q): ").lower()
                 if retry != "y":
-                    run = False
                     quit()
-                    
-                else : 
-                    break
-            else : 
-                print(str(num) + " is a prime number!  h")
-                retry = input("Do you want to retry? (y/q): ").lower()
-                if retry != "y":
-                    run = False
-                    quit() 
-                else : 
-                    break      
+                return
+        print(f"{num} is a prime number!")
 
-while run :
-   
-    check_primenumber()
+    retry = input("Do you want to retry? (y/q): ").lower()
+    if retry != "y":
+        quit()
+
+while True:
+    check_prime_number()

Programs/DelivaryTime.py

@@ -1,39 +1,54 @@
-This problem was descrived by [] 
+# ================= Problem Description =================
+# This script calculates and displays the delivery time or date based on the order time.
+# The delivery time is determined as follows:
+# - If the order time is less than 6 hours, the delivery time is the current date.
+# - If the order time is 6 hours or more, the delivery date is the following day.
+# 
+# 1. Prompts the user to input the order time in hours.
+# 2. Calculates the delivery time or date based on the order time.
+# 3. Displays the result.
+# 4. Asks the user if they want to retry or quit.
+#
+# The program continues to prompt for new order times until the user decides to quit or provides invalid input.
+#
+# ================= Input =================
+# - Order time (integer value representing hours).
+#
+# ================= Output =================
+# - Delivery time or date based on the order time.
+# - Option to retry or quit after each result.
+#
+# Example:
+# Input:
+# Enter order time: 3
+# Output:
+# Delivery time is: 2024-09-16
+# Do you want to retry? (y/q): n
+# =========================================================
 
 from datetime import datetime, timedelta
 
 # Get the current time without microseconds
 current_date = datetime.now().strftime('%Y-%m-%d')
 next_day_date = datetime.now().date() + timedelta(days=1)
 
-
-
-
-def deliveryTimer (orderTime):
-    if orderTime < 6 :
-        print("Delivary time is : " + current_date)
-        
-        retry = input("Do you want to retry? (y/q): ").lower()
-        if retry != "y":
-            quit()
+def delivery_timer(order_time):
+    if order_time < 6:
+        print(f"Delivery time is: {current_date}")
     else:
-        print("Delivary date is : " + str(next_day_date))
-        
-        retry = input("Do you want to retry? (y/q): ").lower()
-        if retry != "y":
-            quit()
-
-
+        print(f"Delivery date is: {next_day_date}")
 
+    retry = input("Do you want to retry? (y/q): ").lower()
+    if retry != "y":
+        quit()
 
 while True:
-    orderTime = input("Enter order time : ")
-    if orderTime.isnumeric():
-        orderTime = int(orderTime)
-        deliveryTimer(orderTime)
+    order_time = input("Enter order time (in hours): ")
+    if order_time.isnumeric():
+        order_time = int(order_time)
+        delivery_timer(order_time)
     else:
         print("Not a valid input")
         retry = input("Do you want to retry? (y/q): ").lower()
         if retry != "y":
             break
-

Programs/QuizGame.py

@@ -1,4 +1,32 @@
-print("Welcome to my computer quize!")
+# ================= Problem Description =================
+# This script implements a simple computer quiz game.
+# The user is prompted to play a quiz where they answer a question about computer hardware.
+# 
+# 1. Greets the user and asks if they want to play.
+# 2. If the user responds with "yes", the quiz starts; otherwise, the program exits.
+# 3. Asks the user a question about what CPU stands for.
+# 4. Evaluates the user's answer and updates the score based on correctness.
+# 5. Displays the final score and ends the quiz.
+#
+# ================= Input =================
+# - User's response to the initial prompt ("yes" or any other response).
+# - User's answer to the quiz question.
+#
+# ================= Output =================
+# - Feedback on the correctness of the answer.
+# - The final score after the quiz.
+#
+# Example:
+# Input:
+# Do you want to play? yes
+# What does CPU stand for? central processing unit
+# Output:
+# Correct
+# Your score is 1
+# END
+# =========================================================
+
+print("Welcome to my computer quiz!")
 
 playing = input("Do you want to play? ")
 
@@ -8,13 +36,12 @@
     print("Ok, let's play!")
     score = 0
 
-answer = input("What dose CPU stand for? ")
-if answer.lower() == "central processing unit" :
-    print("Correct") 
-    score += 1
-else: 
-    print("Incorrct")
-    
+    answer = input("What does CPU stand for? ")
+    if answer.lower() == "central processing unit":
+        print("Correct") 
+        score += 1
+    else: 
+        print("Incorrect")
 
-print("Your score is " + str(score))
-print("END")
+    print(f"Your score is {score}")
+    print("END")

Programs/SwapTwoVariables.py

@@ -1,3 +1,28 @@
+# ================= Problem Description =================
+# This script demonstrates two methods for swapping the values of two variables and checks if a number is even or odd.
+#
+# 1. **Variable Swapping**: 
+#    - Solution 01 swaps the values of two variables using a temporary variable.
+#    - Solution 02 swaps the values of two variables using tuple unpacking.
+# 2. **Number Check**:
+#    - Checks if a predefined number is even or odd and prints the result.
+#
+# ================= Input =================
+# - No user input is required for variable swapping.
+# - A predefined number is used for checking even or odd.
+#
+# ================= Output =================
+# - Displays the swapped values of the variables.
+# - Displays whether the predefined number is even or odd.
+#
+# Example:
+# Output for variable swapping:
+# x is 7 y is 5
+#
+# Output for number check:
+# Odd number
+# =========================================================
+
 # ============= Solution 01 =============
 # x = 5
 # y = 7
@@ -9,12 +34,12 @@
 # ============= Solution 02 =============
 x = 5
 y = 7
-x,y =y ,x
+x, y = y, x
 
-print("x is ", x, "y is ", y)
+print("x is", x, "y is", y)
 
 number = 11
 if number % 2 == 0:
     print("Even number")
 else:
-    print("Odd number")
+    print("Odd number")