Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 32 additions & 30 deletions Password-Checker/README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,72 @@
# Password-Checker

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.
Password-Checker is a simple script that checks the strength of a given password and provides suggestions to improve its security. It can also suggest a stronger password based on the given input.

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.
You can provide input either as a command-line argument or interactively through the terminal *(interactive mode is recommended)*. This script performs only basic checks and is intended as a minimal example.

> [!IMPORTANT]
> 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.
> This script serves as a foundational example and may not be fully suitable for real-world use cases. Its purpose is to provide a starting point for learning and further improvements.

---

## Requirements

The only requirement for running this script in your local system is Python 3.6 or above. No external dependencies are required.
- Python **3.6 or above**
- No external dependencies required

---

## Usage

### For *unix-based systems
To use this script, run the following command:
### For Unix-based systems

```bash
# Run the script directly
curl -s https://raw.githubusercontent.com/Grow-with-Open-Source/Python-Projects/main/Password-Checker/check-password.py | python
```

or

```bash
# OR
wget -qO- https://raw.githubusercontent.com/Grow-with-Open-Source/Python-Projects/main/Password-Checker/check-password.py | python
```

or you can download the file from GitHub and then run the script by giving permission to execute the file as shown below:
# Alternatively, download the script and run locally:

```bash
# Downloading the script
# Download the script
wget https://raw.githubusercontent.com/Grow-with-Open-Source/Python-Projects/main/Password-Checker/check-password.py

# --- OR ---
# curl -o script.py https://raw.githubusercontent.com/Grow-with-Open-Source/Python-Projects/main/Password-Checker/check-password.py
# ----------
# curl -o check-password.py https://raw.githubusercontent.com/Grow-with-Open-Source/Python-Projects/main/Password-Checker/check-password.py

# Giving permission to execute the file
# Give execute permission
chmod +x check-password.py

# Running the script
# Run the script
./check-password.py
```

### For Windows

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:
# On Windows 10 or later, PowerShell usually includes curl

```powershell
Invoke-WebRequest https://raw.githubusercontent.com/Grow-with-Open-Source/Python-Projects/main/Password-Checker/check-password.py -OutFile "$env:TEMP\temp_script.py"
python "$env:TEMP\temp_script.py"
```
# Download and run the script temporarily
Invoke-WebRequest https://raw.githubusercontent.com/Grow-with-Open-Source/Python-Projects/main/Password-Checker/check-password.py -OutFile "$env:TEMP\check_password.py"
python "$env:TEMP\check_password.py"

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.
# Alternatively, download the script to a folder and run using Python interpreter

## Contributing

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.
# Before contributing:
# 1. Make sure you have run and understood the script.
# 2. Review the repository’s Contributing Guidelines:
# https://github.com/Grow-with-Open-Source/Python-Projects/blob/main/CONTRIBUTING.md

> [!NOTE]
> 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.
# Notes:
# - Since this mini-project is intended as a sample groundwork for enhancements,
# please record your changes and contributions in the Change Log section.

## Change Log

- PR [#37](https://github.com/Grow-with-Open-Source/Python-Projects/pull/37): Created the basic script with minimum features.
- PR #37: Created the basic script with minimum features.

## License

This project is released under the [Apache License 2.0](https://github.com/Grow-with-Open-Source/Python-Projects/blob/main/LICENSE).
This project is released under the Apache License 2.0:
https://github.com/Grow-with-Open-Source/Python-Projects/blob/main/LICENSE