Metadata-Version: 2.1
Name: catc
Version: 0.1.1
Summary: Configuration driven file concatenation tool.
License: MIT
Author: 01Joseph-Hwang10
Author-email: joseph95501@gmail.com
Requires-Python: >=3.8.1,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: colorama (>=0.4.6,<0.5.0)
Requires-Dist: pydantic (>=2.7.1,<3.0.0)
Description-Content-Type: text/markdown

# `catc`: Configuration driven file concatenation tool

[![PyPI version](https://badge.fury.io/py/catc.svg)](https://pypi.org/project/catc)
[![Testsuite](https://github.com/01Joseph-Hwang10/catc/workflows/Test%20and%20Lint/badge.svg)](https://github.com/01Joseph-Hwang10/catc/actions?query=workflow%3A"Test+and+Lint")
[![Python version](https://img.shields.io/pypi/pyversions/catc.svg)](https://pypi.org/project/catc)
[![Project Status](https://img.shields.io/pypi/status/catc.svg)](https://pypi.org/project/catc/)
[![Supported Interpreters](https://img.shields.io/pypi/implementation/catc.svg)](https://pypi.org/project/catc/)
[![License](https://img.shields.io/pypi/l/catc.svg)](https://github.com/pawelzny/catc/blob/master/LICENSE)


`catc` (conCATenate by Configuration) is a file concatenation tool that allows you to concatenate files based on a configuration file.

## Quick Start

First, install `catc`:

```bash
pip install catc
```

Then, create a `catc.json` file in the root of your project,
and specify the files you want to concatenate:

```json
{
  "files": [
    "src/file.txt",
    "src/lib/**/*.txt"
  ],
  "output": "dist/merged.txt",
  "separator": "\n"
}
```

Finally, run `catc` to concatenate the files:

```bash
catc <directory/to/catc.json>
```

## API Documentation

> TODO: description

## Contributing

Any contribution is welcome! Check out [CONTRIBUTING.md](https://github.com/01Joseph-Hwang10/catc/blob/master/.github/CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](https://github.com/01Joseph-Hwang10/catc/blob/master/.github/CODE_OF_CONDUCT.md) for more information on how to get started.

## License

`catc` is licensed under a [MIT License](https://github.com/01Joseph-Hwang10/catc/blob/master/LICENSE).
