Feedback to address & tasks to complete for Milestone 4

[Kierst01]

Below is a summary of feedback we have received and addressed:

• Expand the comparison between our package and existing packages. (2121038)
• Add explanation for why we chose to code our functions as we did. (2121038)
• in test_decrypt_password.py it needs to be clear that encrypted_password is an argument not a function (19e2aa9, 42809f1, 5856ed0)
• Add more badges for continuous integration, Python version compatibility (4cb6173)
• Update functions to use string.ascii. (0657c89, 82df255, 39a25c5)
• Remove empty files in src and tests. (db5611f)
• Update README to add backticks to function names, and change installation instructions into smaller more explicit steps. (b76e6c3, 20f25d2)
• Include link to ReadTheDocs in our README. (b53f747)
• Change wording from message to password for encryption and decryption functions (2b8e0a5, 153d847, b07e792, d251769, e994032)
• Add a logo (fdc3e33)
• Add examples to docstrings (fc1d469, f41a242, da9cd77)
• Add in-code comments to the functions (26fb9dd)

Other tasks to complete for milestone 4:

• Set up CI github action
• Set up CD github actions
• Choose a suitable license (Choose a license #79 (comment))
• Use Github Issues for discussions

[zywkloo]

2. Add an explanation for why we chose to code our functions as we did.

My thought to answer this question, feel free to update it to make it more native English, and/or include that in the Readme.md(or anywhere necessary):

Unique Features of passwordler

passwordler stands out in the realm of password management packages due to its unique blend of user-friendliness and security, tailored for individuals with varying levels of technical expertise. Here's what sets passwordler apart:

• Ease of Understanding: Every aspect of the encryption and decryption process is designed to be easily understood, even by users with only high-school-level tech knowledge.

• Simplicity Over Complexity: The package avoids the complexity of nested package dependencies by not relying on industry-standard AES encryption and SHA-256 hashing techniques, which typically require third-party package imports.

• Enhanced Security for Beginners: Unlike naive encryption techniques like the Caesar Cipher and Vigenere Cipher, which are educational but also easy to crack with a finite number of guesses, passwordler provides a level of security that surpasses beginner-level algorithms.

• Original Algorithm: The encryption algorithm was developed from the ground up, maintaining originality and individual intellectual property. It is our unique creation, designed to be improved upon while offering a foundation in password security principles.

passwordler is perfect for users who want to understand and control their password security without delving into complex cryptographic standards. It offers more security than basic algorithms, all while ensuring the codebase remains accessible and maintainable.

[zywkloo]

• password is a 4-in-1 password package, with features to detect password strength and secure your password with beginner-understandable source code. It stands out from the other packages in the following ways:
  • Low professional knowledge requirement: even if a user with only high-school-level tech knowledge, it is easy to control and understand every part of the encryption and decryption process:
  • No nested package copy and paste: we didn't use industry-standard AES encryption and SHA-256 hashing techniques, as that involves 3rd party nested package import.
  • More security than the beginner-level algorithm: we didn't use the other naive/educational encryption techniques, like Caesar Cipher and Vigenere Cipher, since they are
  • Originality and individual IP: we created and developed our algorithm from scratch, and avoided simply interpreting the existing algorithm. It may need further enhancement, but it keeps originality and it is our own work.

This is my original writing

[zywkloo]

#78 (comment)
I see this issue was closed, by #86
However, these two boxes are not checked.
3. Separate cypher shuffling for encryption and decryption so they do not become uncoupled with future updates
4. Update password generator to include an argument for lower/uppercase characters
Do we still need to address them?
@rorywhite200 @mishelly-h @Kierst01

[zywkloo]

Also, I don't quite get this request.

• Change encryption and decryption functions so that they draw upon the same dictionary variable so that if changes are made in the future it does not cause problems.

Where is the original feedback comment? May I take a look, thanks. @Kierst01

[Kierst01]

#78 (comment) I see this issue was closed, by #86 However, these two boxes are not checked. 3. Separate cypher shuffling for encryption and decryption so they do not become uncoupled with future updates 4. Update password generator to include an argument for lower/uppercase characters Do we still need to address them? @rorywhite200 @mishelly-h @Kierst01

Initially, I thought #3 was the one that you had said you understood from the peer review feedback, upon further discussion we realized this isn't the case and so decided to not complete this feedback.
#4 required substantial changes to our function, so we decided to focus our effort on other improvements. This update would have been nice for customization, but our current function generates stronger passwords.

[Kierst01]

Also, I don't quite get this request.

* Change encryption and decryption functions so that they draw upon the same dictionary variable so that if changes are made in the future it does not cause problems.

Where is the original feedback comment? May I take a look, thanks. @Kierst01

This is the same as #3 above, and was from the peer review feedback! We have decided not to address this because it is unclear what the reviewer meant.

[zywkloo]

2. Add an explanation for why we chose to code our functions as we did.

My thought to answer this question, feel free to update it to make it more native English, and/or include that in the Readme.md(or anywhere necessary):

Unique Features of passwordler

passwordler stands out in the realm of password management packages due to its unique blend of user-friendliness and security, tailored for individuals with varying levels of technical expertise. Here's what sets passwordler apart:

• Ease of Understanding: Every aspect of the encryption and decryption process is designed to be easily understood, even by users with only high-school-level tech knowledge.
• Simplicity Over Complexity: The package avoids the complexity of nested package dependencies by not relying on industry-standard AES encryption and SHA-256 hashing techniques, which typically require third-party package imports.
• Enhanced Security for Beginners: Unlike naive encryption techniques like the Caesar Cipher and Vigenere Cipher, which are educational but also easy to crack with a finite number of guesses, passwordler provides a level of security that surpasses beginner-level algorithms.
• Original Algorithm: The encryption algorithm was developed from the ground up, maintaining originality and individual intellectual property. It is our unique creation, designed to be improved upon while offering a foundation in password security principles.

passwordler is perfect for users who want to understand and control their password security without delving into complex cryptographic standards. It offers more security than basic algorithms, all while ensuring the codebase remains accessible and maintainable.

Expand the comparison between our package and existing packages.
This should be covered by this change. I added a new section in the Readme that generally talked about why our package stands out.