# User Scanner
Scan a username across multiple social, developer, and creator platforms to see if it’s available.
Perfect for finding a **unique username** across GitHub, Twitter, Reddit, Instagram, and more, all in one command.
---
## Features
- ✅ Check usernames across **social networks**, **developer platforms**, and **creator communities**.
- ✅ Clear **Available / Taken / Error** output for each platform.
- ✅ Fully modular: add new platform modules easily.
- ✅ Command-line interface ready: works directly after `pip install`.
---
## Installation
```bash
pip install user-scanner
```
---
## Usage
Scan a username across all platforms:
```bash
user-scanner -u <username>
```
Optionally, scan a specific category or single module:
```bash
user-scanner -u <username> -c dev
user-scanner -l # Lists all available modules
user-scanner -u <username> -m github
```
---
## Contributing
Modules are organized by category:
```
user_scanner/
├── dev/ # Developer platforms (GitHub, GitLab, etc.)
├── social/ # Social platforms (Twitter/X, Reddit, Instagram, etc.)
├── creator/ # Creator platforms (Hashnode, Dev.to, Medium, etc.)
├── community/ # Community platforms (forums, niche sites)
```
**Module guidelines:**
- Each module must define a `validate_<site>()` function that takes a `username` and returns:
- `1` → Available
- `0` → Taken
- `2` → Error / Could not check
- Use `httpx` for requests, `colorama` for colored output.
- Optional: modules can define a CLI parser if they support custom arguments.
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.
## ⚠️ `community/` is small looking for contributions
Raw data
{
"_id": null,
"home_page": null,
"name": "user-scanner",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "username, checker, availability, social, tech, python, user-scanner",
"author": null,
"author_email": "Kaif <kafcodec@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fa/26/6baa2ea3c06e13a0f4dc8845c0cba6730de9829a0c526a5c96c078ab9157/user_scanner-1.0.0.5.tar.gz",
"platform": null,
"description": "# User Scanner\n\nScan a username across multiple social, developer, and creator platforms to see if it\u2019s available. \nPerfect for finding a **unique username** across GitHub, Twitter, Reddit, Instagram, and more, all in one command.\n\n---\n\n## Features\n\n- \u2705 Check usernames across **social networks**, **developer platforms**, and **creator communities**.\n- \u2705 Clear **Available / Taken / Error** output for each platform.\n- \u2705 Fully modular: add new platform modules easily.\n- \u2705 Command-line interface ready: works directly after `pip install`.\n\n---\n\n## Installation\n\n```bash\npip install user-scanner\n```\n\n---\n\n## Usage\n\nScan a username across all platforms:\n\n```bash\nuser-scanner -u <username>\n```\nOptionally, scan a specific category or single module:\n\n```bash\nuser-scanner -u <username> -c dev\nuser-scanner -l # Lists all available modules\nuser-scanner -u <username> -m github\n\n```\n---\n\n## Contributing\n\nModules are organized by category:\n\n```\nuser_scanner/\n\u251c\u2500\u2500 dev/ # Developer platforms (GitHub, GitLab, etc.)\n\u251c\u2500\u2500 social/ # Social platforms (Twitter/X, Reddit, Instagram, etc.)\n\u251c\u2500\u2500 creator/ # Creator platforms (Hashnode, Dev.to, Medium, etc.)\n\u251c\u2500\u2500 community/ # Community platforms (forums, niche sites)\n```\n\n**Module guidelines:**\n- Each module must define a `validate_<site>()` function that takes a `username` and returns:\n - `1` \u2192 Available \n - `0` \u2192 Taken \n - `2` \u2192 Error / Could not check\n- Use `httpx` for requests, `colorama` for colored output.\n- Optional: modules can define a CLI parser if they support custom arguments.\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for examples.\n\n---\n\n## Dependencies\n- [httpx](https://pypi.org/project/httpx/)\n- [colorama](https://pypi.org/project/colorama/)\n\n---\n\n## License\n\nThis project is licensed under the **MIT License**. See [LICENSE](LICENSE) for details.\n\n## \u26a0\ufe0f `community/` is small looking for contributions\n",
"bugtrack_url": null,
"license": null,
"summary": "Check username availability across multiple popular platforms",
"version": "1.0.0.5",
"project_urls": {
"Homepage": "https://github.com/kaifcodec/user-scanner"
},
"split_keywords": [
"username",
" checker",
" availability",
" social",
" tech",
" python",
" user-scanner"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "70ea0df023662c444fb88c1da6232d654f488a1de32e64795b5eca12bc20fa61",
"md5": "dd655e931e53cee2324ccc00ee226964",
"sha256": "67cc3b904801abd3c609eb5764f545eff50898a7465964e6fbc509fb5cfa4198"
},
"downloads": -1,
"filename": "user_scanner-1.0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dd655e931e53cee2324ccc00ee226964",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 21606,
"upload_time": "2025-10-23T08:47:27",
"upload_time_iso_8601": "2025-10-23T08:47:27.865193Z",
"url": "https://files.pythonhosted.org/packages/70/ea/0df023662c444fb88c1da6232d654f488a1de32e64795b5eca12bc20fa61/user_scanner-1.0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fa266baa2ea3c06e13a0f4dc8845c0cba6730de9829a0c526a5c96c078ab9157",
"md5": "8240853bcaf02baad280687af0887c04",
"sha256": "b7005524b79a04131120cb54bfc13df24c26d0507e308ccb768fe1d302468d22"
},
"downloads": -1,
"filename": "user_scanner-1.0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "8240853bcaf02baad280687af0887c04",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8717,
"upload_time": "2025-10-23T08:47:30",
"upload_time_iso_8601": "2025-10-23T08:47:30.080939Z",
"url": "https://files.pythonhosted.org/packages/fa/26/6baa2ea3c06e13a0f4dc8845c0cba6730de9829a0c526a5c96c078ab9157/user_scanner-1.0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-23 08:47:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kaifcodec",
"github_project": "user-scanner",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "httpx",
"specs": []
},
{
"name": "colorama",
"specs": []
}
],
"lcname": "user-scanner"
}
JSON
