Metadata-Version: 2.4
Name: colorak
Version: 1.0.0
Summary: A cross-platform terminal color utility inspired by the Windows CMD color command.
Author: Anuruddha Kumar
License-Expression: MIT
Project-URL: Homepage, https://github.com/anurudhhakumar30-source/colorak
Project-URL: Repository, https://github.com/anurudhhakumar30-source/colorak
Project-URL: Issues, https://github.com/anurudhhakumar30-source/colorak/issues
Keywords: terminal,color,console,cli,ansi,windows,cmd,git-bash,powershell
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Utilities
Classifier: Topic :: Terminals
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# 🎨 colorak

> A cross-platform terminal color utility inspired by the Windows **`color`** command.

`colorak` is a lightweight Python command-line tool that provides predefined terminal color presets using ANSI escape codes. It is designed to work across multiple terminal environments while offering a simple and familiar interface.

---

## ✨ Features

* 🎨 26 predefined color presets (`a` → `z`)
* 🖥️ Cross-platform support

  * Windows Terminal
  * PowerShell
  * Git Bash
  * Linux Terminal
  * macOS Terminal
  * Termux
* 📋 List all available presets
* 📦 Easy installation with `pip`
* 🧪 Unit tested
* 🏗️ Clean and modular project structure
* ⚡ No external runtime dependencies

---

## 📦 Installation

Clone the repository:

```bash
git clone https://github.com/anurudhhakumar30-source/colorak.git
cd colorak
```

Install in editable mode:

```bash
python -m pip install -e .
```

---

## 🚀 Usage

### Show Help

```bash
colorak help
```

or

```bash
colorak --help
```

---

### Show Version

```bash
colorak version
```

or

```bash
colorak --version
```

---

### Show All Presets

```bash
colorak list
```

---

### Use a Color Preset

```bash
colorak a
```

```bash
colorak b
```

```bash
colorak c
```

...

```bash
colorak z
```

---

### Reset Terminal Colors

```bash
colorak reset
```

---

## 📂 Project Structure

```text
colorak/
│
├── colorak/
│   ├── __init__.py
│   ├── cli.py
│   ├── colors.py
│   ├── utils.py
│   └── version.py
│
├── tests/
│   └── test_cli.py
│
├── README.md
├── LICENSE
├── pyproject.toml
└── .gitignore
```

---

## 🧪 Running Tests

Run all unit tests:

```bash
python -m unittest discover -s tests
```

---

## 🛠️ Technologies Used

* Python 3
* argparse
* dataclasses
* unittest
* setuptools

---

## 📖 Version

Current development version:

```text
0.1.0
```

The first stable public release will be:

```text
1.0.0
```

---

## 🗺️ Roadmap

### Version 1.0

* [x] Project structure
* [x] Modular architecture
* [x] 26 predefined color presets
* [x] Help command
* [x] Version command
* [x] List command
* [x] Reset command
* [x] Unit tests
* [x] Cross-platform ANSI support

### Future Versions

Possible future enhancements include:

* RGB color support
* HEX color support
* Custom user themes
* Configuration file support
* Additional preset collections

---

## 🤝 Contributing

Contributions, bug reports, and suggestions are welcome.

If you'd like to contribute:

1. Fork the repository.
2. Create a feature branch.
3. Make your changes.
4. Submit a Pull Request.

---

## 📄 License

This project is licensed under the MIT License.

See the `LICENSE` file for details.

---

## 👨‍💻 Author

**Anuruddha Kumar**

GitHub: https://github.com/anurudhhakumar30-source

---

## ⭐ Support

If you find this project useful:

* ⭐ Star the repository
* 🐞 Report bugs
* 💡 Suggest new ideas
* 🤝 Contribute improvements

Your support helps the project grow.
