[![Python Package](https://github.com/SermetPekin/nameisok/actions/workflows/python-package.yml/badge.svg?1)](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) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/nameisok)](https://pypi.org/project/nameisok/) ![PyPI Downloads](https://static.pepy.tech/badge/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
```
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.
```
Raw data
{
"_id": null,
"home_page": null,
"name": "nameisok",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "pypi, package availability, name checker, available, utility",
"author": null,
"author_email": "Sermet Pekin <Sermet.Pekin@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/66/28/840bf3bdeae9bee9cb7be3b9b02a0a252c8aaf11b47e80855e4f9a3662af/nameisok-0.1.7.tar.gz",
"platform": null,
"description": "[![Python Package](https://github.com/SermetPekin/nameisok/actions/workflows/python-package.yml/badge.svg?1)](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) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/nameisok)](https://pypi.org/project/nameisok/) ![PyPI Downloads](https://static.pepy.tech/badge/nameisok)\n\nnameisok 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.\nKey Features\n\n- PyPI Availability Check: Quickly checks PyPI to see if a package name is available for registration.\n- BigQuery Database Check: Uses the PyPI dataset on Google BigQuery for additional verification of package name availability.\n- Similarity Check: Detects names that are too similar to existing packages, based on a customizable similarity threshold, preventing potential naming conflicts.\n\nInstallation\n\nTo install nameisok, simply run:\n\n\n```bash\npip install nameisok\n```\n\nCheck Multiple Names\n```bash\nnameisok example,my_package,nameisok\n\n\n```\nOutput \n\n```plaintext\n\u274c `example` is already taken.\n\ud83c\udf89 Wow! `my_package` is available!\n\u274c `nameisok` is already taken.\n\n```\n\n### Check a Single Name\n\nYou can also check just one name at a time:\n\n```bash\nnameisok pandas \n```\n\n```plaintext\n \u274c `pandas` is already taken.\n\n```\n\n```bash\nnameisok darling \n```\n```plaintext\n. \ud83c\udf89 Wow! `darling` is available!\n```\n\n### Similarity Warnings\n\nWhen a name is not only taken but also too similar to existing packages, you'll see a warning:\n\n```bash\nnameisok numpyyy\n```\n\n\n```plaintext\n\u26a0\ufe0f `numpyyy` is very similar to `numpy`, `numpy-extensions`\n\u274c `numpyyy` is too similar to an existing package.\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A utility package for checking if a package name is available on PyPI.",
"version": "0.1.7",
"project_urls": {
"documentation": "https://github.com/SermetPekin/nameisok#readme",
"issue_tracker": "https://github.com/SermetPekin/nameisok/issues",
"repository": "https://github.com/SermetPekin/nameisok"
},
"split_keywords": [
"pypi",
" package availability",
" name checker",
" available",
" utility"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0c25a1a0839c99f295e5d871a2da9224a6bdc724cca4fdf8da7da74dc8181cd2",
"md5": "4fdc142cb9aa838010b8de255357af7d",
"sha256": "361b1d0929fa48742641d36f0a3fcfda9a52fe2aef1d15fcb836caaffbd00221"
},
"downloads": -1,
"filename": "nameisok-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4fdc142cb9aa838010b8de255357af7d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6044,
"upload_time": "2024-11-09T21:00:24",
"upload_time_iso_8601": "2024-11-09T21:00:24.059525Z",
"url": "https://files.pythonhosted.org/packages/0c/25/a1a0839c99f295e5d871a2da9224a6bdc724cca4fdf8da7da74dc8181cd2/nameisok-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6628840bf3bdeae9bee9cb7be3b9b02a0a252c8aaf11b47e80855e4f9a3662af",
"md5": "53bb88428972b796360d1c1e3a49853e",
"sha256": "360ac74dcdd5e336169274f7bc7323322ae24ad58a0890c5b15538840dbe4814"
},
"downloads": -1,
"filename": "nameisok-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "53bb88428972b796360d1c1e3a49853e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 5189,
"upload_time": "2024-11-09T21:00:25",
"upload_time_iso_8601": "2024-11-09T21:00:25.644265Z",
"url": "https://files.pythonhosted.org/packages/66/28/840bf3bdeae9bee9cb7be3b9b02a0a252c8aaf11b47e80855e4f9a3662af/nameisok-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-09 21:00:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SermetPekin",
"github_project": "nameisok#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "nameisok"
}