Skip to content

Commit aaa24e4

Browse files
authored
Add files via upload
1 parent 8f98c03 commit aaa24e4

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed

docs/index.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# WordbuildPython
2+
3+
A powerful password wordlist generator with optional email/phone validation and breach checking.
4+
5+
## Project overview
6+
7+
This tool helps generate password lists from personal information and validate email/phone formats. It also supports searching the public "Have I Been Pwned?" API for breached accounts.
8+
9+
## Quick start
10+
11+
1. Install dependencies:
12+
13+
```bash
14+
pip install -r requirements.txt
15+
```
16+
17+
2. Run the tool:
18+
19+
```bash
20+
python main.py
21+
```
22+
23+
3. Choose an option from the interactive menu.
24+
25+
## Included workflows
26+
27+
- GitHub Actions tests and linting
28+
- Release automation
29+
- Dependency checks
30+
- Documentation build pipeline

docs/usage.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Usage
2+
3+
## Option 1 — Generate a password wordlist
4+
5+
Use this option to build a password list from a target's personal details.
6+
7+
- First name
8+
- Last name
9+
- Keywords/interests
10+
- Partner name
11+
- Birthday
12+
- Job
13+
- Pet name
14+
- Kids' names
15+
- City or zipcode
16+
- Lucky number
17+
- Phone number
18+
19+
The generator applies transformations such as:
20+
21+
- leet speak
22+
- alternating capitalization
23+
- vowel removal
24+
- reverse text
25+
- separators and numeric suffixes
26+
- birthday-based patterns
27+
- multi-field combinations
28+
29+
## Option 2 — Generate random emails
30+
31+
Generate random email addresses with a custom domain and optional keyword prefix.
32+
33+
## Option 3 — Generate phone numbers
34+
35+
Generate random phone numbers for supported country codes.
36+
37+
## Option 4 — Validate and breach-check
38+
39+
- Validate email format locally
40+
- Validate phone numbers with the `phonenumbers` library
41+
- Check a single email against Have I Been Pwned
42+
- Batch-check emails from a file against Have I Been Pwned
43+
44+
### HIBP rate limiting
45+
46+
The tool waits between requests to avoid abusing the public API and to keep usage respectful.

0 commit comments

Comments
 (0)