Metadata-Version: 2.1
Name: acml
Version: 0.2.1
Summary: 
Home-page: https://github.com/brodycritchlow/ACML
License: MIT
Keywords: configuration,config,advanced,ACML
Author: Brody Critchlow
Author-email: brodycritchlow@gmail.com
Requires-Python: >=3.11,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown

ACML

    Advanced Config Markup Language
    
    Explore the docs » (https://github.com/brodycritchlow/ACML)

    PyPi (https://github.com/othneildrew/Best-README-Template)
    ·
    Report Bug (https://github.com/brodycritchlow/ACML/issues)
    ·
    Request Feature (https://github.com/brodycritchlow/ACML/issues)

Table of Contents

-       About The Project

- Built With

-       Getting Started

- Installation

- Usage
    
- Roadmap
    
- Contributing
    
- License
    
- Contact
    
- Acknowledgments

## About The Project

ACML is a custom markup language designed for creating complex configuration files with nested sections and key-value pairs. It allows users to organize their configuration data into different subsections, making it easy to manage and modify large configuration files.

Here's why:
- With ACML, you can easily define subsections using the [section.subsection] syntax, and populate them with any number of key-value pairs. These key-value pairs can be simple strings, integers, floats, lists, and even JSON-style dictionaries.

Of course, no one configuration format will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue.

### Built With

ACML is purely built off of Python, we chose Python for its flexibility and easy grammar so more people can contribute.

![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)

(back to top)

## Getting Started

We are hosted on [PyPi](https://pypi.org/project/acml/), so you can sit back and relax by using `pip`.

### Installation

_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._

1. Download Python and PIP
2. Open a command prompt
3. Run the following command: 
	- `pip install ACML`  - This may work on most systems
	- `py -m pip install ACML` - Works 100% of the time on Windows 10+
	- `pip3 install ACML` - Linux Distros

(back to top)

## Usage

```py
from ACML import *

config = parse("path/to/config.conf/")
config["key"]["key2"]
```

_For more examples, please refer to the [Documentation](https://github.com/brodycritchlow/ACML)_

(back to top)

## Roadmap

- [x] Add Parser
- [x] Add Read Me
- [x] Add License
- [ ] Add multiple config formats
- [ ] Add more tests

See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues).

(back to top)

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

(back to top)

## License

Distributed under the MIT License. See `LICENSE` for more information.

(back to top)

## Contact

Brody Critchlow - [thornily#6566](https://discord.com/users/612107033608585252)

Project Link: [https://github.com/brodycritchlow/ACML](https://github.com/brodycritchlow/ACML)

(back to top)

## Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

* [Readme Template](https://github.com/othneildrew/Best-README-Template)

(back to top)
