Atikin-Click

Atikin-Click — lightweight, developer-friendly CLI toolkit with autocomplete, colored output, progress bars & spinners.

Developed by: Atikin Verse

Features

• Simple, lightweight CLI framework
• Built-in colored output & rich integration
• Progress bars & spinners
• Autocomplete support for Bash/Zsh/Fish
• Plugin system for custom commands

Quick Start

CLI One-Liner

python -m atikin_click version

Plugin Example

python -m atikin_click plugin add my_plugin
python -m atikin_click plugin run my_plugin

Installation

Install via PyPI:

pip install atikin-click

For development:

git clone https://github.com/atikinverse/atikin-click.git
cd atikin-click
pip install -e .

Requirements

• Python 3.8+
• Optional: rich for enhanced output

Usage

CLI Commands

# Check version
python -m atikin_click version

# Plugin commands
python -m atikin_click plugin list
python -m atikin_click plugin add my_plugin
python -m atikin_click plugin run my_plugin

# Shell completion
python -m atikin_click completion bash

Python API

from atikin_click.cli import default_cli

@default_cli.command("hello", help="Say hello")
def hello(name: str):
    print(f"Hello {name}")

# Run programmatically
default_cli.run(["hello", "Atikin"])

Development

1. Create a virtual environment:

python -m venv .venv
# Windows
.venv\Scripts\activate
# Linux/Mac
source .venv/bin/activate

2. Install development dependencies:

pip install -e .[dev]

3. Run tests:

pytest -q --tb=short

Publishing to PyPI

1. Build the package:

python -m pip install --upgrade build
python -m build

2. Upload to PyPI:

pip install --upgrade twine
twine upload dist/*

3. Test installation:

pip install atikin-click
python -m atikin_click version

Tip: Use TestPyPI first for trial uploads:

twine upload --repository testpypi dist/*

Contributing

• Fork the repository
• Create a branch for your feature/fix
• Run tests locally
• Submit a pull request

Report issues on GitHub Issues.

FAQ / Troubleshooting

Q: ImportError: cannot import name 'default_cli' A: Ensure you are not running from inside src/. Use the installed package or root folder.

Q: Plugin commands not showing output A: Make sure plugin functions print or return values, CLI just triggers them.

License

MIT License © Atikin Verse

🔗 Author

Atikin Verse For more tools & libraries: https://atikinverse.com

🌐 Follow Us