Skip to main content

A CLI tool to check PyPI package name availability

Project description

PyMin

pymin (0.0.0)

A command-line interface tool for checking PyPI package name availability with rich output formatting and validation rules.

Features

Core Features

  1. Package Name Validation

    • Real-time PyPI availability check
    • PEP 503 naming convention validation
    • Standardized name formatting
    • Typosquatting detection
  2. Rich User Interface

    • Color-coded status indicators
    • Interactive progress display
    • Formatted results presentation
    • Visual validation markers
  3. Developer Experience

    • Intuitive command structure
    • Comprehensive error messages
    • Real-time feedback
    • Multiple command aliases

Installation

Quick Start

Install via pipx:

$ pipx install pymin

System Requirements

Component Requirement
Python >=3.8
OS Platform independent

Usage

Command Interface

The CLI provides two command interfaces:

Command Description
pymin Main command
pm Short alias

Basic Usage

โฏ pymin
๐Ÿ” PyPI Package Name Checker

# or using alias
โฏ pm
๐Ÿ” PyPI Package Name Checker

Available Commands

Command Description
check Validate package name availability
search Find similar package names

Command Examples

Check Package Name

$ pymin check my-package-name
โ”Œโ”€ PyPI Package Name Check Results โ”€โ”
โ”‚ Package Name: my-package-name     โ”‚
โ”‚ Normalized Name: my-package-name  โ”‚
โ”‚ Valid Format: โœ“                   โ”‚
โ”‚ Available: โœ“                      โ”‚
โ”‚ Message: Package name available!  โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

Search Similar Names

# Default similarity (80%)
$ pm search fastapi

# Custom similarity threshold
$ pm search fastapi --threshold 0.85

Command Options

Command Option Description Type Default
check name Target package name to validate str -
search name Package name to search for str -
search --threshold Similarity threshold (0.0-1.0) float 0.8

License

This project is licensed under the MIT License.

Project Structure

pymin/
โ”œโ”€โ”€ src/
โ”‚   โ””โ”€โ”€ pypi_toolkit/
โ”‚       โ”œโ”€โ”€ check.py       # Package name validation service with PyPI availability checking and security analysis
โ”‚       โ”œโ”€โ”€ cli.py         # Command-line interface providing PyPI package name validation and search functionality
โ”‚       โ”œโ”€โ”€ packaging.py   # Package version validation service using PEP 440 standards
โ”‚       โ”œโ”€โ”€ search.py      # Package name similarity search service with PyPI integration
โ”‚       โ”œโ”€โ”€ security.py    # Security service for package name typosquatting detection and analysis
โ”‚       โ”œโ”€โ”€ similarity.py  # String similarity analysis service for package name comparison
โ”‚       โ”œโ”€โ”€ utils.py       # Utility functions for package name normalization and string manipulation
โ”‚       โ””โ”€โ”€ validators.py  # Package name validation service implementing PyPI naming conventions
โ”œโ”€โ”€ LICENSE
โ”œโ”€โ”€ pyproject.toml
โ”œโ”€โ”€ readgen.toml
โ””โ”€โ”€ README.md

This document was automatically generated by ReadGen.

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

pymin-0.0.0.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

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

pymin-0.0.0-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file pymin-0.0.0.tar.gz.

File metadata

  • Download URL: pymin-0.0.0.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.0

File hashes

Hashes for pymin-0.0.0.tar.gz
Algorithm Hash digest
SHA256 c4e44756391dc7797c5b856ab86f9ba08365427af02caf6fa0b6f56478fbc501
MD5 13f02de629822f05a0d426118a20bcc0
BLAKE2b-256 9615369c06672475203295efe0b3b8772409e68d702b2aa2106af47e4c2b3e3c

See more details on using hashes here.

File details

Details for the file pymin-0.0.0-py3-none-any.whl.

File metadata

  • Download URL: pymin-0.0.0-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.0

File hashes

Hashes for pymin-0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 355dd616df37b39489f2c928a2700eb01b63dfbfdf4c71ad44216ac55460752e
MD5 a7c0beba2fe04190ad7af676b5563785
BLAKE2b-256 2d0b9120b2e089fa8deda632a6cb6364d0e91be4aa0b002b1e69d9c8fff4e9e7

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