atikin-click


Nameatikin-click JSON
Version 0.0.1 PyPI version JSON
download
home_pageNone
SummaryAtikin-Click — lightweight developer-friendly CLI toolkit (autocomplete, colored output, progress & spinners).
upload_time2025-09-02 20:35:48
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT
keywords cli atikin-verse atikin verse atikin-tools command-line command-line-tool developer productivity automation tools utilities shell terminal progress spinner progress-bar interactive script plugin plugins autocomplete bash zsh fish python-cli python-toolkit rich output color colored developer-tool lightweight
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Atikin-Click

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

Developed by: **Atikin Verse**

[![PyPI version](https://img.shields.io/pypi/v/atikin-click)](https://pypi.org/project/atikin-click/)
[![Python Version](https://img.shields.io/pypi/pyversions/atikin-click)](https://pypi.org/project/atikin-click/)
[![License](https://img.shields.io/pypi/l/atikin-click)](https://github.com/atikinverse/atikin-click/blob/main/LICENSE)
[![Tests](https://github.com/atikinverse/atikin-click/actions/workflows/test.yml/badge.svg)](https://github.com/atikinverse/atikin-click/actions)

---

## 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

```bash
python -m atikin_click version
````

### Plugin Example

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

---

## Installation

Install via PyPI:

```bash
pip install atikin-click
```

For development:

```bash
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

```bash
# 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

```python
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:

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

2. Install development dependencies:

```bash
pip install -e .[dev]
```

3. Run tests:

```bash
pytest -q --tb=short
```

---

## Publishing to PyPI

1. Build the package:

```bash
python -m pip install --upgrade build
python -m build
```

2. Upload to PyPI:

```bash
pip install --upgrade twine
twine upload dist/*
```

3. Test installation:

```bash
pip install atikin-click
python -m atikin_click version
```

> Tip: Use [TestPyPI](https://test.pypi.org/) first for trial uploads:

```bash
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](https://github.com/atikinverse/atikin-click/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](https://atikinverse.com)

---

## 🌐 Follow Us

| Platform  | Username    |
| --------- | ----------- |
| Facebook  | atikinverse |
| Instagram | atikinverse |
| LinkedIn  | atikinverse |
| Twitter/X | atikinverse |
| Threads   | atikinverse |
| Pinterest | atikinverse |
| Quora     | atikinverse |
| Reddit    | atikinverse |
| Tumblr    | atikinverse |
| Snapchat  | atikinverse |
| Skype     | atikinverse |
| GitHub    | atikinverse |

---

<div align="center">  
Made with ❤️ by the **Atikin Verse** 🚀  
</div>
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "atikin-click",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "cli, Atikin-Verse, Atikin, Verse, Atikin-Tools, command-line, command-line-tool, developer, productivity, automation, tools, utilities, shell, terminal, progress, spinner, progress-bar, interactive, script, plugin, plugins, autocomplete, bash, zsh, fish, python-cli, python-toolkit, rich, output, color, colored, developer-tool, lightweight",
    "author": null,
    "author_email": "Atikin Verse <atikinverse@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/ae/0e/9e580117a9d31d35cca7515ecbb67d706a8aedcf9ec52dbb030022ca1e0f/atikin_click-0.0.1.tar.gz",
    "platform": null,
    "description": "# Atikin-Click\r\n\r\n**Atikin-Click** \u2014 lightweight, developer-friendly CLI toolkit with autocomplete, colored output, progress bars & spinners.  \r\n\r\nDeveloped by: **Atikin Verse**\r\n\r\n[![PyPI version](https://img.shields.io/pypi/v/atikin-click)](https://pypi.org/project/atikin-click/)\r\n[![Python Version](https://img.shields.io/pypi/pyversions/atikin-click)](https://pypi.org/project/atikin-click/)\r\n[![License](https://img.shields.io/pypi/l/atikin-click)](https://github.com/atikinverse/atikin-click/blob/main/LICENSE)\r\n[![Tests](https://github.com/atikinverse/atikin-click/actions/workflows/test.yml/badge.svg)](https://github.com/atikinverse/atikin-click/actions)\r\n\r\n---\r\n\r\n## Features\r\n\r\n- Simple, lightweight CLI framework  \r\n- Built-in colored output & rich integration  \r\n- Progress bars & spinners  \r\n- Autocomplete support for Bash/Zsh/Fish  \r\n- Plugin system for custom commands  \r\n\r\n---\r\n\r\n## Quick Start\r\n\r\n### CLI One-Liner\r\n\r\n```bash\r\npython -m atikin_click version\r\n````\r\n\r\n### Plugin Example\r\n\r\n```bash\r\npython -m atikin_click plugin add my_plugin\r\npython -m atikin_click plugin run my_plugin\r\n```\r\n\r\n---\r\n\r\n## Installation\r\n\r\nInstall via PyPI:\r\n\r\n```bash\r\npip install atikin-click\r\n```\r\n\r\nFor development:\r\n\r\n```bash\r\ngit clone https://github.com/atikinverse/atikin-click.git\r\ncd atikin-click\r\npip install -e .\r\n```\r\n\r\n### Requirements\r\n\r\n* Python 3.8+\r\n* Optional: `rich` for enhanced output\r\n\r\n---\r\n\r\n## Usage\r\n\r\n### CLI Commands\r\n\r\n```bash\r\n# Check version\r\npython -m atikin_click version\r\n\r\n# Plugin commands\r\npython -m atikin_click plugin list\r\npython -m atikin_click plugin add my_plugin\r\npython -m atikin_click plugin run my_plugin\r\n\r\n# Shell completion\r\npython -m atikin_click completion bash\r\n```\r\n\r\n### Python API\r\n\r\n```python\r\nfrom atikin_click.cli import default_cli\r\n\r\n@default_cli.command(\"hello\", help=\"Say hello\")\r\ndef hello(name: str):\r\n    print(f\"Hello {name}\")\r\n\r\n# Run programmatically\r\ndefault_cli.run([\"hello\", \"Atikin\"])\r\n```\r\n\r\n---\r\n\r\n## Development\r\n\r\n1. Create a virtual environment:\r\n\r\n```bash\r\npython -m venv .venv\r\n# Windows\r\n.venv\\Scripts\\activate\r\n# Linux/Mac\r\nsource .venv/bin/activate\r\n```\r\n\r\n2. Install development dependencies:\r\n\r\n```bash\r\npip install -e .[dev]\r\n```\r\n\r\n3. Run tests:\r\n\r\n```bash\r\npytest -q --tb=short\r\n```\r\n\r\n---\r\n\r\n## Publishing to PyPI\r\n\r\n1. Build the package:\r\n\r\n```bash\r\npython -m pip install --upgrade build\r\npython -m build\r\n```\r\n\r\n2. Upload to PyPI:\r\n\r\n```bash\r\npip install --upgrade twine\r\ntwine upload dist/*\r\n```\r\n\r\n3. Test installation:\r\n\r\n```bash\r\npip install atikin-click\r\npython -m atikin_click version\r\n```\r\n\r\n> Tip: Use [TestPyPI](https://test.pypi.org/) first for trial uploads:\r\n\r\n```bash\r\ntwine upload --repository testpypi dist/*\r\n```\r\n\r\n---\r\n\r\n## Contributing\r\n\r\n* Fork the repository\r\n* Create a branch for your feature/fix\r\n* Run tests locally\r\n* Submit a pull request\r\n\r\nReport issues on [GitHub Issues](https://github.com/atikinverse/atikin-click/issues).\r\n\r\n---\r\n\r\n## FAQ / Troubleshooting\r\n\r\n**Q:** `ImportError: cannot import name 'default_cli'`\r\n**A:** Ensure you are not running from inside `src/`. Use the installed package or root folder.\r\n\r\n**Q:** Plugin commands not showing output\r\n**A:** Make sure plugin functions print or return values, CLI just triggers them.\r\n\r\n---\r\n\r\n## License\r\n\r\nMIT License \u00a9 Atikin Verse\r\n\r\n---\r\n\r\n## \ud83d\udd17 Author\r\n\r\n**Atikin Verse**\r\nFor more tools & libraries: [https://atikinverse.com](https://atikinverse.com)\r\n\r\n---\r\n\r\n## \ud83c\udf10 Follow Us\r\n\r\n| Platform  | Username    |\r\n| --------- | ----------- |\r\n| Facebook  | atikinverse |\r\n| Instagram | atikinverse |\r\n| LinkedIn  | atikinverse |\r\n| Twitter/X | atikinverse |\r\n| Threads   | atikinverse |\r\n| Pinterest | atikinverse |\r\n| Quora     | atikinverse |\r\n| Reddit    | atikinverse |\r\n| Tumblr    | atikinverse |\r\n| Snapchat  | atikinverse |\r\n| Skype     | atikinverse |\r\n| GitHub    | atikinverse |\r\n\r\n---\r\n\r\n<div align=\"center\">  \r\nMade with \u2764\ufe0f by the **Atikin Verse** \ud83d\ude80  \r\n</div>\r\n```\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Atikin-Click \u2014 lightweight developer-friendly CLI toolkit (autocomplete, colored output, progress & spinners).",
    "version": "0.0.1",
    "project_urls": null,
    "split_keywords": [
        "cli",
        " atikin-verse",
        " atikin",
        " verse",
        " atikin-tools",
        " command-line",
        " command-line-tool",
        " developer",
        " productivity",
        " automation",
        " tools",
        " utilities",
        " shell",
        " terminal",
        " progress",
        " spinner",
        " progress-bar",
        " interactive",
        " script",
        " plugin",
        " plugins",
        " autocomplete",
        " bash",
        " zsh",
        " fish",
        " python-cli",
        " python-toolkit",
        " rich",
        " output",
        " color",
        " colored",
        " developer-tool",
        " lightweight"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "46205e27cfad5f9b1bdf7c40838ef5ce068524ee8a876ad657165ae2a2e5de76",
                "md5": "f1325a9333153b94834178525073db80",
                "sha256": "df446541a316186f58667ea6304a02cc586555627645f50a51e50d0cd43afe2e"
            },
            "downloads": -1,
            "filename": "atikin_click-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f1325a9333153b94834178525073db80",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 16118,
            "upload_time": "2025-09-02T20:35:46",
            "upload_time_iso_8601": "2025-09-02T20:35:46.543614Z",
            "url": "https://files.pythonhosted.org/packages/46/20/5e27cfad5f9b1bdf7c40838ef5ce068524ee8a876ad657165ae2a2e5de76/atikin_click-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ae0e9e580117a9d31d35cca7515ecbb67d706a8aedcf9ec52dbb030022ca1e0f",
                "md5": "451e7122384b9912c13c745aab03a3a6",
                "sha256": "6317c13cd1ce557e1fc57ffd479922d7053a74872fd3e16cd0ab7c260c1e6ddd"
            },
            "downloads": -1,
            "filename": "atikin_click-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "451e7122384b9912c13c745aab03a3a6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 14916,
            "upload_time": "2025-09-02T20:35:48",
            "upload_time_iso_8601": "2025-09-02T20:35:48.130713Z",
            "url": "https://files.pythonhosted.org/packages/ae/0e/9e580117a9d31d35cca7515ecbb67d706a8aedcf9ec52dbb030022ca1e0f/atikin_click-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-02 20:35:48",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "atikin-click"
}
        
Elapsed time: 1.73755s