Skip to main content

Safe, typo-aware package installer for Python.

Project description

pkg-guard

PyPI version License: MIT

pkg-guard is a smart, typo-aware CLI wrapper for pip install — designed to prevent installing the wrong packages (e.g., reqeusts instead of requests).

It checks PyPI before installing, offers fuzzy suggestions, and lets you interactively choose the correct package with arrow keys — just like vite or npm init.


Features

✅ Detects misspelled packages before install
✅ Fuzzy matching & intelligent suggestions (powered by RapidFuzz)
✅ Interactive selection with arrow keys (InquirerPy)
✅ Spinner feedback using Rich
✅ Caching for faster lookups
✅ Extensible architecture (future support for npm, cargo, etc.)


Installation

From PyPI (after release)

pip install pkg-guard

From source (for developers)

git clone https://github.com/Prasad2357/pkg-guard
cd pkg-guard
pip install -e .

Usage

pkg-guard install reqeusts

Example

pkg-guard  checking PyPI for package: reqeusts ...
✖ Not found on PyPI: reqeusts

? Select package to install instead of 'reqeusts':
   requests
    request
    regex
    flask
    Other (type manually)
    Skip
  • Arrow keys to navigate
  • Press Enter to confirm
  • Type manually if your package isn’t listed

How it Works

  • Checks if the given package exists on PyPI

  • If not found, loads a local list of popular packages

  • Uses fuzzy matching (WRatio) to find closest matches

  • Presents them interactively via InquirerPy

  • Safely installs the chosen package with pip

Project Structure

pkg_guard/
├── __main__.py          # Entry point for `python -m pkg_guard
├── cli.py               # CLI definitions (Typer app)
│
├── core/
│   ├── installer.py     # Main install workflow   └── pypi_utils.py    # PyPI querying, caching, suggestions
│
└── ui/
    ├── console.py       # Rich-based spinner & console
    └── prompts.py       # Interactive fuzzy selection

Tech Stack

Component Library/Framework
CLI Framework Typer
Interactive Prompts InquirerPy
Fuzzy Matching RapidFuzz
Console UI Rich
HTTP Requests Requests

Development

Run in dev mode:

python -m pkg_guard install flask

Run linting (optional):

pip install black
black pkg_guard

Contributing

Contributions are welcome!
Feel free to fork this repo, open issues, or submit PRs.

License

This project is licensed under the terms of the MIT License — see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pkg_guard-0.1.5.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pkg_guard-0.1.5-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file pkg_guard-0.1.5.tar.gz.

File metadata

  • Download URL: pkg_guard-0.1.5.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.4

File hashes

Hashes for pkg_guard-0.1.5.tar.gz
Algorithm Hash digest
SHA256 418921ccfc55db2f29cb84e834168bafa0424dcdfe711185cbad052b7388bf4a
MD5 024ee81197bb9bb4c68d80a4a62300fd
BLAKE2b-256 9ad355fb846a4470ecf0897cb3d945d3dc07b63837493f16dc27dd1c2550fd20

See more details on using hashes here.

File details

Details for the file pkg_guard-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: pkg_guard-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 11.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.4

File hashes

Hashes for pkg_guard-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 76421992dbcfeb6f4baec4258cd9b91268acdebf3bf00c68cc3e10e31ca31a27
MD5 a1f2bd1083d78152fea4f7c33a9728db
BLAKE2b-256 1518ae668d6cea947b1be46d73ce60e8b23758aca6e58e66a6e400873eb302a5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page