Skip to content

Commit 187864d

Browse files
authored
Create README.md
1 parent 03c882b commit 187864d

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
2+
# Password Strength Checker
3+
4+
A Python-based tool that checks password strength in real-time, providing feedback on complexity, evaluating entropy, checking against common passwords, and verifying if the password has been exposed in data breaches using the "Have I Been Pwned" API.
5+
6+
## Features:
7+
- **Real-Time Feedback**: Provides immediate feedback on password strength as you type.
8+
- **Password Rating System**: Rates the password as "Good", "Fair", or "Poor" based on entropy, breach risk, and character variety.
9+
- **Password Breach Risk**: Checks if the password has been exposed in data breaches and assigns a risk score.
10+
- **Password Complexity Analysis**: Evaluates the password's entropy and variety (length, characters, numbers, symbols).
11+
- **Visualization**: Generates a graphical report of the password's performance in various security criteria.
12+
- **Common Password List**: Uses an up-to-date list of common passwords fetched from an external source.
13+
14+
## Installation:
15+
16+
1. Clone the repository:
17+
```bash
18+
git clone https://github.com/your-username/password-strength-checker.git
19+
```
20+
21+
2. Navigate into the project directory:
22+
```bash
23+
cd password-strength-checker
24+
```
25+
26+
3. Create a virtual environment (optional, but recommended):
27+
```bash
28+
python -m venv venv
29+
```
30+
31+
4. Activate the virtual environment:
32+
- On **Windows**:
33+
```bash
34+
venv\Scripts\activate
35+
```
36+
- On **macOS/Linux**:
37+
```bash
38+
source venv/bin/activate
39+
```
40+
41+
5. Install the required dependencies:
42+
```bash
43+
pip install -r requirements.txt
44+
```
45+
46+
## Usage:
47+
48+
To run the script, simply execute:
49+
50+
```bash
51+
python password_strength_checker.py
52+
```
53+
54+
You will be prompted to enter a password. The tool will evaluate the strength of the password and give you real-time feedback. After submitting the password, a visual report will be generated showing how it performs across various security criteria.
55+
56+
## Dependencies:
57+
- `requests` - for making HTTP requests to the "Have I Been Pwned" API.
58+
- `password-strength` - for evaluating password complexity and strength.
59+
- `matplotlib` - for generating graphical reports.
60+
- `colorama` - for adding color to the terminal output.
61+
62+
## License:
63+
64+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)