|
| 1 | +# Password-Checker |
| 2 | + |
| 3 | +Password-Checker is a simple script that checks the strength of a given password and provides suggestions to improve its security. It also suggests a better password based on the given password. |
| 4 | + |
| 5 | +You can either provide your input as a command line argument or interactively through the terminal _(but it's always recommended to use interactive session on console)_. This is a basic script that perform minimum basic checks and suggestion. |
| 6 | + |
| 7 | +> [!IMPORTANT] |
| 8 | +> Since this script serves as a foundational example, it may not be fully suitable for real-world use cases yet. However, its purpose is to establish a solid groundwork for more advanced versions. As the author, I look forward to seeing further improvements and refactoring that will enhance this script to meet real-world requirements. |
| 9 | +
|
| 10 | +## Requirements |
| 11 | + |
| 12 | +The only requirement for running this script in your local system is Python 3.6 or above. No external dependencies are required. |
| 13 | + |
| 14 | +## Usage |
| 15 | + |
| 16 | +### For *unix-based systems |
| 17 | +To use this script, run the following command: |
| 18 | + |
| 19 | +```bash |
| 20 | +curl -s https://raw.githubusercontent.com/Grow-with-Open-Source/Python-Projects/main/Password-Checker/check-password.py | python |
| 21 | +``` |
| 22 | + |
| 23 | +or |
| 24 | + |
| 25 | +```bash |
| 26 | +wget -qO- https://raw.githubusercontent.com/Grow-with-Open-Source/Python-Projects/main/Password-Checker/check-password.py | python |
| 27 | +``` |
| 28 | + |
| 29 | +or you can download the file from GitHub and then run the script by giving permission to execute the file as shown below: |
| 30 | + |
| 31 | +```bash |
| 32 | +# Downloading the script |
| 33 | +wget https://raw.githubusercontent.com/Grow-with-Open-Source/Python-Projects/main/Password-Checker/check-password.py |
| 34 | + |
| 35 | +# --- OR --- |
| 36 | +# curl -o script.py https://raw.githubusercontent.com/Grow-with-Open-Source/Python-Projects/main/Password-Checker/check-password.py |
| 37 | +# ---------- |
| 38 | + |
| 39 | +# Giving permission to execute the file |
| 40 | +chmod +x check-password.py |
| 41 | + |
| 42 | +# Running the script |
| 43 | +./check-password.py |
| 44 | +``` |
| 45 | + |
| 46 | +### For Windows |
| 47 | + |
| 48 | +Usually, powershell in Window 10 or later version consist of `curl` binary, so you can do that same thing as shown above. But in case it doesn't work, you can use the following command: |
| 49 | + |
| 50 | +```powershell |
| 51 | +Invoke-WebRequest https://raw.githubusercontent.com/Grow-with-Open-Source/Python-Projects/main/Password-Checker/check-password.py -OutFile "$env:TEMP\temp_script.py" |
| 52 | +python "$env:TEMP\temp_script.py" |
| 53 | +``` |
| 54 | + |
| 55 | +If you want to save the script for later usage, then it's best recommended to download the script in a desired location and run the script using python interpreter. |
| 56 | + |
| 57 | +## Contributing |
| 58 | + |
| 59 | +Please make sure you have used it this script before you start contributing, and then please go through the [Contributing Guidelines](https://github.com/Grow-with-Open-Source/Python-Projects/blob/main/CONTRIBUTING.md) to make your contribution. |
| 60 | + |
| 61 | +> [!NOTE] |
| 62 | +> Since this mini-project was meant to be a sample groundwork for more advancements, add your changes and contributions into the following [Change Log](#change-log) in the given format. |
| 63 | +
|
| 64 | +## Change Log |
| 65 | + |
| 66 | +- PR [#37](https://github.com/Grow-with-Open-Source/Python-Projects/pull/37): Created the basic script with minimum features. |
| 67 | + |
| 68 | +## License |
| 69 | + |
| 70 | +This project is released under the [Apache License 2.0](https://github.com/Grow-with-Open-Source/Python-Projects/blob/main/LICENSE). |
0 commit comments