nameisok

https://github.com/SermetPekin/nameisok/actions/workflows/python-package.yml/badge.svg?2 https://img.shields.io/pypi/v/nameisok https://static.pepy.tech/badge/nameisok?2

nameisok is a Python package designed to help developers check the availability of package names on PyPI, with added features to ensure your package name is unique and avoids potential conflicts. This tool is ideal for developers looking to publish new packages with confidence.

Key Features

  • PyPI Availability Check: Quickly checks PyPI to see if a package name is available for registration.

  • BigQuery Database Check: Verifies package name availability using the PyPI dataset on Google BigQuery.

  • Similarity Check: Detects names that are too similar to existing packages, based on a customizable similarity threshold, to prevent naming conflicts.

Installation

To install nameisok, simply run:

pip install nameisok

Usage

Check Multiple Names

You can check the availability of multiple package names at once:

nameisok example,my_package,nameisok

Sample Output

❌ `example` is already taken.
🎉 Wow! `my_package` is available!
❌ `nameisok` is already taken.

Check a Single Name

To check the availability of a single package name:

nameisok pandas

Sample Output

❌ `pandas` is already taken.

For an available name:

nameisok darling
🎉 Wow! `darling` is available!

Similarity Warnings

When a name is taken and similar to existing packages, a warning is displayed:

nameisok numpyyy

Sample Output

⚠️ `numpyyy` is very similar to `numpy`, `numpy-extensions`
❌ `numpyyy` is too similar to an existing package.

License

This project is licensed under the MIT License.