https://github.com/01joseph-hwang10/catc

Configuration driven file concatenation tool.
https://github.com/01joseph-hwang10/catc

cli concatenate configuration files tool

Last synced: 9 months ago
JSON representation

Configuration driven file concatenation tool.

• Host: GitHub
• URL: https://github.com/01joseph-hwang10/catc
• Owner: 01Joseph-Hwang10
• License: mit
• Created: 2024-05-10T16:01:56.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-05-10T16:14:48.000Z (about 2 years ago)
• Last Synced: 2025-09-27T10:05:22.955Z (9 months ago)
• Topics: cli, concatenate, configuration, files, tool
• Language: Python
• Homepage: https://pypi.org/project/catc/
• Size: 33.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

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

```

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