kx-publish-pypi 1.0.1

A friendly CLI tool to check and publish Python packages to TestPyPI/PyPI

🚀 KX-Publish-PyPI

The Professional CLI Tool for Python Package Publishing

⚡ Publish Python packages to PyPI in under 30 seconds! ⚡

Version 1.0.0 | Author: ABUELTAYEF Khader | Python 3.9+

---

🎯 Why Choose KX-Publish-PyPI?

Feature	KX-Publish-PyPI	Traditional Methods
Setup Time	⚡ 30 seconds	⏰ 30+ minutes
Security	🔐 System keyring	📝 Plain text files
User Experience	🎨 Rich CLI + Progress bars	📟 Basic terminal output
Error Handling	🛡️ Smart validation	❌ Manual debugging
Version Management	📈 Intelligent bumping	🔢 Manual editing
Build Backend Support	🛠️ All modern backends	⚙️ Limited support

---

💻 Installation

⚡ Quick Install

pip install kx-publish-pypi

✅ Verify Installation

kx-publish-pypi --version

🎬 Installation Demo

---

💻 Account Setup & Token Generation

🔑 Get Started with PyPI Publishing

1. Create PyPI Account

1. 🌐 Visit pypi.org
2. 📝 Click "Register" in the top right
3. ✉️ Fill out the registration form
4. ✅ Verify your email address

2. Create TestPyPI Account

1. 🌐 Visit test.pypi.org
2. 📝 Click "Register" in the top right
3. ✉️ Fill out the registration form
4. ✅ Verify your email address

3. Generate API Tokens

For PyPI Production:

1. 🔑 Log in to pypi.org
2. ⚙️ Go to Account Settings → API tokens
3. ➕ Click "Add API token"
4. 🏷️ Give it a name (e.g., "kx-publish-pypi")
5. 💾 Copy & Save the token (you won't see it again!)

For TestPyPI:

1. 🔑 Log in to test.pypi.org
2. ⚙️ Go to Account Settings → API tokens
3. ➕ Click "Add API token"
4. 🏷️ Give it a name (e.g., "kx-publish-pypi-test")
5. 💾 Copy & Save the token

4. Store Tokens Securely

Use the CLI to store your tokens securely:

kx-publish-pypi setup-tokens

This will prompt you to enter your TestPyPI and PyPI tokens, which will be stored in your system's keyring.

💡 Pro Tip: You can also store tokens directly during the guided workflow:

kx-publish-pypi run

---

🚀 Quick Start

Choose Your Publishing Journey

🎯 Option 1: Complete Guided Workflow (Recommended)

kx-publish-pypi run

✨ One command handles everything: checks, tokens, version bump, build, and publish

🛠️ Option 2: Individual Commands

# 🔍 Pre-flight check your package
kx-publish-pypi check

# 🔐 Setup API tokens securely
kx-publish-pypi setup-tokens

# 📈 Bump version (patch/minor/major)
kx-publish-pypi bump patch

# 🧪 Publish to TestPyPI first
kx-publish-pypi publish-test

# 🚀 Publish to production PyPI
kx-publish-pypi publish-prod

---

✨ Key Features

🎨 Rich Interface	Rich, colorful output with progress bars
🔍 Smart Pre-checks	Validates package structure and configuration
🔐 Secure Token Storage	Uses system keyring for API tokens
📦 Enhanced Version Detection	Supports all modern Python build backends
🔥 Interactive Workflow	Guided experience from check to publish
📈 Version Management	Intelligent version bumping
🛠️ Build Integration	Works with setuptools, flit, hatchling, etc.

---

🏗️ Supported Build Backends

Backend	Status	Version Detection
setuptools	✅ Full Support	__version__ files
poetry	✅ Full Support	pyproject.toml
flit	✅ Full Support	pyproject.toml
hatchling	✅ Full Support	pyproject.toml
pdm	✅ Full Support	pyproject.toml
scikit-build	✅ Full Support	Custom detection

---

🚀 Programmatic API

from kx_publish_pypi import detect_package_version
from pathlib import Path

# Enhanced version detection
result = detect_package_version(Path("."))
if result.version_info:
    print(f"📦 Version: {result.version_info.version}")
    print(f"🔧 Method: {result.version_info.method}")

---

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

🐛 Found a Bug?

• 🐛 Open an Issue
• 💡 Suggest a Feature

---

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

🌐 Connect with Us

🚀 Powered by KhaderX | 👨‍💻 Founder: ABUELTAYEF Khader

⭐ If you find this tool useful, please star this repo!