https://github.com/sermetpekin/nameisok

nameisok is a Python package that checks the availability of package names on PyPI. This tool is especially useful for developers looking to publish new packages and wanting to ensure their desired name is unique.
https://github.com/sermetpekin/nameisok

availability available-on-pypi naming pypi pypi-package utility utils

Last synced: 5 months ago
JSON representation

nameisok is a Python package that checks the availability of package names on PyPI. This tool is especially useful for developers looking to publish new packages and wanting to ensure their desired name is unique.

• Host: GitHub
• URL: https://github.com/sermetpekin/nameisok
• Owner: SermetPekin
• License: mit
• Created: 2024-11-08T08:25:05.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-22T10:38:00.000Z (12 months ago)
• Last Synced: 2025-09-01T08:31:23.622Z (5 months ago)
• Topics: availability, available-on-pypi, naming, pypi, pypi-package, utility, utils
• Language: Python
• Homepage: https://nameisok.readthedocs.io/en/latest/home.html
• Size: 9.3 MB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Python Package](https://github.com/SermetPekin/nameisok/actions/workflows/python-package.yml/badge.svg?2)](https://github.com/SermetPekin/nameisok/actions/workflows/python-package.yml)

[![PyPI](https://img.shields.io/pypi/v/nameisok)](https://img.shields.io/pypi/v/nameisok) 

![t](https://img.shields.io/badge/status-maintained-yellow.svg) [![](https://img.shields.io/github/license/SermetPekin/nameisok.svg)](https://github.com/SermetPekin/nameisok/blob/master/LICENSE.md) ![](https://img.shields.io/badge/python-3.10+-blue.svg)

[![Downloads](https://static.pepy.tech/badge/evdschat)](https://pepy.tech/project/evdschat) [![Downloads](https://static.pepy.tech/badge/nameisok/month)](https://pepy.tech/project/nameisok) [![Downloads](https://pepy.tech/badge/nameisok/week)](https://pepy.tech/project/nameisok)

 

nameisok is a Python package that helps developers check the availability of package names on PyPI, taking it one step further with enhanced functionality. This tool is perfect for anyone looking to publish new packages and wanting to avoid name conflicts or similar names that could cause confusion.

### Key Features

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

- BigQuery Database Check: Uses the PyPI dataset on Google BigQuery for additional verification of package name availability.

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

### Installation

To install nameisok, simply run:

```bash

pip install nameisok

```

### Usage

Check Multiple Names

```bash

nameisok example,my_package,nameisok

```

Output 

```plaintext

❌ `example` is already taken.

🎉 Wow! `my_package` is available!

❌ `nameisok` is already taken.

```

### Check a Single Name

You can also check just one name at a time:

```bash

nameisok pandas 

```

```plaintext

  ❌ `pandas` is already taken.

```

```bash

nameisok darling 

```

```plaintext

. 🎉 Wow! `darling` is available!

```

### Similarity Warnings

When a name is not only taken but also too similar to existing packages, you'll see a warning:

```bash

nameisok numpyyy

```

```plaintext

⚠️ `numpyyy` is very similar to `numpy`, `numpy-extensions`

❌ `numpyyy` is too similar to an existing package.

```