Skip to content

Commit 589a290

Browse files
committed
2 parents 2d804e0 + 27f60f2 commit 589a290

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
1-
[![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) ![PyPI Downloads](https://static.pepy.tech/badge/nameisok?2)
1+
2+
[![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)
3+
[![PyPI](https://img.shields.io/pypi/v/nameisok)](https://img.shields.io/pypi/v/nameisok) ![PyPI Downloads](https://static.pepy.tech/badge/nameisok?2)![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)](https://www.python.org/downloads/)
4+
25

36
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.
4-
Key Features
7+
8+
### Key Features
59

610
- PyPI Availability Check: Quickly checks PyPI to see if a package name is available for registration.
711
- BigQuery Database Check: Uses the PyPI dataset on Google BigQuery for additional verification of package name availability.
812
- Similarity Check: Detects names that are too similar to existing packages, based on a customizable similarity threshold, preventing potential naming conflicts.
913

10-
Installation
14+
### Installation
1115

1216
To install nameisok, simply run:
1317

14-
1518
```bash
1619
pip install nameisok
1720
```
1821

22+
### Usage
23+
1924
Check Multiple Names
2025
```bash
2126
nameisok example,my_package,nameisok

0 commit comments

Comments
 (0)