Skip to content

README.md

Latest commit

 

History

History
121 lines (80 loc) · 1.95 KB

README.md

File metadata and controls

121 lines (80 loc) · 1.95 KB

Username Availability Checker

Check if a username is available across multiple platforms from the terminal.

Preview

Preview

Requirements

  • Python 3.8+

Installation

Windows

  1. Install Python (check "Add to PATH" during installation)

  2. Install required libraries:

    pip install -r requirements.txt

Mac

  1. Install Python:

    brew install python3

  2. Install required libraries:

    pip3 install -r requirements.txt

Running the App

Windows

Double-click run.bat or run:

python cli.py

Mac

Double-click run.sh or run:

python3 cli.py

You will be prompted in the terminal. Type a username and press Enter. Type q to quit.

Supported Platforms

  • GitHub
  • Reddit
  • GitLab
  • Bitbucket
  • Dev.to
  • CodePen
  • Dribbble
  • Behance
  • X (Twitter) - manual check needed
  • TikTok - manual check needed

Adding a New Platform

Edit platforms.py and add a new line:

{"name": "Instagram", "url": "https://instagram.com/{username}"},

For sites that require JavaScript (can't be checked automatically), add:

{"name": "Snapchat", "url": "https://snapchat.com/add/{username}", "unreliable": True},

Notes

  • Checks are best-effort and lightweight.
  • Some platforms use heavy JavaScript and return unknown.

Contributing

Contributions are welcome and appreciated! Whether it's fixing a typo, adding a feature, or just reporting a bug. All help is valued.

Pull requests are welcome. Please:

  • Keep checks best-effort and lightweight
  • Avoid API keys or heavy scraping
  • Add clear reasons for unknown results

To submit a PR

  1. Fork the repo
  2. Create a branch (git checkout -b my-feature)
  3. Make your changes
  4. Run npm run lint to check for issues
  5. Commit and push
  6. Open a pull request

No contribution is too small. Even fixing a single typo helps.