UnstableUtilities 1.0.0

An utility tool that sometimes works :D

Badge

Python Package Exercise

Description

PyPi Page

Team

• Ziqiu (Edison) Wang
• Thomas Chen
• An Hai
• Annabella Lee

Installation

Usage Examples

1. calculator(equation: str) -> float/int This function finds the result of an equation given as a string. It randomly decides whether to perform a correct calculation or an intentionally "wrong" calculation. 95% of the time the calculator will generate a number that is either correct or wrong. 5% of the time the function will trigger a ‘system shutdown‘. If the shutdown is not triggered, the probability to generate correct calculation is 30% and 70% for wrong calculation.

The input equation has to be a string with spaces separating the numbers and operator.

Examples:

calculator(“3 + 6 * 8”) is the correct format to use.

calculator(“3 +”) is the wrong format to use. The equation should not start or end with an operator.

calculator(“3+6*8”) is the wrong format to use. The equation should have space in between all numbers and operators.

calculator(3 + 6 * 8) is the wrong format to use. The function only takes strings.

2. get_date() -> str

This function aims to return the current date. There is a 5% chance that a "crash" will be triggered, which causes a "system shutdown." If the crash is not triggered, there is a 30% chance that the function will return the correct date and a 70% chance that it will return an incorrect date. Among the incorrect results, the function might return a date that exists but is incorrect, a completely absurd date that doesn't exist, or a meaningless code snippet. Each of these three cases has an equal chance of occurring (33.3%).

Examples of possible outputs and their probabilities: get_date() -> 2024/11/4 (correct date): 28.5% get_date() -> 2000/12/21 (an existing but incorrect date): 22.2% get_date() -> 6666/40/59 (a completely absurd date): 22.2% get_date() -> "if x > 10:\n print('x is large')" (a generated code snippet): 22.2%
get_date() -> 'system shutdown' (shutdown is triggered): 5%

** 3.timer(countdown_time: int = 20) -> None **
timer: This is the name of the function.

countdown_time: int = 20:
countdown_time is an optional parameter, and it is of type int. Default value is 20, which means if no argument is passed, the countdown will be for 20 seconds.
The function performs actions (i.e., simulates a countdown) but does not return any result.
There is a 70% chance that the countdown will proceed normally, reducing by 1 second every second.
If it does not proceed normally, there is a 70% chance of randomly executing one of the following modes during the remaining countdown time:

normal: Normal countdown, reducing by 1 second every second. 30% probability. three_sec_jump: Wait for 3 seconds before reducing by 1 second. 30% probability. three_jumps_per_sec: Output 3 times per second, reducing by 1 second for each output (approximately every 0.33 seconds). 30% probability. early_stop: Randomly stops the countdown early and prints "Done!". 10% probability.
Return Value: The function prints "Done!" after completing the countdown.

4. Encoding and Decoding Strings

This package provides four algorithms to encode and decode strings: Morse Code, Caesar, Vigenère, and Base64.

Encoding

The encoding function takes as arguments an input string to encode, the type of algorithm to use, and an optional shift (for Caesar) and keyword (for Vigenère).

encode(inp_str, type, shift=1, keyword="key")

Calling this function has a 5% chance to immediately trigger a system shutdown. If the shutdown is not triggered, it either returns a correctly encoded string with 50% probability or a wrong output with 50% probability. This wrong output is a string that results from applying a random encoding algorithm to each character of the input string.

The function returns None if the format of any argument is invalid. The format specifications are as follows:

• inp_str: the string that needs to be encoded.

  • For Morse Code algorithm, the string may only contain English letters, digits, or spaces.
  • For Base64, Caesar, and Vigenère algorithms, the string may be any string.

• type: a string that specifies the type of algorithm to use: "morse", "base64", "caesar", or "vigenere". This argument is case-insensitive.

• shift: an integer that indicates the shift used by Caesar algorithm. Must be provided when using Caesar. Default value is 1.

• keyword: a string that specifies the keyword used by Vigenère algorithm. It may only contain English letters. Must be provided when using Vigenère. Default value is "key".

Usage examples for encode():

from crypto import encode

print(encode("input string", type="caesar", shift=3))
print(encode("Input string", type="Vigenere", keyword="key"))
print(encode("Input string1", type="MORSE CODE"))
print(encode("input string", type="base64"))

Decoding

Just like the encoding function, the decoding function takes as arguments an input string to decode, the type of algorithm to use, and an optional shift (for Caesar) and keyword (for Vigenère).

decode(inp_str, type, shift=1, keyword="key")

Calling this function has a 5% chance to immediately trigger a system shutdown. If the shutdown is not triggered, it either returns a correctly decoded string with 50% probability or a wrong output with 50% probability. This wrong output can be either a randomly generated string (50% probability), or a string that results from applying a random decoding algorithm to each group of 1-5 characters of the input string (50% probability).

The function returns None if the format of any argument is invalid. The format specifications are as follows:

• inp_str: the string that needs to be decoded.

  • For Morse Code algorithm, the string may only contain "-", ".", or spaces.
  • For Base64 algorithm, the string may only contain English letters, digits, "+", "/", or "=".
  • For Caesar and Vigenère algorithms, the string may be any string.

• type: a string that specifies the type of algorithm to use: "morse", "base64", "caesar", or "vigenere". This argument is case-insensitive.

• shift: an integer that indicates the shift used by Caesar algorithm when the input string was encoded. Must be provided when using Caesar. Default value is 1.

• keyword: a string that specifies the keyword used by Vigenère algorithm when the input string was encoded. It may only contain English letters. Must be provided when using Vigenère. Default value is "key".

Usage examples for decode():

from crypto import decode

print(decode("input string", type="caesar", shift=3))
print(decode("Input string1", type="Vigenere", keyword="key"))
print(decode(".- -..", type="MORSE CODE"))
print(decode("aGVsbG8=", type="base64"))

##Install Dependencies and Virtual Environment -- Step 1: Install pipenv (Suppose you have python. If not, download python first)
run "pip install pipenv" in terminal

-- Step 2: Install Project Dependencies with Pipenv
run "pipenv install" in terminal

-- Step 3: Run Virtual Environment
run “pipenv shell" in terminal

How To Test/Run

• Step 1: Install pipenv (Suppose you have python. If not, download python first)
  run "pip install pipenv" in terminal
  

• Step 2: Install Project Dependencies with Pipenv
  run "pipenv install" in terminal
  

• Step 3: Run Virtual Environment
  run “pipenv shell" in terminal
  

• Step 4: Run pytest/python files
  pytest()

python _filename.py
  
  

Contributing

1. Fork the Repository:

• Our Package
• Open our package and click "fork" to save files in your own repository

2. Clone the Repository:
   In your own repository, use
   git clone <repository-url>

3. Navigate into the Project Directory
   cd project-repo

4. Create a New Branch for Your Changes:
   git checkout -b feature/my-new-feature

5. Install Dependencies
   see part Install Dependencies and Virtual Environment

6. Make Changes or Add Features

7. Stage Your Changes
   git add <file-name>

8. Commit Your Changes
   git commit -m "your commence"

9. Push Your Branch to Your Fork
   git push origin feature/my-new-feature

10. Create a Pull Request
    In the PR, describe the changes you made and their purpose

How To Import Package

• Prerequisite: Installed pip in local environment, recommend running under virtual environment (see part Install Dependencies and Virtual Environment)
  

• Step 1: install package
  pip install unstable_utilities
  

• Step 2: import package
  import unstable_utilities
  

• Step 3: import function
  pip install unstable_utilities