user-scanner 1.0.8.1__tar.gz → 1.1.0.2__tar.gz

user_scanner-1.1.0.2/PKG-INFO

@@ -0,0 +1,237 @@
+Metadata-Version: 2.4
+Name: user-scanner
+Version: 1.1.0.2
+Summary: Check username availability across multiple popular platforms
+Keywords: username,checker,availability,social,tech,python,user-scanner
+Author-email: Kaif <kafcodec@gmail.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx[http2]>=0.27,<0.29
+Requires-Dist: socksio>=1.0,<2
+Requires-Dist: colorama>=0.4,<1
+Project-URL: Homepage, https://github.com/kaifcodec/user-scanner
+
+# User Scanner
+
+![User Scanner Logo](https://github.com/user-attachments/assets/49ec8d24-665b-4115-8525-01a8d0ca2ef4)
+<p align="center">
+  <img src="https://img.shields.io/badge/Version-1.1.0.2-blueviolet?style=for-the-badge&logo=github" />
+  <img src="https://img.shields.io/github/issues/kaifcodec/user-scanner?style=for-the-badge&logo=github" />
+  <img src="https://img.shields.io/badge/Tested%20on-Termux-black?style=for-the-badge&logo=termux" />
+  <img src="https://img.shields.io/badge/Tested%20on-Windows-cyan?style=for-the-badge&logo=Windows" />
+  <img src="https://img.shields.io/badge/Tested%20on-Linux-balck?style=for-the-badge&logo=Linux" />
+  <img src="https://img.shields.io/pepy/dt/user-scanner?style=for-the-badge" />
+</p>
+
+---
+
+A powerful *Email OSINT tool* that checks if a specific email is registered on various sites, combined with *username scanning* for branding or OSINT — 2-in-1 tool.  
+
+Perfect for fast, accurate and lightweight email OSINT
+
+Perfect for finding a **unique username** across GitHub, Twitter, Reddit, Instagram, and more, all in a single command.  
+
+## Features
+
+- ✅ Check an email across multiple sites to see if it’s registered.  
+- ✅ Scan usernames across **social networks**, **developer platforms**, **creator communities**, and more.  
+- ✅ Can be used purely as a username tool.  
+- ✅ Smart auto-update system detects new releases on PyPI and prompts the user to upgrade interactively.  
+- ✅ Clear `Registered` and `Not Registered` for email scanning `Available` / `Taken` / `Error` output for username scans
+- ✅ Robust error handling: displays the exact reason a username or email cannot be used (e.g., underscores or hyphens at the start/end).  
+- ✅ Fully modular: easily add new platform modules.  
+- ✅ Wildcard-based username permutations for automatic variation generation using a provided suffix.  
+- ✅ Option to select results format (**JSON**, **CSV**, console).  
+- ✅ Save scanning and OSINT results in the preferred format and output file (ideal for power users).  
+- ✅ Command-line interface ready: works immediately after `pip install`.  
+- ✅ Lightweight with minimal dependencies; runs on any machine.
+- ✅ **Proxy support** with round-robin rotation
+- ✅ **Proxy validation** to test and filter working proxies before scanning
+- ✅ **Bulk username scanning** from file support for checking multiple usernames at once
+- ✅ **Bulk email scanning** from file support for checking multiple emails at once
+---
+
+## Installation
+
+```bash
+pip install user-scanner
+```
+
+---
+
+## Important Flags
+
+| Flag | Description |
+|------|-------------|
+| `-u, --username USERNAME` | Scan a single username across platforms |
+| `-e, --email EMAIL`       | Scan a single email across platforms |
+| `-uf, --username-file FILE` | Scan multiple usernames from file (one per line) |
+| `-ef, --email-file FILE`  | Scan multiple emails from file (one per line) |
+| `-c, --category CATEGORY` | Scan all platforms in a specific category |
+| `-lu, --list-user` | List all available modules for username scanning |
+| `-le, --list-email` | List all available modules for email scanning |
+| `-m, --module MODULE`     | Scan a single specific module |
+| `-p, --permute PERMUTE`   | Generate username permutations using a pattern/suffix |
+| `-P, --proxy-file FILE`   | Use proxies from file (one per line) |
+| `--validate-proxies`      | Validate proxies before scanning (tests against google.com) |
+| `-s, --stop STOP`         | Limit the number of permutations generated |
+| `-d, --delay DELAY`       | Delay (in seconds) between requests |
+| `-f, --format {csv,json}` | Select output format |
+| `-o, --output OUTPUT`     | Save results to a file |
+
+---
+
+## Usage
+
+### Basic username/email scan
+
+Scan a single username across **all** available modules/platforms:
+
+```bash
+user-scanner -e john_doe@gmail.com
+user-scanner --email john_doe@gmail.com # long version
+
+user-scanner -u john_doe
+user-scanner --username john_doe # long version
+```
+
+### Selective scanning
+
+Scan only specific categories or single modules:
+
+```bash
+user-scanner -u john_doe -c dev # developer platforms only
+user-scanner -u john_doe -m github # only GitHub
+```
+
+### Bulk username scanning
+
+Scan multiple usernames from a file (one username per line):
+- Can also be combined with categories or modules using `-c` and `-m` flags
+
+```bash
+user-scanner -uf usernames.txt
+```
+
+
+### Bulk email scanning
+
+Scan multiple emails from a file (one email per line):
+- Can also be combined with categories or modules using `-c` and `-m` flags
+
+```bash
+user-scanner -ef emails.txt
+```
+
+### Username/Email variations (suffix only)
+
+Generate & check username variations using a permutation from the given suffix:
+
+```bash
+user-scanner -u john_ -p ab # john_a, ..., john_ab, john_ba
+```
+
+### Using Proxies
+
+Route requests through proxy servers:
+
+```bash
+user-scanner -u john_doe -P proxies.txt
+```
+
+Validate proxies before scanning (tests each proxy against google.com):
+
+```bash
+user-scanner -u john_doe -P proxies.txt --validate-proxies # recommended
+```
+
+This will:
+1. Test all proxies from the file
+2. Filter out non-working proxies
+3. Save working proxies to `validated_proxies.txt`
+4. Use only validated proxies for scanning
+
+---
+
+### Update
+
+Update the tool to the latest PyPI version:
+
+```bash
+user-scanner -U
+```
+---
+
+## Screenshot: 
+
+- Note*: New modules are constantly getting added so this might have only limited, outdated output:
+
+<img width="1072" height="848" alt="user-scanner's main usage screenshot" src="https://github.com/user-attachments/assets/34e44ca6-e314-419e-9035-d951b493b47f" />
+
+
+
+---
+
+<img width="1080" height="352" alt="user-scanner's wildcard username feature" src="https://github.com/user-attachments/assets/578b248c-2a05-4917-aab3-6372a7c28045" />
+
+
+---
+
+## Contributing
+
+Modules are organized under `user_scanner/`:
+
+```
+user_scanner/
+├── email_scan/       # Currently in development
+│   ├── social/       # Social email scan modules (Instagram, Mastodon, X, etc.)
+|   ├── adult/        # Adult sites 
+|    ...               # New sites to be added soon
+├── user_scan/
+│   ├── dev/          # Developer platforms (GitHub, GitLab, npm, etc.)
+│   ├── social/       # Social platforms (Twitter/X, Reddit, Instagram, Discord, etc.)
+│   ├── creator/      # Creator platforms (Hashnode, Dev.to, Medium, Patreon, etc.)
+│   ├── community/    # Community platforms (forums, StackOverflow, HackerNews, etc.)
+│   ├── gaming/       # Gaming sites (chess.com, Lichess, Roblox, Minecraft, etc.)
+│   └── donation/     # Donation platforms (BuyMeACoffee, Liberapay)
+|...
+```
+
+**Module guidelines:**
+This project contains small "validator" modules that check whether a username exists on a given platform. Each validator is a single function that returns a Result object (see `core/orchestrator.py`).
+
+Result semantics:
+- Result.available() → `available`
+- Result.taken() → `taken`
+- Result.error(message: Optional[str]) → `error`, blocked, unknown, or request failure (include short diagnostic message when helpful)
+
+Follow this document when adding or updating validators.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for examples.
+
+---
+
+## Dependencies: 
+- [httpx](https://pypi.org/project/httpx/)
+- [colorama](https://pypi.org/project/colorama/)
+
+---
+
+## License
+
+This project is licensed under the **MIT License**. See [LICENSE](LICENSE) for details.
+
+
+---
+
+## Star History
+
+<a href="https://www.star-history.com/#kaifcodec/user-scanner&type=date&legend=top-left">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=kaifcodec/user-scanner&type=date&theme=dark&legend=top-left" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=kaifcodec/user-scanner&type=date&legend=top-left" />
+   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=kaifcodec/user-scanner&type=date&legend=top-left" />
+ </picture>
+</a>
+

user_scanner-1.1.0.2/README.md

@@ -0,0 +1,222 @@
+# User Scanner
+
+![User Scanner Logo](https://github.com/user-attachments/assets/49ec8d24-665b-4115-8525-01a8d0ca2ef4)
+<p align="center">
+  <img src="https://img.shields.io/badge/Version-1.1.0.2-blueviolet?style=for-the-badge&logo=github" />
+  <img src="https://img.shields.io/github/issues/kaifcodec/user-scanner?style=for-the-badge&logo=github" />
+  <img src="https://img.shields.io/badge/Tested%20on-Termux-black?style=for-the-badge&logo=termux" />
+  <img src="https://img.shields.io/badge/Tested%20on-Windows-cyan?style=for-the-badge&logo=Windows" />
+  <img src="https://img.shields.io/badge/Tested%20on-Linux-balck?style=for-the-badge&logo=Linux" />
+  <img src="https://img.shields.io/pepy/dt/user-scanner?style=for-the-badge" />
+</p>
+
+---
+
+A powerful *Email OSINT tool* that checks if a specific email is registered on various sites, combined with *username scanning* for branding or OSINT — 2-in-1 tool.  
+
+Perfect for fast, accurate and lightweight email OSINT
+
+Perfect for finding a **unique username** across GitHub, Twitter, Reddit, Instagram, and more, all in a single command.  
+
+## Features
+
+- ✅ Check an email across multiple sites to see if it’s registered.  
+- ✅ Scan usernames across **social networks**, **developer platforms**, **creator communities**, and more.  
+- ✅ Can be used purely as a username tool.  
+- ✅ Smart auto-update system detects new releases on PyPI and prompts the user to upgrade interactively.  
+- ✅ Clear `Registered` and `Not Registered` for email scanning `Available` / `Taken` / `Error` output for username scans
+- ✅ Robust error handling: displays the exact reason a username or email cannot be used (e.g., underscores or hyphens at the start/end).  
+- ✅ Fully modular: easily add new platform modules.  
+- ✅ Wildcard-based username permutations for automatic variation generation using a provided suffix.  
+- ✅ Option to select results format (**JSON**, **CSV**, console).  
+- ✅ Save scanning and OSINT results in the preferred format and output file (ideal for power users).  
+- ✅ Command-line interface ready: works immediately after `pip install`.  
+- ✅ Lightweight with minimal dependencies; runs on any machine.
+- ✅ **Proxy support** with round-robin rotation
+- ✅ **Proxy validation** to test and filter working proxies before scanning
+- ✅ **Bulk username scanning** from file support for checking multiple usernames at once
+- ✅ **Bulk email scanning** from file support for checking multiple emails at once
+---
+
+## Installation
+
+```bash
+pip install user-scanner
+```
+
+---
+
+## Important Flags
+
+| Flag | Description |
+|------|-------------|
+| `-u, --username USERNAME` | Scan a single username across platforms |
+| `-e, --email EMAIL`       | Scan a single email across platforms |
+| `-uf, --username-file FILE` | Scan multiple usernames from file (one per line) |
+| `-ef, --email-file FILE`  | Scan multiple emails from file (one per line) |
+| `-c, --category CATEGORY` | Scan all platforms in a specific category |
+| `-lu, --list-user` | List all available modules for username scanning |
+| `-le, --list-email` | List all available modules for email scanning |
+| `-m, --module MODULE`     | Scan a single specific module |
+| `-p, --permute PERMUTE`   | Generate username permutations using a pattern/suffix |
+| `-P, --proxy-file FILE`   | Use proxies from file (one per line) |
+| `--validate-proxies`      | Validate proxies before scanning (tests against google.com) |
+| `-s, --stop STOP`         | Limit the number of permutations generated |
+| `-d, --delay DELAY`       | Delay (in seconds) between requests |
+| `-f, --format {csv,json}` | Select output format |
+| `-o, --output OUTPUT`     | Save results to a file |
+
+---
+
+## Usage
+
+### Basic username/email scan
+
+Scan a single username across **all** available modules/platforms:
+
+```bash
+user-scanner -e john_doe@gmail.com
+user-scanner --email john_doe@gmail.com # long version
+
+user-scanner -u john_doe
+user-scanner --username john_doe # long version
+```
+
+### Selective scanning
+
+Scan only specific categories or single modules:
+
+```bash
+user-scanner -u john_doe -c dev # developer platforms only
+user-scanner -u john_doe -m github # only GitHub
+```
+
+### Bulk username scanning
+
+Scan multiple usernames from a file (one username per line):
+- Can also be combined with categories or modules using `-c` and `-m` flags
+
+```bash
+user-scanner -uf usernames.txt
+```
+
+
+### Bulk email scanning
+
+Scan multiple emails from a file (one email per line):
+- Can also be combined with categories or modules using `-c` and `-m` flags
+
+```bash
+user-scanner -ef emails.txt
+```
+
+### Username/Email variations (suffix only)
+
+Generate & check username variations using a permutation from the given suffix:
+
+```bash
+user-scanner -u john_ -p ab # john_a, ..., john_ab, john_ba
+```
+
+### Using Proxies
+
+Route requests through proxy servers:
+
+```bash
+user-scanner -u john_doe -P proxies.txt
+```
+
+Validate proxies before scanning (tests each proxy against google.com):
+
+```bash
+user-scanner -u john_doe -P proxies.txt --validate-proxies # recommended
+```
+
+This will:
+1. Test all proxies from the file
+2. Filter out non-working proxies
+3. Save working proxies to `validated_proxies.txt`
+4. Use only validated proxies for scanning
+
+---
+
+### Update
+
+Update the tool to the latest PyPI version:
+
+```bash
+user-scanner -U
+```
+---
+
+## Screenshot: 
+
+- Note*: New modules are constantly getting added so this might have only limited, outdated output:
+
+<img width="1072" height="848" alt="user-scanner's main usage screenshot" src="https://github.com/user-attachments/assets/34e44ca6-e314-419e-9035-d951b493b47f" />
+
+
+
+---
+
+<img width="1080" height="352" alt="user-scanner's wildcard username feature" src="https://github.com/user-attachments/assets/578b248c-2a05-4917-aab3-6372a7c28045" />
+
+
+---
+
+## Contributing
+
+Modules are organized under `user_scanner/`:
+
+```
+user_scanner/
+├── email_scan/       # Currently in development
+│   ├── social/       # Social email scan modules (Instagram, Mastodon, X, etc.)
+|   ├── adult/        # Adult sites 
+|    ...               # New sites to be added soon
+├── user_scan/
+│   ├── dev/          # Developer platforms (GitHub, GitLab, npm, etc.)
+│   ├── social/       # Social platforms (Twitter/X, Reddit, Instagram, Discord, etc.)
+│   ├── creator/      # Creator platforms (Hashnode, Dev.to, Medium, Patreon, etc.)
+│   ├── community/    # Community platforms (forums, StackOverflow, HackerNews, etc.)
+│   ├── gaming/       # Gaming sites (chess.com, Lichess, Roblox, Minecraft, etc.)
+│   └── donation/     # Donation platforms (BuyMeACoffee, Liberapay)
+|...
+```
+
+**Module guidelines:**
+This project contains small "validator" modules that check whether a username exists on a given platform. Each validator is a single function that returns a Result object (see `core/orchestrator.py`).
+
+Result semantics:
+- Result.available() → `available`
+- Result.taken() → `taken`
+- Result.error(message: Optional[str]) → `error`, blocked, unknown, or request failure (include short diagnostic message when helpful)
+
+Follow this document when adding or updating validators.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for examples.
+
+---
+
+## Dependencies: 
+- [httpx](https://pypi.org/project/httpx/)
+- [colorama](https://pypi.org/project/colorama/)
+
+---
+
+## License
+
+This project is licensed under the **MIT License**. See [LICENSE](LICENSE) for details.
+
+
+---
+
+## Star History
+
+<a href="https://www.star-history.com/#kaifcodec/user-scanner&type=date&legend=top-left">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=kaifcodec/user-scanner&type=date&theme=dark&legend=top-left" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=kaifcodec/user-scanner&type=date&legend=top-left" />
+   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=kaifcodec/user-scanner&type=date&legend=top-left" />
+ </picture>
+</a>

{user_scanner-1.0.8.1 → user_scanner-1.1.0.2}/pyproject.toml

@@ -4,19 +4,21 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "user-scanner"
-version = "1.0.8.1"
+version = "1.1.0.2"
 description = "Check username availability across multiple popular platforms"
 readme = "README.md"
 license = {file = "LICENSE"}
 authors = [
   {name = "Kaif", email = "kafcodec@gmail.com"}
 ]
+
 dependencies = [
-  "httpx",
-  "colorama"
+  "httpx[http2]>=0.27,<0.29",
+  "socksio>=1.0,<2",
+  "colorama>=0.4,<1"
 ]
 
-requires-python = ">=3.7"
+requires-python = ">=3.10"
 keywords = ["username", "checker", "availability", "social", "tech", "python", "user-scanner"]
 
 [project.urls]
@@ -27,3 +29,7 @@ user-scanner = "user_scanner.__main__:main"
 
 [tool.flit.sdist]
 exclude = ["tests/", "docs/", ".github/", ".git", "rm_pycache.py", "che.py", ".gitignore"]
+
+[tool.pytest.ini_options]
+pythonpath = "."
+testpaths = ["tests"]