Skip to content

debeski/pypi-checker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

PyPI Name Inspector 🐍

A premium, fast, and feature-rich Python terminal application to verify package name availability and avoid clashing violations (PEP 503/508) on the official Python Package Index (PyPI).


🌟 Key Features

  • PEP 503 Case & Symbol Folding Analysis: PyPI normalizes all packages by converting names to lowercase and folding multiple punctuation runs (., _, -) into a single hyphen. The tool automatically detects if your candidate name clashes with an existing library under these rules.
  • Python Standard Library Conflict Guard: Preemptively checks if your package name conflicts with a standard library module (such as json, sys, pathlib), warning you to avoid imports clashing locally.
  • Concurrent Alternative Suggestion Engine: If a name is already taken, the tool launches a multi-threaded check against 5 standard naming alternatives (e.g. *-py, py-*, *-lib, *-pkg) in parallel.
  • Dual Runtime Modes:
    • Direct Arguments: Check a package name instantly with ./checker.py <name>.
    • Interactive Loop: Run ./checker.py without arguments to launch a persistent interactive checker shell.

🚀 Getting Started

Prerequisites

Make sure you have requests and rich installed in your Python environment:

pip install requests rich

Installation

Clone or navigate to the tool's workspace, and ensure the script is executable:

chmod +x checker.py

📖 Usage Examples

1. Direct Inspection (Single Checks)

Quickly inspect name availability directly:

./checker.py requests

2. Interactive Shell Mode

Check multiple candidates iteratively in a dedicated interactive loop:

./checker.py

3. Check for standard library clashes

./checker.py sys

⚙️ Command Line Arguments

options:
  -h, --help            show this help message and exit
  -s, --skip-suggestions
                        Skip concurrent suggestion checking (makes checks faster).

About

check for package name availability on pypi before pushing.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages