confar 1.1.5
Confar is a Python CLI and library for configuration management, designed to aggregate and manage configuration data and execute tasks based on that configuration.
Requires Python: >=3.9

# Confar

![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/sanjairocky/Confar/pages%2Fpages-build-deployment)
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Python Version](https://img.shields.io/badge/Python-3.8%2B-blue.svg)](https://www.python.org/downloads/)

"Configuration Aggregator and Runner" is an application that consolidates configuration data and executes tasks or processes based on that configuration.

Confar is a Python CLI and library for configuration management, designed to aggregate and manage configuration data and execute tasks based on that configuration.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Installation

You can install `confar` easily using the provided installation script by running it with the `sh` command.

**Note**: Make sure you have a working internet connection before proceeding.

### Installation Steps

1. Open your terminal.

2. Download and run the installation script using `sh`:

   ```bash
   sh -c "$(curl -fsSL https://sanjairocky.github.io/confar/install.sh)"
   ```

   or

   Alternatively, you can use wget to download and execute the script:

   ```bash
   sh -c "$(wget https://sanjairocky.github.io/confar/install.sh -O -)"
   ```

   or

   Alternatively, you can use pip to install:

   ```bash
   pip install confar
   ```

3. To verify that confar is installed successfully, you can run the following command:

   ```bash
   confar --version
   ```

## Usage

### CLI

```bash
confar <command> [options]
```

For detailed CLI documentation and examples, refer to the CLI documentation.

### Library

```python
import confar

# library usage
```

For detailed library documentation and examples, refer to the [Library documentation](https://sanjairocky.github.io/docs/confar).

## Contributing

We welcome contributions from the community. If you'd like to contribute to Confar, please read our Contributing Guidelines and Code of Conduct.

## License

Confar is licensed under the MIT License - see the LICENSE file for details.

MIT License

Copyright (c) 2023 Sanjai Kumar Arumugam

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.