Skip to main content

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

Project description

Confar

GitHub Workflow Status (with event) License Python Version

"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

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:

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

    or

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

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

    or

    Alternatively, you can use pip to install:

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

    confar --version
    

Usage

CLI

confar <command> [options]

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

Library

import confar

# library usage

For detailed library documentation and examples, refer to the Library documentation.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

confar-1.1.5.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

confar-1.1.5-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file confar-1.1.5.tar.gz.

File metadata

  • Download URL: confar-1.1.5.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for confar-1.1.5.tar.gz
Algorithm Hash digest
SHA256 1e875f575b2133a87d3c6eb7cb3feff3af34ef5cc78bf4b5904f7d9457e87f6d
MD5 d9e8aff45f2c57a4d336615aa6a7b673
BLAKE2b-256 78f61162b548dca5fdad06c5403b6d3d560f0832abec1c05f4499cc2f561603c

See more details on using hashes here.

File details

Details for the file confar-1.1.5-py3-none-any.whl.

File metadata

  • Download URL: confar-1.1.5-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for confar-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 dea6eb049aa9f979339213049a628bd32f3371e3e431fbad92bdee660a1635a9
MD5 6a8d42974d3d23895c0e46edcd069c67
BLAKE2b-256 a5bfdd51771ec559bc1d374814237b3c54ca02e203b7807882ee51f6460eafc9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page